# Rentvine API Docs > Reference for the Rentvine Manager API: each supported operation with its parameters, request body and responses. Changes to the API and to this reference are listed by date, newest first, in the [Changelog](https://docs.rentvine.com/#tag/Changelog). Generated from the OpenAPI spec served at https://docs.rentvine.com/openapi.json (version 2026.11.16). Rendered reference: https://docs.rentvine.com/ ## Overview Reference for the Rentvine Manager API: each supported operation with its parameters, request body and responses. Changes to the API and to this reference are listed by date, newest first, in the [Changelog](https://docs.rentvine.com/#tag/Changelog). Base URL: `https://{account}.rentvine.com/api/manager` (`{account}`: Your account subdomain). Authentication: HTTP Basic (`basicAuth`). ### Authentication Requests are made using HTTP Basic Authentication with the access key as the username and secret as the password. ```bash # Use the -u flag with {access key}:{secret} curl https://example.rentvine.com/api/manager/properties \ -u eba2c5e402e1476cb8ce5083a671d528:bd804fe81fd043598600939b9a257b2e ``` #### Obtaining API Keys 1. In your Rentvine dashboard navigate to `Settings` > `Users, Roles and API` > `API` 2. Select `New API Key` 3. Enter a reference name in the `Name` field and select a predefined role in the `Role` dropdown > ℹ️ Roles need to be setup before creating an API key. Create Roles via the `Roles` tab. 4. Copy the generated Access Key and Secret. You will not be able to view the Secret again after closing this form. ### Rate Limits Every request counts against several limits at once. A request that would go over any of them is refused with `429 Too Many Requests` and isn't run. | Limit | What it counts | Allowance | | --- | --- | --- | | Per API key (`api-key`) | Every request made with one API key | 120 requests per 60 seconds. You can send all 120 at once; they come back at 2 per second. | | Per user (`user`) | Every request one user makes | 1,200 requests per minute. Each API key is a user of its own, so for API traffic the per-key limit is reached first. | | Per account (`account`) | Every signed-in request on your Rentvine account: every API key, everyone using the Rentvine app, and residents, owners and applicants in their portals | 10,000 requests per minute | | Per partner app (`client`) | Every request from one registered partner app, on every account it serves: requests that identify the app (`Rentvine-App-*` headers) | 6,000 requests per minute | | Per IP address (`ip`) | Every request from one IP address, counted before sign-in, so it includes requests that fail to sign in and requests another limit refuses | 6,000 requests per minute | | Exports (`endpoint`) | `GET /leases/export`, `GET /properties/export`, `GET /properties/units/export`, `GET /screening/applications/export` and `GET /accounting/positive-pay/export` (undocumented), each separately, per API key | 60 per hour: 10 at once, then one a minute | | Reports (`endpoint`) | Running or sending a report through the report endpoints under `/reports` (not documented here yet), all together, per API key; the manager-ledger reports (`/reports/ledger…`) aren't counted | 20 per hour: 5 at once, then one every 3 minutes | The per-user, per-account, per-partner-app and per-IP limits count in clock minutes: the whole allowance is back at the start of each minute. The per-key, export and report limits refill continuously instead. #### Rate-limit headers Responses carry two headers, as the [IETF rate-limit headers draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/) defines them: each an [RFC 8941](https://www.rfc-editor.org/rfc/rfc8941) list with one item per limit, named as in the table. ```http RateLimit-Policy: "account";q=10000;w=60, "user";q=1200;w=60, "api-key";q=120;w=60 RateLimit: "account";r=9999;t=60, "user";r=1199;t=60, "api-key";r=119;t=1 ``` - `RateLimit-Policy` declares each limit: `q` requests per `w` seconds. For an export or report limit that is its sustained rate, not what you can send at once: an export declares `q=60;w=3600` and allows 10 at once. - `RateLimit` says where you stand after this request: `r` requests that limit allows right now, and `t` seconds until its whole allowance is back. A response to a signed-in request lists the limits counted after sign-in (`account`, `user`, `api-key`, plus `client` and `endpoint` where they apply) and not `ip`, although the per-IP limit counted it too. A few routes this reference doesn't document add items of their own (the AI assistant's). A response answered before sign-in (a 401, a path no route matches) lists only `ip`. Read the numbers from these headers rather than hard-coding the table: they are what the API applies. Rentvine can change how the limits counted after sign-in work for one account, user or API key, without changing their allowances: switch them off (its responses then list only `ip`, like one answered before sign-in), have them count without refusing (a limit it's over stays listed with `r=0`, and the request is still run), or have them refuse as usual while they're relaxed for everyone else. The per-IP limit works the same for every caller. Either way, the headers describe the limits as they apply to that request. #### When you get a 429 The 429 carries `Retry-After`, the seconds to wait before sending the request again, plus the two headers above. Recognise a 429 by its status. A refused request isn't counted against the limit that refused it or any other limit counted after sign-in, but every request is counted against the per-IP limit before anything else, refused ones included, unless the per-IP limit itself refused it. #### Backing off 1. **Watch `RateLimit` on every response.** The item with the lowest `r` is the limit that refuses your next request to that operation first; slow down before it reaches 0 instead of waiting for the 429. Keep an eye on `account` too: everyone on your account draws on it. 2. **On a 429, wait `Retry-After` seconds, then retry the same request.** It wasn't run, so retrying is safe, even for a write. For a per-minute limit `Retry-After` can be longer than the time left in the minute; waiting for it is always enough. 3. **Back off further if 429s keep coming:** double the wait after each one in a row, up to a few minutes, with some random jitter so parallel workers don't retry in step. Go back to your normal pace after the first success. 4. **Spread work out rather than sending it in bursts,** and keep parallel requests on one key few: they all draw on the same 120 a minute. More keys don't add capacity past your account's limit, and requests from one machine share its IP address's limit, which the headers on signed-in responses don't show. ### Object Types Rentvine uses Object Types to label different objects in the system. Object types, along with the primary key of the object given as `objectID`, are commonly used to identify objects that use a shared resource. For example, when uploading a file for a unit, the `unitID` would be used for the `objectID` and an `objectTypeID` of 7 would given with the file when uploading a file to the files endpoint.
ID Object Type
1Account
2User
3Contact
4Lease
5Bill
6Property
7Unit
8Deposit
9Accounting Transaction
10Accounting Transaction Entry
11Portfolio
12Payout
13Bank Adjustment
14Company
15Statement
16Work Order
17Inspection
18Inspection Area
19Inspection Item
20Application
21Applicant
22Bank Transfer
23Listing
24Appliance
25Text Message
26Email Message
27Work Order Estimate
28Settlement
29Lease Tenant
30Email Template
31Note
32File Attachment
33Vendor Bill
34Document Transaction
35Document Envelope
36Application Template
37Recurring Bill
38Chat Message
39Reconciliation
40Path
41Payout Return
42Management Fee Setting
43Additional Management Fee Setting
44Accounting Setting
45Posting Setting
46Late Fee Setting
47Statement Setting
48Payout Batch
49Letter
50Reminder
51Review
### Changelog Changes to the Manager API and to this reference since November 12, 2026, newest first. Each entry is dated the day the change merged; it appears on docs.rentvine.com with the next Rentvine release, usually within a week. Entries that correct the reference to match what the API already does are marked **Reference only**: the API's behavior did not change, but code or types generated from the earlier spec may need updating. #### 2026-11-16 - **Rate limits are enforced.** A request over any limit is now refused with `429 Too Many Requests` and isn't run. Until now the limits only counted requests: responses already carried the `RateLimit-Policy` and `RateLimit` headers, and a response over a limit showed `r=0` and a `Retry-After`, but the request still ran. Every limit is enforced: per API key (120 requests per 60 seconds), per user, per account, per partner app, per IP address, and the export and report limits. On a 429, wait the `Retry-After` seconds, then send the request again. Rentvine can relax every limit except the per-IP one for a single account, user or API key. [Rate Limits](https://docs.rentvine.com/#tag/Rate-Limits) lists each limit and how to back off. **Reference only.** - **Rate limits.** A new [Rate Limits](https://docs.rentvine.com/#tag/Rate-Limits) section in the Overview describes each limit and its allowance, the `RateLimit-Policy` and `RateLimit` headers, the `429` and its `Retry-After`, and how to back off. Every operation now documents the `429` response, and every response the two headers. - **Newly documented operations.** 37 operations the API already served are now in the reference: - Chart of accounts: `POST /accounting/accounts`; `GET`, `POST` and `PUT /accounting/accounts/{accountID}`; and `GET /accounting/bank-accounts`. - Bank reconciliations: `GET` and `POST /accounting/reconciliations`; `GET` and `DELETE /accounting/reconciliations/{reconciliationID}`, where `DELETE` voids the reconciliation; `GET /accounting/transactions/{transactionID}`; and `POST /accounting/transactions/{transactionID}/reconcile` and `/unreconcile`. - Lease transactions: `DELETE` on `/accounting/leases/charges/{transactionID}`, `/payments/{transactionID}`, `/credits/{transactionID}`, `/refunded-returns/{transactionID}` and `/deposit-release-credits/{transactionID}`, each of which voids the transaction (it keeps its history; nothing is deleted); `POST /accounting/leases/payments/{transactionID}/return`; and `POST /accounting/leases/{leaseID}/refunded-returns`, `/deposit-release-credits` and `/payouts`. - Lease pets: `GET` and `POST /leases/{leaseID}/pets`, and `GET`, `POST` and `DELETE /leases/{leaseID}/pets/{leasePetID}`. - Files: `GET /files`, `GET /files/search`, and `GET`, `POST` and `DELETE /files/{fileID}`. - Custom fields: `DELETE /custom-fields/{customFieldID}` and `DELETE /custom-field-categories/{customFieldCategoryID}`. Deleting a field clears its value on every record; deleting a category deletes every field in it. - Applications: `POST /screening/applications` creates an application from one of the account's templates, which `GET /screening/templates` lists. - `PUT /accounting/deposits/{depositID}` and `PUT /properties/{propertyID}/units/{unitID}`, which do the same as the `POST` on the same path. - **Properties and units.** The property and unit operations were checked against the API and corrected. The changes most likely to affect a client: - `GET /properties/{propertyID}/units` returns each unit under `unit`, and documents `page`, `pageSize`, `search`, `isActive` and `includes`. `GET /properties/{propertyID}/units/{unitID}` returns the unit under `unit`, beside the related records `includes` asks for. The reference had shown bare unit objects. - The `leaseBalances` and `portfolioBalances` includes are objects, not arrays. - `GET /properties` pages 15 items by default, not 25. - When `DELETE /properties/{propertyID}` or `DELETE /properties/{propertyID}/units/{unitID}` is refused because of the property's or unit's history, the `400` has one key per kind of record that blocks it, for example `{"leases": ["..."]}`, or `unit.applications` for a unit of the property; the reference had listed only `transactions`. An ID with no property or unit returns `400` `{"error": "Property {propertyID} not found"}` (or `Unit`), and an ID that isn't a number returns `404`. - `POST /properties/{propertyID}` doesn't change `portfolioID` or `isMultiUnit`; the reference had listed them in the request body. - `activateUnit` on `POST /properties/{propertyID}/activate` is `0` or `1`. - `POST /properties/{propertyID}/units` requires `address`, `city` and `stateID`. - `GET /properties/listings/search` excludes property types with `notPropertyTypeID[]`; the reference had named it `notPropertyTypeIDs`. - `GET /properties/search` now also documents `propertyIDs[]`, `propertyManagerIDs[]`, `city`, `stateID`, `postalCode`, `dateTimeModifiedMin`, `dateTimeModifiedMax` and `orderBy`. - **Contacts.** The association, maintenance technician, owner, tenant and vendor read operations were checked against the API and corrected: - Each item of `GET /owners`, `/tenants`, `/vendors`, `/associations` and `/maintenance-technicians` is `{"contact": {...}, "token": "..."}`. The reference had shown `GET /owners` items as bare contacts, and no list included `token`. - Each result of their `/search` operations carries `search.rank` when `search` is sent. - The contact returned by `GET /owners/{contactID}`, `/tenants/{contactID}`, `/vendors/{contactID}`, `/associations/{contactID}` and `/maintenance-technicians/{contactID}` also includes `isTaxIdentifierValid`, `taxIdentifierTypeID` and `taxIdentifierCountryID`. An ID with no contact of that type returns `400`, for example `{"error": "Owner {contactID} not found"}`; an ID that isn't a number returns `404`. A vendor's `reviewStats` is an array. - Yes/no filters take `0` or `1`, and array filters are named with brackets, for example `contactIDs[]`. The search operations document the tax identifier filters (`hasTaxIdentifier`, `isTaxIdentifierValid`, `taxIdentifierTypeIDs[]` and `hasDuplicateTaxIdentifier`). - `GET /vendors/search` takes no `includes`, and `GET /owners/search` has no insurance expiry filters; the reference had listed both. - **Other corrections.** - `GET /accounting/ledgers` needs `search` or `ledgerIDs[]`; without either it returns a `400` whose body is the JSON string `"Search Failed"`. - `depositNumber` in the body of `POST /accounting/deposits/{depositID}` is a string, not `null`, and the operation documents its `404`. #### 2026-11-13 **Reference only.** - **Response types match what the API sends.** Response fields are now documented with the JSON types the API returns: - IDs, counts and other whole numbers are strings of digits, for example `"117"`. - Yes/no flags are the strings `"0"` and `"1"`. - Money and other decimal amounts are strings, for example `"1600.00"`. - Timestamps are UTC strings in the form `YYYY-MM-DD HH:MM:SS`, and dates are `YYYY-MM-DD`. - Fields that can be empty are marked nullable. These rules cover values read from the database. A value the API computes keeps the type its field documents: for example, a lease's `rentAmount` and a predicted invoice line item's `amount` are numbers. Request bodies accept either the string or the number form. Path parameters such as `{propertyID}` are unchanged. - **Fields that changed shape.** - `addressValidationData` on a property or unit, and `diagnosticSummary` on a bill's work order, are objects (or `null`), not strings. - The `lineItems` of `GET /accounting/invoices/{invoiceID}` take one of two shapes. An invoice created in Rentvine returns rows with `invoiceLineItemID` and a string `amount`; any other invoice returns predicted items with no `invoiceLineItemID`, and `amount`, `unitPrice` and `quantity` as numbers or `null`. Check for `invoiceLineItemID` before reading `amount`. - **Enumerated fields list every value.** Most status and type fields that reference a shared list of values now document those values as the strings the API sends, with their current labels. Values added to the lists include property type `11` (Lot), work order primary status `5` (Cancelled), contact types `7` (Screening Prospect), `8` (Internal Technician) and `9` (Owner Lead), source type `7` (Ai) and transaction type `25` (Lease Refunded Return). `payoutTypeID` `1` is Other (paid outside Rentvine); the reference had called it Cash. - **Error responses.** A `400` is documented as either a single message, `{"error": "..."}`, or a map of validation messages keyed by field. A `403` documents each body the API sends, including the `ELEVATION_REQUIRED` error and the empty body some checks return. A `401` is `{"code": 401, "error": "..."}`, with `code` a number; the 29 operations that documented no error response now document it. A `404` from the resident services and packages operations is `{"code": "404", "error": "Not Found", "message": "..."}`, with `code` a string. - **Modified-date filters.** `dateTimeModifiedMin` and `dateTimeModifiedMax` are inclusive and read the time as UTC; a time zone offset in the value is ignored. A date alone means midnight. Encode `+` as `%2B`: an unencoded `+` is read as a space and the time is lost. A value the API can't read is ignored, and the list comes back unfiltered. - **Operation IDs.** Every operation now has an `operationId`; 28 operations that had none were named. - **Corrections to individual operations.** - `GET /leases/{leaseID}/recurring-charges` declares its `leaseID` path parameter. - Transaction entries no longer list `transactionID` and `ledgerID` as required; the API doesn't send them. - The request body of `POST /properties` no longer marks `propertyImageID` as required. The API doesn't read it from the request; the created property in the response still includes it. - `screeningReportModeID` in `GET /screening/applications/{applicationID}/summary` is documented as `0` (Disabled), `1` (Package) or `2` (Dynamic); the earlier description gave `1` and `2` other meanings. It is a string, except for an account with no screening settings, which gets the integer `0`. - `GET /properties/{propertyID}/images/{imageHash}/{size}.jpeg` no longer lists `account` as a path parameter; the account is the server's subdomain. - Related Endpoints links point at real paths. The bill links carry the `/accounting` prefix, a lease is updated with `POST /leases/{leaseID}` (there is no `PUT`), and a unit's listing is at `GET /properties/{propertyID}/units/{unitID}/listing`. #### 2026-11-12 - **Export limits.** `GET /leases/export`, `GET /properties/export`, `GET /properties/units/export` and `GET /screening/applications/export` each count against a limit of their own for each API key: 60 an hour, 10 of them at once. Responses list it as `endpoint` in the `RateLimit-Policy` and `RateLimit` headers. Like every other limit at the time, it counted requests without refusing any. **Reference only.** - **Bill paths.** The bill operations are documented at their real path, `/accounting/bills/{billID}` (`GET`, `POST` and `DELETE`). The reference listed them under `/accounting/{billID}`, which doesn't exist. - **Contact payment fields.** On the association, maintenance technician, owner, tenant and vendor operations, `payoutTypeID` and `achAccountTypeID` now list their values; the reference had pointed them at a file that doesn't exist. - **Valid OpenAPI 3.1.** The spec now validates as OpenAPI 3.1, so code generators and validators can read every schema: - Nullable fields use `type: [..., 'null']` instead of the OpenAPI 3.0 keyword `nullable`. - `datePostedMin` and `datePostedMax` are strings in `date` format. - The accounting `search` parameter is a string. - The accounting `*IDs[]` array parameters declare integer items. - `primaryWorkOrderStatusID` values are strings, as the API sends them. ## Export ### Export Leases #### Export Leases `GET /leases/export` Operation ID: `exportLeases` List Leases for Export The Last Modified Timestamp on Leases is updated by multiple actions including, but not limited to, the following. Parameters: - `leaseIDs[]` (query, integer[]): Filter by Lease IDs - `primaryLeaseStatusIDs[]` (query, `primary_lease_statuses_request`[]): Filter by Primary Lease Status - `leaseStatusIDs[]` (query, integer[]): Filter by Lease Status - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `lease` (`lease_export`) - `balances` (`balances`) - `unpaidCharges` (`unpaid_charges`) - `property` (`property_export`) - `unit` (`unit_export`) - `portfolio` (`portfolio_export`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` ### Export Properties #### Export Properties `GET /properties/export` Operation ID: `exportProperties` List Properties for Export The Last Modified Timestamp on Properties is updated by multiple actions including, but not limited to, the following. Parameters: - `isActive` (query, boolean) - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `property` (combined object) - All of: - Option 1: `property_export` - Option 2: object - `groups` (object[]) - `name` (string) - `propertyGroupID` (integer) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `portfolio` (`portfolio_export`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` ### Export Units #### Export Units `GET /properties/units/export` Operation ID: `exportUnits` List Units for Export The Last Modified Timestamp on Units is updated by multiple actions including, but not limited to, the following. Parameters: - `isActive` (query, boolean) - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `property` (`property_export`) - `unit` (combined object) - All of: - Option 1: `unit_export` - Option 2: object - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `401`: see shared response `error_401` - `429`: see shared response `error_429` ### Export Applications #### Export Applications `GET /screening/applications/export` Operation ID: `exportScreeningApplications` List Applications for Export The Last Modified Timestamp on Applications is set on creation and updated when applications are modified by the manager portal user. Parameters: - `primaryApplicationStatusIDs[]` (query, `primary_application_statuses`[]): Filter by Primary Application Status - `applicationStatusIDs[]` (query, integer[]): Filter by Application Status - `hasLease` (query, boolean): Filter by if there is a Lease Attached - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `application` (`application_export`) - `unit` (`unit_export`) - `lease` (object) - `leaseID` (string, pattern `^-?[0-9]+$`) - `startDate` (string, date) - `endDate` (string | null, date) - `tenants` (`contact_simplified`[] | null) - `401`: see shared response `error_401` - `429`: see shared response `error_429` ## Accounting ### Accounts #### List Accounts `GET /accounting/accounts` Operation ID: `listAccounts` Returns a paginated list of chart-of-accounts records. Each item contains a full `account` object. ##### Use Cases - Filter accounts by type (e.g. Bank, Expense, Income) using `accountTypeID` or `accountTypeIDs`. - Narrow the list to active-only or escrow-only accounts using `isActive` and `isEscrow`. ##### Business Rules - Results are scoped to the authenticated user's portfolio. ##### Related Endpoints - `GET /accounting/accounts/search` - Search with additional filters (accountID, dateTimeModified range). - `GET /accounting/accounts/{accountID}` - Retrieve a single account with optional includes. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 5000): Number of results per page. Defaults to 5000. - `search` (query, string): Full-text search against account name and account number. - `accountTypeID` (query, string): Filter by account type. Accepts a single integer or a comma-separated list. * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `accountTypeIDs` (query, integer[]): Array form of the account type filter. Takes precedence over `accountTypeID`. Use when the client sends array-style query parameters (e.g. `accountTypeIDs[]=3&accountTypeIDs[]=7`). - `isActive` (query, boolean): Filter by active status. `true` returns active accounts, `false` returns inactive accounts. - `isEscrow` (query, boolean): Filter to accounts flagged as escrow accounts. Responses: - `200`: Successfully retrieved accounts. - `application/json`: object[] - Each item: - `account` (`account`, required) - `token` (string, required): Session token associated with this response. Example: ```json [ { "account": { "accountID": "31", "parentAccountID": null, "accountTypeID": "3", "accountCategoryID": null, "number": "1010", "name": "Operating Account", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "0", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": "First National Bank", "bankAccountTypeID": "1", "bankAccountCiphertextID": "142", "bankAccountNumberTruncated": "4321", "bankAccountAddress": "100 Commerce Blvd", "bankAccountAddress2": null, "bankAccountCity": "Miami", "bankAccountStateID": "FL", "bankAccountPostalCode": "33101", "bankAccountCountryID": "US", "isCheckingEnabled": "1", "checkCompanyName": "Sunset Property Management", "checkSignatory": "Jane Doe", "checkAddress": "500 Brickell Ave", "checkAddress2": "Suite 200", "checkCity": "Miami", "checkStateID": "FL", "checkPostalCode": "33131", "checkCountryID": "US", "bankAccountNextCheckNumber": "1042", "bankAccountNextDepositNumber": "88", "checkTemplateID": "3", "creditCardGatewayID": null, "achGatewayID": "5", "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "1", "isNachaFileBalanced": "0", "nachaOriginName": "Sunset PM", "nachaOriginNumber": "0123456789", "nachaDestinationName": "First National Bank", "nachaDestinationNumber": "021000021", "nachaCompanyIdentification": "1234567890", "nachaCompanyName": "Sunset Property Mgmt", "nachaOriginatingFinancialInstitutionID": "021000021", "nachaAdapterID": "1", "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-04-10 09:22:44", "dateTimeDeactivated": null }, "token": "1777146894" } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Account `POST /accounting/accounts` Operation ID: `createAccount` Creates a chart-of-accounts account and answers with it as `GET /accounting/accounts/{accountID}` reads it. A bank account (`accountTypeID` `3`) also takes its routing and account numbers, which are stored encrypted and never returned. ##### Use Cases - Add an income or expense account to the chart of accounts before posting charges or bills to it. - Set up a bank account with its routing and account numbers, and optionally check printing and NACHA payout files. - Add a sub-account under an existing account of the same type. ##### Business Rules - Requires the **Manage Chart Of Accounts** permission (`Administration` › `ManageChartOfAccounts`). A bank account also requires **Manage Bank Accounts** (`Administration` › `ManageBankAccounts`). Either missing answers 403 `{"error": "Permission Denied"}`. - `accountTypeID`, `number` and `name` are required, and a bank account also needs `bankAccount.routingNumber` and `bankAccount.accountNumber`. With no `accountTypeID`, or one that isn't an account type, the API answers 400 with an `error` (`Account type is required to create the account state`, `State class not defined for this account type`) before it checks any other field. - A bank account's numbers are checked first: when they fail, the 400 lists only the `bankAccount.*` messages. Then the account's own fields are checked, and every failure is listed, keyed `account.`. - `number` is at most 10 characters and unique among accounts with the same parent (`This account already exists`); `name` is at most 100. A sub-account's type must match its parent's (`Account type must be the same as the parent account type`), and a category's type must match the account's. `isDeposit` and `isPrepayment` can't both be `1`. - A bank account with `isCheckingEnabled` `1` needs the bank and check fields (`bankName`, `bankAccountTypeID`, the bank and check addresses, `checkCompanyName`, `checkTemplateID`); one with `isNachaEnabled` `1` needs `isNachaFileBalanced` and every `nacha*` field but `nachaAdapterID`. Each missing one is listed with its own message. - The account type decides which fields the account keeps. Whatever the request sends, saving sets the others to `0` or `null`: | Account type | Flags set to `0` | Bank, check, NACHA and gateway fields (not `nachaAdapterID` or `exportInvoiceServiceName`) | | --- | --- | --- | | `1` Accounts Receivable, `2` Accounts Payable | every flag but `isSubjectToMarkup` and `isBillApprovalExempt` | cleared | | `3` Bank | every flag but `isEscrow`, `isSubjectToMarkup`, `isBillApprovalExempt`, `isCheckingEnabled`, `isNachaEnabled` | kept; the NACHA fields cleared when `isNachaEnabled` is `0` | | `4` Asset | `isDeposit`, `isEscrow`, `isSubsidized`, `isPrepayment`, `isManagementFee`, `isBudgetEnabled`, `isHeld`, `isSubjectToSalesTax` | cleared | | `5` Liability | `isEscrow`, `isSubsidized`, `isManagementFee`, `isBudgetEnabled`, `isSubjectToSalesTax` | cleared | | `6` Equity | `isDeposit`, `isEscrow`, `isSubsidized`, `isPrepayment`, `isManagementFee`, `isHeld`, `isSubjectToSalesTax` | cleared | | `7` Income | `isDeposit`, `isEscrow`, `isManagementFee`, `isHeld` | cleared | | `8` Other Income | `isDeposit`, `isEscrow`, `isManagementFee` | cleared | | `9` Expense, `10` Other Expense | `isDeposit`, `isEscrow`, `isRent`, `isSubsidized`, `isTaxable`, `isPrepayment`, `isHeld` | cleared | `depositTypeID` is cleared wherever `isDeposit` is. - Flags left out are `0`, except `isSubjectToMarkup` and `isHeld` (`1`, where the type keeps them) and `isNachaFileBalanced` (`1`, then `0` when NACHA is off). A new account is always active. - Send `includes` to get the account's includes in the response, as `GET /accounting/accounts/{accountID}` takes them. ##### Side Effects - A bank account's routing and account numbers are encrypted into a stored record (its ID is the account's `bankAccountCiphertextID`), and `bankAccountNumberTruncated` is set to the account number's last 4 digits. - The first bank account created when the accounting settings have no default bank account becomes the default (`defaultBankAccountID` in `GET /accounting/settings` (undocumented)). - An "Account Created" entry is added to the account's activity log, which `GET /logs/{objectTypeID}/{objectID}` (undocumented) lists for object type `54`. ##### Related Endpoints - `GET /accounting/accounts/{accountID}` - Read the account back, with includes. - `POST /accounting/accounts/{accountID}` - Change the account. - `GET /accounting/accounts` - List accounts, for a parent account's ID. - `GET /accounting/bank-accounts` - List the bank accounts. Parameters: - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `accountCategory`, `checkTemplate`, `currentReconciliation`, `unprintedCheckCount`, `positivePayGateway`. Unknown names are ignored. Request body, required: - `application/json`: `account_create` Example: ```json { "accountTypeID": 7, "number": "4150", "name": "Pet Rent Income", "isRent": 1, "isSubjectToManagementFees": 1, "isSubjectToLateFees": 1, "isTaxable": 0 } ``` Responses: - `200`: The account was created. The body is the new account, as `GET /accounting/accounts/{accountID}` reads it. - `application/json`: `account_detail` Example: ```json { "account": { "accountID": "169", "parentAccountID": null, "accountTypeID": "7", "accountCategoryID": null, "number": "4150", "name": "Pet Rent Income", "isActive": "1", "isSubjectToManagementFees": "1", "isSubjectToLateFees": "1", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "1", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": null, "bankAccountTypeID": null, "bankAccountCiphertextID": null, "bankAccountNumberTruncated": null, "bankAccountAddress": null, "bankAccountAddress2": null, "bankAccountCity": null, "bankAccountStateID": null, "bankAccountPostalCode": null, "bankAccountCountryID": null, "isCheckingEnabled": "0", "checkCompanyName": null, "checkSignatory": null, "checkAddress": null, "checkAddress2": null, "checkCity": null, "checkStateID": null, "checkPostalCode": null, "checkCountryID": null, "bankAccountNextCheckNumber": null, "bankAccountNextDepositNumber": null, "checkTemplateID": null, "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "0", "isNachaFileBalanced": "0", "nachaOriginName": null, "nachaOriginNumber": null, "nachaDestinationName": null, "nachaDestinationNumber": null, "nachaCompanyIdentification": null, "nachaCompanyName": null, "nachaOriginatingFinancialInstitutionID": null, "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2026-11-12 23:22:51", "dateTimeModified": "2026-11-12 23:22:51", "dateTimeDeactivated": null } } ``` - `400`: see shared response `account_create_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Accounts `GET /accounting/accounts/search` Operation ID: `searchAccounts` Returns a paginated, searchable list of chart-of-accounts records joined with their account category. Each result item contains a full `account` object and an `accountCategory` object (all fields `null` when no category is assigned). This endpoint is the preferred way to search accounts with advanced filters such as `accountID` lookup. ##### Use Cases - Look up a single account by `accountID`. ##### Business Rules - The `accountCategory` object is always present; its fields are `null` when the account has no category assigned. - `isActive` and `isEscrow` accept boolean values (`true`/`false` or `1`/`0`). - `dateTimeModifiedMin` and `dateTimeModifiedMax` accept ISO 8601 datetime strings. ##### Related Endpoints - `GET /accounting/accounts` - Simpler list endpoint with a 5000 default page size. - `GET /accounting/accounts/{accountID}` - Retrieve a single account with optional includes. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Full-text search against account name and account number. - `isActive` (query, boolean): Filter by active status. `true` returns active accounts, `false` returns inactive. - `isEscrow` (query, boolean): Filter to accounts flagged as escrow accounts. - `accountTypeIDs` (query, integer[]): Filter by one or more account type IDs (array form). * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `accountID` (query, integer): Look up a single account by its ID. - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. Responses: - `200`: Successfully retrieved accounts. - `application/json`: object[] - Each item: - `account` (`account`, required) - `accountCategory` (object | null, required): Account category associated with this account, or null fields when uncategorized. - `accountCategoryID` (string | null, read-only, pattern `^-?[0-9]+$`): Unique identifier of the account category. - `accountTypeID` (string | null, pattern `^-?[0-9]+$`): Account type this category belongs to. - `name` (string | null): Display name of the account category. Example: ```json [ { "account": { "accountID": "31", "parentAccountID": null, "accountTypeID": "3", "accountCategoryID": null, "number": "1010", "name": "Operating Account", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "0", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": "First National Bank", "bankAccountTypeID": "1", "bankAccountCiphertextID": "142", "bankAccountNumberTruncated": "4321", "bankAccountAddress": "100 Commerce Blvd", "bankAccountAddress2": null, "bankAccountCity": "Miami", "bankAccountStateID": "FL", "bankAccountPostalCode": "33101", "bankAccountCountryID": "US", "isCheckingEnabled": "1", "checkCompanyName": "Sunset Property Management", "checkSignatory": "Jane Doe", "checkAddress": "500 Brickell Ave", "checkAddress2": "Suite 200", "checkCity": "Miami", "checkStateID": "FL", "checkPostalCode": "33131", "checkCountryID": "US", "bankAccountNextCheckNumber": "1042", "bankAccountNextDepositNumber": "88", "checkTemplateID": "3", "creditCardGatewayID": null, "achGatewayID": "5", "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "1", "isNachaFileBalanced": "0", "nachaOriginName": "Sunset PM", "nachaOriginNumber": "0123456789", "nachaDestinationName": "First National Bank", "nachaDestinationNumber": "021000021", "nachaCompanyIdentification": "1234567890", "nachaCompanyName": "Sunset Property Mgmt", "nachaOriginatingFinancialInstitutionID": "021000021", "nachaAdapterID": "1", "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-04-10 09:22:44", "dateTimeDeactivated": null }, "accountCategory": { "accountCategoryID": null, "accountTypeID": null, "name": null } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Account `GET /accounting/accounts/{accountID}` Operation ID: `getAccount` Returns one chart-of-accounts account, with the related records the `includes` parameter asks for. A bank account's routing and account numbers aren't part of it: the response carries only the account number's last 4 digits (`bankAccountNumberTruncated`). ##### Use Cases - Read an account's settings before changing it with `POST /accounting/accounts/{accountID}`. - Check a bank account's current reconciliation and how many checks wait to be printed. ##### Business Rules - No permission is checked beyond a valid API key, and portfolio restrictions don't apply: the chart of accounts is account-wide. - An ID with no account answers 400 `{"error": "Account not found"}`; so does `0`. ##### Available Includes (5) - `accountCategory` - The account's category, or null. - `checkTemplate` - The check template the account prints with, or null. - `currentReconciliation` - The current reconciliation, or an unsaved placeholder when there is none. - `unprintedCheckCount` - How many of the account's check payouts wait to be printed (a JSON number). - `positivePayGateway` - The account's positive pay gateway, or null. ##### Related Endpoints - `GET /accounting/accounts` - List accounts. - `GET /accounting/bank-accounts` - List the bank accounts. - `POST /accounting/accounts/{accountID}` - Change the account. Parameters: - `accountID` (path, integer, required): The account's ID, from `GET /accounting/accounts` or `GET /accounting/bank-accounts`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `accountCategory`, `checkTemplate`, `currentReconciliation`, `unprintedCheckCount`, `positivePayGateway`. Unknown names are ignored. Responses: - `200`: The account, with the includes that were asked for. - `application/json`: `account_detail` Example: ```json { "account": { "accountID": "157", "parentAccountID": null, "accountTypeID": "3", "accountCategoryID": null, "number": "1015", "name": "Operating - Example Bank", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": "Example Bank", "bankAccountTypeID": "2", "bankAccountCiphertextID": "15", "bankAccountNumberTruncated": "6789", "bankAccountAddress": "123 Main St", "bankAccountAddress2": "Apt 4", "bankAccountCity": "Springfield", "bankAccountStateID": "IL", "bankAccountPostalCode": "12345", "bankAccountCountryID": "US", "isCheckingEnabled": "1", "checkCompanyName": "Example Property Management", "checkSignatory": "Jordan Example", "checkAddress": "123 Main St", "checkAddress2": "Apt 4", "checkCity": "Springfield", "checkStateID": "IL", "checkPostalCode": "12345", "checkCountryID": "US", "bankAccountNextCheckNumber": "1001", "bankAccountNextDepositNumber": "501", "checkTemplateID": "83", "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "1", "isNachaFileBalanced": "1", "nachaOriginName": "Example PM", "nachaOriginNumber": "0123456789", "nachaDestinationName": "Example Bank", "nachaDestinationNumber": "021000021", "nachaCompanyIdentification": "1234567890", "nachaCompanyName": "Example PM", "nachaOriginatingFinancialInstitutionID": "02100002", "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": "Example Export", "dateTimeCreated": "2026-11-12 23:22:47", "dateTimeModified": "2026-11-12 23:22:47", "dateTimeDeactivated": null } } ``` - `400`: No account has this ID (`0` included). - `application/json`: object - `error` (string, required): `Account not found`. Example: ```json { "error": "Account 999999999 not found" } ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Account (PUT) `PUT /accounting/accounts/{accountID}` Operation ID: `updateAccountPut` The same operation as `POST /accounting/accounts/{accountID}`, sent as a PUT: same request, permissions, rules, side effects and responses. It is a partial update too: send only the fields to change. ##### Related Endpoints - `POST /accounting/accounts/{accountID}` - The full description of the update. Parameters: - `accountID` (path, integer, required): The account's ID, from `GET /accounting/accounts` or `GET /accounting/bank-accounts`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `accountCategory`, `checkTemplate`, `currentReconciliation`, `unprintedCheckCount`, `positivePayGateway`. Unknown names are ignored. Request body, required (shared request body `account_update_body`): - `application/json`: `account_update` Example: ```json { "name": "Application Fees", "isSubjectToManagementFees": 1, "isTaxable": 1 } ``` Responses: - `200`: see shared response `account_update_200` - `400`: see shared response `account_update_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Account `POST /accounting/accounts/{accountID}` Operation ID: `updateAccount` Changes a chart-of-accounts account and answers with it as `GET /accounting/accounts/{accountID}` reads it. Send only the fields to change. The account type can't change, and this operation doesn't activate or deactivate an account or change a bank account's routing and account numbers. ##### Use Cases - Rename or renumber an account, or move it under another parent. - Turn management fees, late fees or tax on or off for the charges an account takes. - Change a bank account's check printing or NACHA settings. ##### Business Rules - Requires the **Manage Chart Of Accounts** permission (`Administration` › `ManageChartOfAccounts`). Changing a bank account also requires **Manage Bank Accounts** (`Administration` › `ManageBankAccounts`). Either missing answers 403 `{"error": "Permission Denied"}`. - An ID with no account answers 400 `{"error": "Account not found"}`, after the empty-body check. - Only the fields of the request schema are read; any other key is ignored. A different `accountTypeID` is refused (`Cannot change the account type`). - A new parent can't be the account itself (`Cannot select parent as self`) or one of its sub-accounts (`Cannot select this parent - circular reference`). The other field rules are the create's: `number` at most 10 characters and unique under the parent, `name` at most 100, a category of the same type, not both `isDeposit` and `isPrepayment`, and on a bank account the check and NACHA fields required when those are on. - The account type decides which fields the account keeps, as on `POST /accounting/accounts`: fields its type doesn't keep go back to `0` or `null` whatever the request sends. - Send `includes` to get the account's includes in the response. Without it the response has only `account`. ##### Side Effects - An "Updated Account" entry listing the changed fields is added to the account's activity log (`GET /logs/{objectTypeID}/{objectID}` (undocumented), object type `54`) when anything changed. - On a bank account with a remote check printing gateway, a new `checkSignatory` deletes that gateway and emails Rentvine support that remote check printing was turned off for the bank account. ##### Related Endpoints - `GET /accounting/accounts/{accountID}` - Read the account. - `PUT /accounting/accounts/{accountID}` - The same operation as a PUT. - `POST /accounting/accounts` - Create an account. Parameters: - `accountID` (path, integer, required): The account's ID, from `GET /accounting/accounts` or `GET /accounting/bank-accounts`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `accountCategory`, `checkTemplate`, `currentReconciliation`, `unprintedCheckCount`, `positivePayGateway`. Unknown names are ignored. Request body, required (shared request body `account_update_body`): - `application/json`: `account_update` Example: ```json { "name": "Application Fees", "isSubjectToManagementFees": 1, "isTaxable": 1 } ``` Responses: - `200`: see shared response `account_update_200` - `400`: see shared response `account_update_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### List Bank Accounts `GET /accounting/bank-accounts` Operation ID: `listBankAccounts` Returns every bank account in the chart of accounts (accounts of type `3`, Bank) in one page, with a few of each account's fields and how many of its checks wait to be printed. It doesn't return routing or account numbers. ##### Use Cases - Pick the bank account a payment, deposit or payout should use. - Find the bank accounts with checks waiting to be printed. ##### Business Rules - No permission is checked beyond a valid API key, and portfolio restrictions don't apply. - Sorted by `number` (as text), then `name`, then `accountID`. - There is no paging: every match comes back in one response, up to 9999 accounts. The pagination headers describe that single page. - The filters combine with AND. `isActive` and `isEscrow` take `true`/`false` or `1`/`0` (also `yes`/`no`, in any case); any other value is ignored and the list isn't filtered by it. ##### Related Endpoints - `GET /accounting/accounts/{accountID}` - Read one bank account in full. - `POST /accounting/accounts` - Create a bank account. - `GET /accounting/accounts` - List every kind of account. Parameters: - `search` (query, string): Keeps the bank accounts whose `name` or `number` contains this text (case-insensitive). - `isActive` (query, string): `true` (or `1`) keeps only active bank accounts, `false` (or `0`) only inactive ones. - `isEscrow` (query, string): `true` (or `1`) keeps only escrow (trust) bank accounts, `false` (or `0`) only the others. - `bankAccountIDs[]` (query, integer[]): Keeps only these accounts. Send each ID as a separate `bankAccountIDs[]=` (`bankAccountIDs[]=31&bankAccountIDs[]=32`). Responses: - `200`: The bank accounts that match, in one page. - `application/json`: object[] - Each item: - `account` (object, required): A bank account's summary fields. - `accountID` (string, required, read-only, pattern `^-?[0-9]+$`): The account's ID. - `number` (string, required, max length 10): Chart-of-accounts number. - `name` (string, required, max length 100): Display name. - `bankName` (string | null, required, max length 100): The bank's name. - `bankAccountNextCheckNumber` (string | null, required, max length 25): Next check number. - `bankAccountNextDepositNumber` (string | null, required, max length 25): Next deposit number. - `isEscrow` (string, required, one of "0", "1"): Whether the account holds escrow (trust) funds. - `creditCardGatewayID` (string | null, required, pattern `^-?[0-9]+$`): The account's credit card gateway, or null. - `achGatewayID` (string | null, required, pattern `^-?[0-9]+$`): The account's ACH gateway, or null. - `bankAccountTypeID` (one of several shapes, required): Savings or checking, or null when not set. * `1` - Savings * `2` - Checking - One of: - Option 1: `bank_account_types` - Option 2: null - `bankAccountNumberTruncated` (string | null, required, max length 4): Last 4 digits of the account number, or null. - `isCheckingEnabled` (string, required, one of "0", "1"): Whether the account prints checks. - `isActive` (string, required, one of "0", "1"): Whether the account is active. - `unprintedCheckCount` (string, required, pattern `^[0-9]+$`): How many of the account's check payouts wait to be printed: not voided, never printed, in an approved payout batch. A string of digits, unlike the `unprintedCheckCount` include of `GET /accounting/accounts/{accountID}`. Example: ```json [ { "account": { "accountID": "161", "number": "1015", "name": "Operating - Example Bank", "bankName": "Example Bank", "bankAccountNextCheckNumber": "1001", "bankAccountNextDepositNumber": "501", "isEscrow": "0", "creditCardGatewayID": null, "achGatewayID": null, "bankAccountTypeID": "2", "bankAccountNumberTruncated": "6789", "isCheckingEnabled": "1", "isActive": "1", "unprintedCheckCount": "1" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` ### Bills #### List Bills `GET /accounting/bills` Operation ID: `listBills` Returns a paginated list of bills. Each item in the response includes the bill record and its associated payee contact. ##### Use Cases - Retrieve all bills for display in a bills list view. - Filter bills by date range, approval status, or payee for reporting. ##### Business Rules - The `contact` object is always returned alongside each bill — it is not opt-in. - Results are paginated; use the `page` and `pageSize` query parameters to navigate pages. ##### Related Endpoints - `GET /accounting/bills/{billID}` - Retrieve a single bill with full includes support. - `POST /accounting/bills` - Create a bill. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved bills. - `application/json`: object[] - Each item: - `bill` (`bill`, required) - `contact` (object, required): The payee contact associated with this bill. - `contactID` (string, pattern `^-?[0-9]+$`) - `contactTypeID` (string, pattern `^-?[0-9]+$`) - `vendorTypeID` (string | null, pattern `^-?[0-9]+$`) - `code` (string | null) - `name` (string) - `firstName` (string | null) - `middleName` (string | null) - `lastName` (string | null) - `suffix` (string | null) - `email` (string | null, email) - `phone` (string | null) - `countryID` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `payeeName` (string | null) - `taxPayerName` (string | null) - `taxFormTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationNumber` (string | null) - `identificationCountryID` (string | null) - `identificationIssuingLocation` (string | null) - `identificationExpirationDate` (string | null, date) - `payoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `otherPayoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `achDetailsCiphertextID` (string | null, pattern `^-?[0-9]+$`) - `achAccountNumberTruncated` (string | null) - `achAccountTypeID` (string | null, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | null, decimal) - `discountAmount` (string | null, decimal) - `discountAmountMin` (string | null, decimal) - `discountAmountMax` (string | null, decimal) - `discountGraceDays` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `isInsuranceRequiredForPayment` (string | null, one of "0", "1", null) - `maxLineItemsOnPayment` (string | null, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) - `websiteUrl` (string | null, uri) - `applicantID` (string | null, pattern `^-?[0-9]+$`) - `ownerPortalNameOverride` (string | null) - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `quickbooksCustomerName` (string | null) - `invoiceAutofillTemplateID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string): Human-readable label for the contact type (e.g. `"Vendor"`, `"Manager"`, `"Owner"`). Example: ```json [ { "bill": { "billID": "14201", "billBatchID": null, "parentBillID": "14200", "payeeContactID": "1", "billTypeID": "2", "bankAccountID": null, "billDate": "2027-11-11", "dateDue": "2027-11-11", "reference": "515151", "paymentMemo": null, "serviceAccountNumber": null, "description": null, "workOrderID": "4772", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "381140", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "1", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "contact": { "contactID": "1", "contactTypeID": "4", "vendorTypeID": null, "code": null, "name": "123 PM", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jimmy@rentvine.com", "phone": "+18883034711", "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "3", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "101", "achAccountNumberTruncated": "7337", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "50", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "1", "quickbooksCustomerName": "123 PM Company", "invoiceAutofillTemplateID": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-03-30 16:07:14", "dateTimeDeactivated": null, "contactType": "Manager" } } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Bill `POST /accounting/bills` Operation ID: `createBill` Creates a new bill in the system. ##### Use Cases - Record vendor invoices and distribute costs across property ledgers. - Attach tenant-responsible amounts via `leaseCharges`. - Link a bill to an existing work order for maintenance cost tracking. - Override the default bank account used to pay the bill. ##### Business Rules - `payeeContactID`, `billDate`, and `dateDue` are required. - **Linking to a work order:** First create the work order, then pass its `workOrderID` on this request. Optionally set `workOrderStatusID` to update the work order's status at the same time the bill is created. - **Bank account selection:** Set `overrideBankAccount: true` and supply `bankAccountID` to pay the bill from a specific bank account. When `overrideBankAccount` is `false` (or omitted), the system uses the bank account defined in the payer's posting settings. - Each entry in `charges` must include `ledgerID`, `chargeAccountID`, and `amount`. - Each entry in `leaseCharges` must include `leaseID`, `chargeAccountID`, and `amount`. ##### Related Endpoints - `GET /accounting/bills` - List all bills. - `GET /accounting/bills/{billID}` - Retrieve a single bill with optional includes. - `POST /accounting/bills/{billID}` - Update an existing bill. - `DELETE /accounting/bills/{billID}` - Void a bill. Request body, required: - `application/json`: `bill_create` Example: ```json { "payeeContactID": "67", "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "Plumbing invoice April", "description": "Bathroom plumbing repair", "charges": [ { "ledgerID": "960", "description": "Plumbing repair labor", "chargeAccountID": "37", "amount": "100.00", "salesTaxAmount": "0.00", "leaseID": null } ], "leaseCharges": [], "overrideBankAccount": false } ``` Responses: - `200`: Bill successfully created. - `application/json`: object - `bill` (`bill`, required) Example: ```json { "bill": { "billID": "15106", "billBatchID": null, "parentBillID": null, "payeeContactID": "67", "billTypeID": "1", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "Plumbing invoice April", "serviceAccountNumber": null, "description": "Bathroom plumbing repair", "workOrderID": null, "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "512915", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null } } ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Bill `GET /accounting/bills/{billID}` Operation ID: `getBill` Retrieves a single bill by ID, with optional related data via includes. ##### Available Includes (12+) Pass a comma-separated list of include names in the `includes` query parameter. | Include name | What it adds | | ---------------- | ----------------------------------------------------------------------- | | `contact` | Full payee contact record (vendor/owner details, ACH info, insurance). | | `charges` | Line-item charges posted to ledgers for this bill. | | `bankAccount` | The bank account used to pay this bill. | | `leaseCharges` | Tenant-responsible charge transactions, each with property/unit/ledger. | | `payouts` | Payouts that have been applied toward this bill. | | `workOrder` | The linked work order, if any. | | `parentBill` | The parent bill when this is a discount or markup child bill. | | `discountBill` | The associated discount bill, if one was generated. | | `markupBill` | The associated markup bill, if one was generated. | | `markupDiscount` | Computed markup and discount dollar amounts for the bill. | | `utility` | The utility associated with this bill, if any. | | `property` | The property associated with this bill, if any. | ##### Related Endpoints - `GET /accounting/bills` - List all bills. - `POST /accounting/bills` - Create a bill. - `POST /accounting/bills/{billID}` - Update a bill. - `DELETE /accounting/bills/{billID}` - Void a bill. Parameters: - `billID` (path, integer, required) - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `contact`, `charges`, `bankAccount`, `leaseCharges`, `payouts`, `workOrder`, `parentBill`, `discountBill`, `markupBill`, `markupDiscount`, `utility`, `property`. Responses: - `200`: Successfully retrieved the bill. - `application/json`: object - `bill` (`bill`, required) - `contact` (object | null): Payee contact details (if includes=contact). - `contactID` (string, pattern `^-?[0-9]+$`) - `contactTypeID` (string, pattern `^-?[0-9]+$`) - `vendorTypeID` (string | null, pattern `^-?[0-9]+$`) - `code` (string | null) - `name` (string) - `firstName` (string | null) - `middleName` (string | null) - `lastName` (string | null) - `suffix` (string | null) - `email` (string | null, email) - `phone` (string | null) - `countryID` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `payeeName` (string | null) - `taxPayerName` (string | null) - `taxFormTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationNumber` (string | null) - `identificationCountryID` (string | null) - `identificationIssuingLocation` (string | null) - `identificationExpirationDate` (string | null, date) - `payoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `otherPayoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `achDetailsCiphertextID` (string | null, pattern `^-?[0-9]+$`) - `achAccountNumberTruncated` (string | null) - `achAccountTypeID` (string | null, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | null, decimal) - `discountAmount` (string | null, decimal) - `discountAmountMin` (string | null, decimal) - `discountAmountMax` (string | null, decimal) - `discountGraceDays` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `isInsuranceRequiredForPayment` (string | null, one of "0", "1", null) - `maxLineItemsOnPayment` (string | null, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) - `websiteUrl` (string | null, uri) - `applicantID` (string | null, pattern `^-?[0-9]+$`) - `ownerPortalNameOverride` (string | null) - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `quickbooksCustomerName` (string | null) - `invoiceAutofillTemplateID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string): Human-readable label for the contact type (e.g. `"Vendor"`, `"Manager"`). - `charges` (object[]): Ledger charge lines (if includes=charges). - `transaction` (object): The accounting transaction for this charge. - `transactionID` (string, pattern `^-?[0-9]+$`) - `transactionTypeID` (string, pattern `^-?[0-9]+$`) - `managementFeeMode` (string | null, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `contactID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountID` (string | null, pattern `^-?[0-9]+$`) - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `equityAccountID` (string | null, pattern `^-?[0-9]+$`) - `destinationBankAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountFilterTypeID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountID` (string | null, pattern `^-?[0-9]+$`) - `unallocatedAccountID` (string | null, pattern `^-?[0-9]+$`) - `payoutID` (string | null, pattern `^-?[0-9]+$`) - `payoutReturnID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `amountPaid` (string | null, decimal) - `amountAllocated` (string | null, decimal) - `processingFee` (string | null, decimal) - `convenienceFee` (string | null, decimal) - `convenienceFeeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `reference` (string | null) - `receivedFrom` (string | null) - `returnTransactionID` (string | null, pattern `^-?[0-9]+$`) - `returnTypeID` (string | null, pattern `^-?[0-9]+$`) - `returnDescription` (string | null) - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`) - `paymentTypeID` (string | null, pattern `^-?[0-9]+$`) - `billChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `billCreditTransactionID` (string | null, pattern `^-?[0-9]+$`) - `discountAmount` (string | null, decimal) - `markupAmount` (string | null, decimal) - `managementFeeAmountPaid` (string | null, decimal) - `isAdditionalManagementFee` (string | null, one of "0", "1", null) - `managementFeePercent` (string | null, decimal) - `isSuppressed` (string, one of "0", "1") - `managementFeeExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeePeriodDate` (string | null, date) - `managementFeeSalesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxAmountPaid` (string | null, decimal) - `managementFeeSalesTaxPercent` (string | null, decimal) - `managementFeeSalesTaxIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeBatchID` (string | null, pattern `^-?[0-9]+$`) - `isSalesTaxCharge` (string | null, one of "0", "1", null) - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `salesTaxInitiatedFromTransactionID` (string | null, pattern `^-?[0-9]+$`) - `isVoided` (string, one of "0", "1") - `bankAccountGatewayID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountGatewayTransactionID` (string | null) - `settlementID` (string | null, pattern `^-?[0-9]+$`) - `paymentAccountName` (string | null) - `paymentAccountNumberTruncated` (string | null) - `depositID` (string | null, pattern `^-?[0-9]+$`) - `reconciliationID` (string | null, pattern `^-?[0-9]+$`) - `previousReconciliationID` (string | null, pattern `^-?[0-9]+$`) - `achStatusID` (string | null, pattern `^-?[0-9]+$`) - `bankTransferID` (string | null, pattern `^-?[0-9]+$`) - `lateFeePeriod` (string | null, pattern `^-?[0-9]+$`) - `isFromManager` (string | null, one of "0", "1", null) - `isMoveInCharge` (string | null, one of "0", "1", null) - `isProrated` (string | null, one of "0", "1", null) - `isMoveOutTransaction` (string | null, one of "0", "1", null) - `moveOutAmount` (string | null, decimal) - `discountMarkupBillChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `recurringObjectID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxContactID` (string | null, pattern `^-?[0-9]+$`) - `datePosted` (string, date) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `property` (object | null): The property associated with this charge. - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyImageID` (string | null, pattern `^-?[0-9]+$`) - `propertyTypeID` (string | null, pattern `^-?[0-9]+$`) - `isMultiUnit` (string | null, one of "0", "1", null) - `isActive` (string | null, one of "0", "1", null) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSettingID` (string | null, pattern `^-?[0-9]+$`) - `name` (string | null) - `countryID` (string | null) - `address` (string | null) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `stateID` (string | null) - `city` (string | null) - `postalCode` (string | null) - `latitude` (string | null, decimal) - `longitude` (string | null, decimal) - `county` (string | null) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `legalDescription` (string | null) - `maintenanceLimitAmount` (string | null, decimal) - `yearBuilt` (string | null, pattern `^-?[0-9]+$`) - `dateTimeModified` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string | null, one of "0", "1", null) - `dateInsuranceExpires` (string | null, date) - `dateWarrantyExpires` (string | null, date) - `maintenanceNotes` (string | null) - `applicationTemplateID` (string | null, pattern `^-?[0-9]+$`) - `reserveAmount` (string | null, decimal) - `markupPercent` (string | null, decimal) - `markupAmount` (string | null, decimal) - `markupAmountMin` (string | null, decimal) - `markupAmountMax` (string | null, decimal) - `dateContractBegins` (string | null, date) - `dateContractEnds` (string | null, date) - `commercialClassTypeID` (string | null, pattern `^-?[0-9]+$`) - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`) - `insuranceCompany` (string | null) - `insuranceAgent` (string | null) - `insurancePolicyNumber` (string | null) - `insuranceContactDetails` (string | null) - `leaseReturnChargeAmount` (string | null, decimal) - `propertyShowingProviderID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `importSourceKey` (string | null) - `unit` (object | null): The unit associated with this charge, if any. - `unitID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyImageID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string | null, one of "0", "1", null) - `name` (string | null) - `address` (string | null) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `stateID` (string | null) - `city` (string | null) - `postalCode` (string | null) - `latitude` (string | null, decimal) - `longitude` (string | null, decimal) - `rent` (string | null, decimal) - `deposit` (string | null, decimal) - `size` (string | null, pattern `^-?[0-9]+$`) - `beds` (string | null, pattern `^-?[0-9]+$`) - `fullBaths` (string | null, pattern `^-?[0-9]+$`) - `halfBaths` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `propertyManagerID` (string | null, pattern `^-?[0-9]+$`) - `commercialSpaceTypeID` (string | null, pattern `^-?[0-9]+$`) - `isNonRevenue` (string | null, one of "0", "1", null) - `nonRevenueTypeID` (string | null, pattern `^-?[0-9]+$`) - `nonRevenueStartDate` (string | null, date) - `isUtilityBillingEnabled` (string | null, one of "0", "1", null) - `isFromImport` (string | null, one of "0", "1", null) - `importSourceKey` (string | null) - `leaseNotes` (string | null) - `entryInstructions` (string | null) - `vendorEntryInstructions` (string | null) - `maintenanceNotes` (string | null) - `portfolio` (object | null): The portfolio associated with this charge. - `portfolioID` (string, pattern `^-?[0-9]+$`) - `code` (string | null) - `name` (string) - `contacts` (object[] | null): Owner contacts and their ownership/distribution percentages. - `contactID` (string, pattern `^-?[0-9]+$`) - `percentOwned` (string, decimal) - `percentDistributed` (string, decimal) - `name` (string) - `postingSettingID` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `minimumDistributionAmount` (string | null, decimal) - `maximumDistributionAmount` (string | null, decimal) - `reserveAmount` (string | null, decimal) - `additionalReserveAmount` (string | null, decimal) - `additionalReserveDescription` (string | null) - `overdraftOverrideAmount` (string | null, decimal) - `fiscalYearEndMonth` (string | null, pattern `^-?[0-9]+$`) - `statementSettingID` (string | null, pattern `^-?[0-9]+$`) - `sendStatements` (string, one of "0", "1") - `holdDistributions` (string, pattern `^-?[0-9]+$`) - `holdDistributionsDescription` (string | null) - `isActive` (string, one of "0", "1") - `isLiveLedgerEnabled` (string | null, one of "0", "1", null) - `isBalanceNoticeDisabled` (string, one of "0", "1") - `dateTimeCreated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) - `isPublicStatementEnabled` (string, one of "0", "1") - `dateClosed` (string | null, date) - `postingSetting` (object | null): The posting setting for the ledger this charge is posted to. - `postingSettingID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `operatingAccountID` (string, pattern `^-?[0-9]+$`) - `escrowAccountID` (string, pattern `^-?[0-9]+$`) - `leaseRefundAccountID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `ledger` (object | null): The ledger this charge was posted to. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `restricted` (string): `"1"` if the current user cannot view this charge, `"0"` otherwise. - `payeeLedger` (object | null): The payee ledger associated with this charge. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `bankAccount` (object | null): Bank account used for payment (if includes=bankAccount). - `bankAccountID` (string | null, pattern `^-?[0-9]+$`) - `leaseCharges` (object[]): Tenant-responsible charge transactions (if includes=leaseCharges). - `transaction` (object): The accounting transaction record for this lease charge. - `transactionID` (string, pattern `^-?[0-9]+$`) - `transactionTypeID` (string, pattern `^-?[0-9]+$`) - `managementFeeMode` (string | null, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `contactID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountID` (string | null, pattern `^-?[0-9]+$`) - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `equityAccountID` (string | null, pattern `^-?[0-9]+$`) - `destinationBankAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountFilterTypeID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountID` (string | null, pattern `^-?[0-9]+$`) - `unallocatedAccountID` (string | null, pattern `^-?[0-9]+$`) - `payoutID` (string | null, pattern `^-?[0-9]+$`) - `payoutReturnID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `amountPaid` (string | null, decimal) - `amountAllocated` (string | null, decimal) - `processingFee` (string | null, decimal) - `convenienceFee` (string | null, decimal) - `convenienceFeeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `reference` (string | null) - `receivedFrom` (string | null) - `returnTransactionID` (string | null, pattern `^-?[0-9]+$`) - `returnTypeID` (string | null, pattern `^-?[0-9]+$`) - `returnDescription` (string | null) - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`) - `paymentTypeID` (string | null, pattern `^-?[0-9]+$`) - `billChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `billCreditTransactionID` (string | null, pattern `^-?[0-9]+$`) - `discountAmount` (string | null, decimal) - `markupAmount` (string | null, decimal) - `managementFeeAmountPaid` (string | null, decimal) - `isAdditionalManagementFee` (string | null, one of "0", "1", null) - `managementFeePercent` (string | null, decimal) - `isSuppressed` (string, one of "0", "1") - `managementFeeExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeePeriodDate` (string | null, date) - `managementFeeSalesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxAmountPaid` (string | null, decimal) - `managementFeeSalesTaxPercent` (string | null, decimal) - `managementFeeSalesTaxIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeBatchID` (string | null, pattern `^-?[0-9]+$`) - `isSalesTaxCharge` (string | null, one of "0", "1", null) - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `salesTaxInitiatedFromTransactionID` (string | null, pattern `^-?[0-9]+$`) - `isVoided` (string, one of "0", "1") - `bankAccountGatewayID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountGatewayTransactionID` (string | null) - `settlementID` (string | null, pattern `^-?[0-9]+$`) - `paymentAccountName` (string | null) - `paymentAccountNumberTruncated` (string | null) - `depositID` (string | null, pattern `^-?[0-9]+$`) - `reconciliationID` (string | null, pattern `^-?[0-9]+$`) - `previousReconciliationID` (string | null, pattern `^-?[0-9]+$`) - `achStatusID` (string | null, pattern `^-?[0-9]+$`) - `bankTransferID` (string | null, pattern `^-?[0-9]+$`) - `lateFeePeriod` (string | null, pattern `^-?[0-9]+$`) - `isFromManager` (string | null, one of "0", "1", null) - `isMoveInCharge` (string | null, one of "0", "1", null) - `isProrated` (string | null, one of "0", "1", null) - `isMoveOutTransaction` (string | null, one of "0", "1", null) - `moveOutAmount` (string | null, decimal) - `discountMarkupBillChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `recurringObjectID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxContactID` (string | null, pattern `^-?[0-9]+$`) - `datePosted` (string, date) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `property` (object | null): The property associated with the lease charge. - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyImageID` (string | null, pattern `^-?[0-9]+$`) - `propertyTypeID` (string | null, pattern `^-?[0-9]+$`) - `isMultiUnit` (string | null, one of "0", "1", null) - `isActive` (string | null, one of "0", "1", null) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSettingID` (string | null, pattern `^-?[0-9]+$`) - `name` (string | null) - `countryID` (string | null) - `address` (string | null) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `stateID` (string | null) - `city` (string | null) - `postalCode` (string | null) - `latitude` (string | null, decimal) - `longitude` (string | null, decimal) - `county` (string | null) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `legalDescription` (string | null) - `maintenanceLimitAmount` (string | null, decimal) - `yearBuilt` (string | null, pattern `^-?[0-9]+$`) - `dateTimeModified` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string | null, one of "0", "1", null) - `dateInsuranceExpires` (string | null, date) - `dateWarrantyExpires` (string | null, date) - `maintenanceNotes` (string | null) - `applicationTemplateID` (string | null, pattern `^-?[0-9]+$`) - `reserveAmount` (string | null, decimal) - `markupPercent` (string | null, decimal) - `markupAmount` (string | null, decimal) - `markupAmountMin` (string | null, decimal) - `markupAmountMax` (string | null, decimal) - `dateContractBegins` (string | null, date) - `dateContractEnds` (string | null, date) - `commercialClassTypeID` (string | null, pattern `^-?[0-9]+$`) - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`) - `insuranceCompany` (string | null) - `insuranceAgent` (string | null) - `insurancePolicyNumber` (string | null) - `insuranceContactDetails` (string | null) - `leaseReturnChargeAmount` (string | null, decimal) - `propertyShowingProviderID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `importSourceKey` (string | null) - `unit` (object | null): The unit associated with the lease charge. - `unitID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyImageID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string | null, one of "0", "1", null) - `name` (string | null) - `address` (string | null) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `stateID` (string | null) - `city` (string | null) - `postalCode` (string | null) - `latitude` (string | null, decimal) - `longitude` (string | null, decimal) - `rent` (string | null, decimal) - `deposit` (string | null, decimal) - `size` (string | null, pattern `^-?[0-9]+$`) - `beds` (string | null, pattern `^-?[0-9]+$`) - `fullBaths` (string | null, pattern `^-?[0-9]+$`) - `halfBaths` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `propertyManagerID` (string | null, pattern `^-?[0-9]+$`) - `commercialSpaceTypeID` (string | null, pattern `^-?[0-9]+$`) - `isNonRevenue` (string | null, one of "0", "1", null) - `nonRevenueTypeID` (string | null, pattern `^-?[0-9]+$`) - `nonRevenueStartDate` (string | null, date) - `isUtilityBillingEnabled` (string | null, one of "0", "1", null) - `isFromImport` (string | null, one of "0", "1", null) - `importSourceKey` (string | null) - `leaseNotes` (string | null) - `entryInstructions` (string | null) - `vendorEntryInstructions` (string | null) - `maintenanceNotes` (string | null) - `ledger` (object | null): The ledger the charge was posted to. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `restricted` (string): `"1"` if the current user cannot view this charge, `"0"` otherwise. - `payouts` (object[]): Payouts applied to this bill (if includes=payouts). - `workOrder` (object | null): Linked work order (if includes=workOrder). - `workOrderID` (string, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, pattern `^-?[0-9]+$`) - `workOrderProjectID` (string | null, pattern `^-?[0-9]+$`) - `recurringWorkOrderID` (string | null, pattern `^-?[0-9]+$`) - `isInternal` (string | null, one of "0", "1", null) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `vendorContactID` (string | null, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (string, pattern `^-?[0-9]+$`) - `workOrderStatusID` (string, pattern `^-?[0-9]+$`) - `vendorWorkOrderStatusID` (string | null, pattern `^-?[0-9]+$`) - `portalVendorWorkOrderStatusID` (string | null, pattern `^-?[0-9]+$`) - `vendorWorkOrderStatusUpdated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `priorityID` (string, pattern `^-?[0-9]+$`) - `sourceTypeID` (string | null, pattern `^-?[0-9]+$`) - `isOwnerApproved` (string, one of "0", "1") - `isVacant` (string, one of "0", "1") - `description` (string | null) - `diagnosticSummary` (object | null) - `aiSessionID` (string | null) - `isResolvedByRequestor` (string, one of "0", "1") - `vendorInstructions` (string | null) - `dateClosed` (string | null, date) - `closingDescription` (string | null) - `isSharedWithTenant` (string, one of "0", "1") - `isSharedWithOwner` (string, one of "0", "1") - `isNew` (string, one of "0", "1") - `createdByUserID` (string | null, pattern `^-?[0-9]+$`) - `closedByUserID` (string | null, pattern `^-?[0-9]+$`) - `cancelledByUserID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `modifiedByUserID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `inspectionID` (string | null, pattern `^-?[0-9]+$`) - `incidentLocation` (string | null) - `appointmentWindowStartDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isTenantPresenceRequired` (string | null, one of "0", "1", null) - `rejectedByVendorContactID` (string | null, pattern `^-?[0-9]+$`) - `vendorRejectReason` (string | null) - `vendorClosingComments` (string | null) - `orderIndex` (string, pattern `^-?[0-9]+$`) - `dateDue` (string | null, date) - `reviewID` (string | null, pattern `^-?[0-9]+$`) - `vendorAccessTypeID` (string | null, pattern `^-?[0-9]+$`) - `residentProvidedEntryInstructions` (string | null) - `entryInstructions` (string | null) - `isTenantFinanciallyResponsible` (string, one of "0", "1") - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `vendorTradeID` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `requestedByContactID` (string | null, pattern `^-?[0-9]+$`) - `estimatedAmount` (string | null, decimal) - `scheduledStartDate` (string | null, date) - `actualStartDate` (string | null, date) - `scheduledEndDate` (string | null, date) - `actualEndDate` (string | null, date) - `parentBill` (one of several shapes): The parent bill when this is a child discount/markup bill (if includes=parentBill). - One of: - Option 1: `bill` - Option 2: null - `discountBill` (one of several shapes): Associated discount bill (if includes=discountBill). - One of: - Option 1: `bill` - Option 2: null - `markupBill` (one of several shapes): Associated markup bill (if includes=markupBill). - One of: - Option 1: `bill` - Option 2: null - `markupDiscount` (object | null): Computed markup and discount totals (if includes=markupDiscount). - `discountAmount` (number) - `markupAmount` (number) - `utility` (object | null): Linked utility (if includes=utility). - `property` (object | null): Linked property (if includes=property). - `restrictions` (object): Access restrictions for the current user. - `access` (string): `"full"` when the user has full access to this bill. - `approvalRequirementType` (string | null): The type of approval requirement for this bill, if any. Example: ```json { "bill": { "billID": "15054", "billBatchID": null, "parentBillID": null, "payeeContactID": "67", "billTypeID": "1", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "123456", "paymentMemo": "test memo", "serviceAccountNumber": null, "description": "test description", "workOrderID": "5758", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "contact": { "contactID": "67", "contactTypeID": "3", "vendorTypeID": "9", "code": null, "name": "Walter's Windows", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "walter@rentvine.com", "phone": "+14436420607", "countryID": "US", "address": "9470 Corkscrew Palms Cir", "address2": null, "city": "Naples", "stateID": "FL", "postalCode": "33928", "birthDate": null, "defaultBillChargeAccountID": "37", "payeeName": null, "taxPayerName": "Walter's Windows", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "4", "otherPayoutTypeID": null, "achDetailsCiphertextID": "353", "achAccountNumberTruncated": "7324", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": "walker", "liabilityInsurancePolicyNumber": "232315-154852145-23", "liabilityInsuranceExpiresDate": "2024-02-18", "workersCompInsuranceName": "walter", "workersCompInsurancePolicyNumber": "1524458855", "workersCompInsuranceExpiresDate": "2024-03-27", "discountPercent": "10.0000", "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": "1", "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "1", "quickbooksCustomerName": "Walter's Windows", "invoiceAutofillTemplateID": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2025-11-07 21:37:00", "dateTimeDeactivated": null, "contactType": "Vendor" }, "charges": [ { "transaction": { "transactionID": "80853", "transactionTypeID": "7", "managementFeeMode": "2", "primaryLedgerID": "976", "portfolioID": "338", "propertyID": null, "unitID": null, "leaseID": null, "billID": "15054", "contactID": null, "bankAccountID": null, "chargeAccountID": "37", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "90.00", "amountPaid": "0.00", "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "test description", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": "0.00", "markupAmount": "0.00", "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-22", "dateTimeCreated": "2026-04-22 23:29:16", "dateTimeModified": "2026-04-22 23:29:16" }, "property": { "propertyID": null, "propertyImageID": null, "propertyTypeID": null, "isMultiUnit": null, "isActive": null, "portfolioID": null, "managementFeeSettingID": null, "name": null, "countryID": null, "address": null, "streetNumber": null, "streetName": null, "address2": null, "stateID": null, "city": null, "postalCode": null, "latitude": null, "longitude": null, "county": null, "assignedToUserID": null, "legalDescription": null, "maintenanceLimitAmount": null, "yearBuilt": null, "dateTimeModified": null, "dateTimeDeactivated": null, "isFromImport": null, "dateInsuranceExpires": null, "dateWarrantyExpires": null, "maintenanceNotes": null, "applicationTemplateID": null, "reserveAmount": null, "markupPercent": null, "markupAmount": null, "markupAmountMin": null, "markupAmountMax": null, "dateContractBegins": null, "dateContractEnds": null, "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": null, "insuranceAgent": null, "insurancePolicyNumber": null, "insuranceContactDetails": null, "leaseReturnChargeAmount": null, "propertyShowingProviderID": null, "dateTimeCreated": null, "importSourceKey": null }, "unit": { "unitID": null, "propertyID": null, "propertyImageID": null, "isActive": null, "name": null, "address": null, "streetNumber": null, "streetName": null, "address2": null, "stateID": null, "city": null, "postalCode": null, "latitude": null, "longitude": null, "rent": null, "deposit": null, "size": null, "beds": null, "fullBaths": null, "halfBaths": null, "leaseID": null, "dateTimeCreated": null, "dateTimeModified": null, "dateTimeDeactivated": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": null, "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": null, "isFromImport": null, "importSourceKey": null, "leaseNotes": null, "entryInstructions": null, "vendorEntryInstructions": null, "maintenanceNotes": null }, "portfolio": { "portfolioID": "338", "code": null, "name": "123 test", "contacts": [ { "contactID": "4330", "percentOwned": "100.0000", "percentDistributed": "100.0000", "name": "Shaina Kwiatkowsk" }, { "contactID": "4266", "percentOwned": "0.0000", "percentDistributed": "0.0000", "name": "07112025 Test Owner" } ], "postingSettingID": "1", "assignedToUserID": "501195", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "2500.00", "additionalReserveAmount": "1200.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "1000.00", "fiscalYearEndMonth": "12", "statementSettingID": "62", "sendStatements": "1", "holdDistributions": "1", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": "1", "isBalanceNoticeDisabled": "1", "dateTimeCreated": "2025-07-16 20:42:22", "dateTimeModified": "2026-04-07 17:33:25", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null }, "postingSetting": { "postingSettingID": "1", "name": "My Preferred Settings", "operatingAccountID": "31", "escrowAccountID": "32", "leaseRefundAccountID": "31", "isActive": "1" }, "ledger": { "ledgerID": "976", "ledgerTypeID": "2", "objectID": "338", "name": "123 test", "isActive": "1", "dateTimeCreated": "2025-07-16 20:42:22", "dateTimeModified": "2026-04-07 17:33:25" }, "restricted": "0", "payeeLedger": { "ledgerID": "976", "ledgerTypeID": "2", "objectID": "338", "name": "123 test", "isActive": "1", "dateTimeCreated": "2025-07-16 20:42:22", "dateTimeModified": "2026-04-07 17:33:25" } } ], "bankAccount": { "bankAccountID": "31" }, "leaseCharges": [ { "transaction": { "transactionID": "80856", "transactionTypeID": "1", "managementFeeMode": "2", "primaryLedgerID": "866", "portfolioID": "297", "propertyID": "601", "unitID": "583", "leaseID": "2991", "billID": "15054", "contactID": null, "bankAccountID": null, "chargeAccountID": "37", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "100.00", "amountPaid": "0.00", "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "test description", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": "0.00", "isAdditionalManagementFee": "0", "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": "0", "isProrated": "0", "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-22", "dateTimeCreated": "2026-04-22 23:29:16", "dateTimeModified": "2026-04-22 23:29:16" }, "property": { "propertyID": "601", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "297", "managementFeeSettingID": "93", "name": null, "countryID": "US", "address": "9910 Estero Oaks Drive", "streetNumber": "9910", "streetName": "Estero Oaks Drive", "address2": null, "stateID": "FL", "city": "Fort Myers", "postalCode": "33967", "latitude": "26.45128710", "longitude": "-81.79257720", "county": "Lee", "assignedToUserID": "539498", "legalDescription": null, "maintenanceLimitAmount": "500.00", "yearBuilt": null, "dateTimeModified": "2025-07-26 16:02:03", "dateTimeDeactivated": null, "isFromImport": "0", "dateInsuranceExpires": null, "dateWarrantyExpires": null, "maintenanceNotes": null, "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": null, "markupAmount": null, "markupAmountMin": null, "markupAmountMax": null, "dateContractBegins": "2025-07-18", "dateContractEnds": "2025-07-19", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": null, "insuranceAgent": null, "insurancePolicyNumber": null, "insuranceContactDetails": null, "leaseReturnChargeAmount": null, "propertyShowingProviderID": null, "dateTimeCreated": "2025-07-26 15:58:44", "importSourceKey": null }, "unit": { "unitID": "583", "propertyID": "601", "propertyImageID": "1", "isActive": "1", "name": null, "address": "9910 Estero Oaks Drive", "streetNumber": "9910", "streetName": "Estero Oaks Drive", "address2": null, "stateID": "FL", "city": "Fort Myers", "postalCode": "33967", "latitude": "26.45128710", "longitude": "-81.79257720", "rent": "12.00", "deposit": "13.00", "size": "1500", "beds": "5", "fullBaths": "6", "halfBaths": "0", "leaseID": "2776", "dateTimeCreated": "2025-07-26 15:58:44", "dateTimeModified": "2025-12-08 17:40:53", "dateTimeDeactivated": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "isFromImport": "0", "importSourceKey": null, "leaseNotes": null, "entryInstructions": null, "vendorEntryInstructions": null, "maintenanceNotes": null }, "ledger": { "ledgerID": "866", "ledgerTypeID": "2", "objectID": "297", "name": "WalterDeVeasTestPortfolio", "isActive": "1", "dateTimeCreated": "2025-04-14 20:49:15", "dateTimeModified": "2025-09-25 21:06:37" }, "restricted": "0" } ], "payouts": [], "workOrder": { "workOrderID": "5758", "workOrderNumber": "105585", "workOrderProjectID": null, "recurringWorkOrderID": "48", "isInternal": "0", "propertyID": "565", "unitID": "546", "leaseID": "2554", "vendorContactID": null, "primaryWorkOrderStatusID": "4", "workOrderStatusID": "27", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "1", "vendorWorkOrderStatusUpdated": null, "priorityID": "2", "sourceTypeID": "6", "isOwnerApproved": "0", "isVacant": "0", "description": "

sfgsf

", "diagnosticSummary": null, "aiSessionID": null, "isResolvedByRequestor": "0", "vendorInstructions": null, "dateClosed": null, "closingDescription": null, "isSharedWithTenant": "0", "isSharedWithOwner": "0", "isNew": "1", "createdByUserID": "1", "closedByUserID": null, "cancelledByUserID": null, "dateTimeCreated": "2026-02-20 05:20:00", "modifiedByUserID": "501195", "dateTimeModified": "2026-04-22 23:29:16", "inspectionID": null, "incidentLocation": null, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null, "isTenantPresenceRequired": "0", "rejectedByVendorContactID": null, "vendorRejectReason": null, "vendorClosingComments": null, "orderIndex": "0", "dateDue": null, "reviewID": null, "vendorAccessTypeID": "3", "residentProvidedEntryInstructions": null, "entryInstructions": null, "isTenantFinanciallyResponsible": "0", "portfolioID": "312", "vendorTradeID": null, "assignedToUserID": null, "requestedByContactID": null, "estimatedAmount": null, "scheduledStartDate": null, "actualStartDate": null, "scheduledEndDate": null, "actualEndDate": null }, "parentBill": null, "discountBill": { "billID": "15055", "billBatchID": null, "parentBillID": "15054", "payeeContactID": "1", "billTypeID": "2", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "123456", "paymentMemo": "test memo", "serviceAccountNumber": null, "description": null, "workOrderID": "5758", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "1", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "markupBill": { "billID": "15056", "billBatchID": null, "parentBillID": "15054", "payeeContactID": "1", "billTypeID": "2", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "123456", "paymentMemo": "test memo", "serviceAccountNumber": null, "description": null, "workOrderID": "5758", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "1", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "markupDiscount": { "discountAmount": 10, "markupAmount": 10 }, "utility": null, "property": null, "restrictions": { "access": "full" }, "approvalRequirementType": null } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Bill `POST /accounting/bills/{billID}` Operation ID: `updateBill` Updates an existing bill. All fields are optional — only the fields provided in the request body are changed. Charges are matched by `transactionID`. ##### Use Cases - Correct bill details such as the payee, dates, reference number, or memo. - Adjust charge line amounts, discounts, or markup values. - Link or change the associated work order. - Update utility billing period dates or service account number. ##### Business Rules - The bill must not be voided. Voided bills cannot be updated. - Each entry in `charges` must include `transactionID` to identify the charge being updated. ##### Available Includes (4+) Pass a comma-separated list of include names in the `includes` query parameter. | Include name | What it adds | | ------------ | --------------------------------------------------- | | `charges` | Updated charge lines with full transaction details. | | `contact` | Full payee contact record. | | `payouts` | Payouts applied toward this bill. | | `workOrder` | The linked work order, if any. | ##### Related Endpoints - `GET /accounting/bills/{billID}` - Retrieve the updated bill. - `POST /accounting/bills` - Create a new bill. - `DELETE /accounting/bills/{billID}` - Void a bill. Parameters: - `billID` (path, integer, required) - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `charges`, `contact`, `payouts`, `workOrder`. Request body, required: - `application/json`: `bill_update` Example: ```json { "payeeContactID": 21, "billDate": "2026-04-22", "dateDue": "2026-04-22", "amount": 0, "discountPercent": 0, "markupPercent": 0, "bankAccountID": 216, "reference": "123456", "paymentMemo": "test memo", "description": "test description", "workOrderID": 5954, "charges": [ { "transactionID": 80486, "amount": "2.00", "discountAmount": "0.00", "markupAmount": "0.00", "ledgerID": 297, "chargeAccountID": 66, "description": "test description" } ], "serviceAccountNumber": "0001", "utilityPeriodStartDate": "2026-04-22", "utilityPeriodEndDate": "2027-04-22" } ``` Responses: - `200`: Bill successfully updated. - `application/json`: object - `bill` (`bill`, required) - `contact` (object | null): Payee contact details (if includes=contact). - `contactID` (string, pattern `^-?[0-9]+$`) - `contactTypeID` (string, pattern `^-?[0-9]+$`) - `vendorTypeID` (string | null, pattern `^-?[0-9]+$`) - `code` (string | null) - `name` (string) - `firstName` (string | null) - `middleName` (string | null) - `lastName` (string | null) - `suffix` (string | null) - `email` (string | null, email) - `phone` (string | null) - `countryID` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `payeeName` (string | null) - `taxPayerName` (string | null) - `taxFormTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationNumber` (string | null) - `identificationCountryID` (string | null) - `identificationIssuingLocation` (string | null) - `identificationExpirationDate` (string | null, date) - `payoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `otherPayoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `achDetailsCiphertextID` (string | null, pattern `^-?[0-9]+$`) - `achAccountNumberTruncated` (string | null) - `achAccountTypeID` (string | null, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | null, decimal) - `discountAmount` (string | null, decimal) - `discountAmountMin` (string | null, decimal) - `discountAmountMax` (string | null, decimal) - `discountGraceDays` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `isInsuranceRequiredForPayment` (string | null, one of "0", "1", null) - `maxLineItemsOnPayment` (string | null, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) - `websiteUrl` (string | null, uri) - `applicantID` (string | null, pattern `^-?[0-9]+$`) - `ownerPortalNameOverride` (string | null) - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `quickbooksCustomerName` (string | null) - `invoiceAutofillTemplateID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string): Human-readable label for the contact type (e.g. `"Vendor"`, `"Manager"`). - `charges` (object[]): Updated charge line items with full transaction details (if includes=charges). - `transaction` (object): The accounting transaction for this charge. - `transactionID` (string, pattern `^-?[0-9]+$`) - `transactionTypeID` (string, pattern `^-?[0-9]+$`) - `managementFeeMode` (string | null, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `contactID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountID` (string | null, pattern `^-?[0-9]+$`) - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `amountPaid` (string | null, decimal) - `amountAllocated` (string | null, decimal) - `description` (string | null) - `discountAmount` (string | null, decimal) - `markupAmount` (string | null, decimal) - `isSuppressed` (string, one of "0", "1") - `isVoided` (string, one of "0", "1") - `datePosted` (string, date) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `property` (object | null): The property associated with this charge. - `propertyID` (string, pattern `^-?[0-9]+$`) - `propertyTypeID` (string | null, pattern `^-?[0-9]+$`) - `isMultiUnit` (string, one of "0", "1") - `isActive` (string, one of "0", "1") - `portfolioID` (string, pattern `^-?[0-9]+$`) - `address` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `unit` (object | null): The unit associated with this charge, if any. - `unitID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string | null, one of "0", "1", null) - `name` (string | null) - `address` (string | null) - `portfolio` (object | null): The portfolio associated with this charge. - `portfolioID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `contacts` (object[] | null): Owner contacts and their ownership/distribution percentages. - `contactID` (string, pattern `^-?[0-9]+$`) - `percentOwned` (string, decimal) - `percentDistributed` (string, decimal) - `name` (string) - `isActive` (string, one of "0", "1") - `postingSetting` (object | null): The posting setting for the ledger this charge is posted to. - `postingSettingID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `operatingAccountID` (string, pattern `^-?[0-9]+$`) - `escrowAccountID` (string, pattern `^-?[0-9]+$`) - `leaseRefundAccountID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `ledger` (object | null): The ledger this charge was posted to. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `restricted` (string): `"1"` if the current user cannot view this charge, `"0"` otherwise. - `payeeLedger` (object | null): The payee ledger associated with this charge. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `payouts` (object[]): Payouts applied to this bill (if includes=payouts). - `workOrder` (object | null): Linked work order (if includes=workOrder). - `workOrderID` (string, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, pattern `^-?[0-9]+$`) - `workOrderProjectID` (string | null, pattern `^-?[0-9]+$`) - `recurringWorkOrderID` (string | null, pattern `^-?[0-9]+$`) - `isInternal` (string | null, one of "0", "1", null) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `vendorContactID` (string | null, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (string, pattern `^-?[0-9]+$`) - `workOrderStatusID` (string, pattern `^-?[0-9]+$`) - `vendorWorkOrderStatusID` (string | null, pattern `^-?[0-9]+$`) - `priorityID` (string, pattern `^-?[0-9]+$`) - `description` (string | null) - `isOwnerApproved` (string, one of "0", "1") - `isVacant` (string, one of "0", "1") - `isSharedWithTenant` (string, one of "0", "1") - `isSharedWithOwner` (string, one of "0", "1") - `createdByUserID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) Example: ```json { "bill": { "billID": "15106", "billBatchID": null, "parentBillID": null, "payeeContactID": "67", "billTypeID": "1", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "Plumbing invoice April", "serviceAccountNumber": null, "description": "Bathroom plumbing repair", "workOrderID": null, "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "512915", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "contact": { "contactID": "21", "contactTypeID": "3", "vendorTypeID": "10", "code": "Water", "name": "1st General Contractor", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "vasco@rentvine.com", "phone": null, "countryID": "US", "address": "70 Hillcroft St", "address2": null, "city": "Spring", "stateID": "FL", "postalCode": "33928", "birthDate": null, "defaultBillChargeAccountID": "71", "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "4", "otherPayoutTypeID": null, "achDetailsCiphertextID": "69", "achAccountNumberTruncated": "3587", "achAccountTypeID": "2", "achIsCorporateAccount": "1", "holdPayments": "0", "liabilityInsuranceName": "Progressive", "liabilityInsurancePolicyNumber": "u213ffhsicr", "liabilityInsuranceExpiresDate": "2025-07-23", "workersCompInsuranceName": "None on File", "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": "2024-07-02", "discountPercent": "20.0000", "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": "10", "isActive": "1", "isInsuranceRequiredForPayment": "1", "maxLineItemsOnPayment": "10", "preventConsolidatedPayments": "0", "isFromImport": "1", "importSourceKey": "11", "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": "TT", "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "1", "isQuickbooksExportEnabled": "1", "quickbooksCustomerName": "1st General", "invoiceAutofillTemplateID": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-04-10 14:36:47", "dateTimeDeactivated": null, "contactType": "Vendor" }, "charges": [ { "transaction": { "transactionID": "80486", "transactionTypeID": "7", "managementFeeMode": "2", "primaryLedgerID": "2", "portfolioID": "1", "propertyID": "170", "unitID": null, "leaseID": null, "billID": "15026", "contactID": null, "bankAccountID": null, "chargeAccountID": "66", "amount": "2.00", "amountPaid": "0.00", "amountAllocated": null, "description": "test description", "discountAmount": "0.00", "markupAmount": "0.00", "isSuppressed": "0", "isVoided": "0", "datePosted": "2026-04-22", "dateTimeCreated": "2026-04-22 04:15:16", "dateTimeModified": "2026-04-22 22:51:52" }, "property": { "propertyID": "170", "propertyTypeID": "6", "isMultiUnit": "1", "isActive": "1", "portfolioID": "1", "address": "2001 Blake Street", "city": "Denver", "stateID": "CO", "postalCode": "80205" }, "unit": { "unitID": null, "propertyID": null, "isActive": null, "name": null, "address": null }, "portfolio": { "portfolioID": "1", "name": "Amanda LLC", "contacts": [ { "contactID": "2", "percentOwned": "75.0000", "percentDistributed": "100.0000", "name": "Amanda H. Wilson" }, { "contactID": "4471", "percentOwned": "25.0000", "percentDistributed": "0.0000", "name": "chris" } ], "isActive": "1" }, "postingSetting": { "postingSettingID": "1", "name": "My Preferred Settings", "operatingAccountID": "31", "escrowAccountID": "32", "leaseRefundAccountID": "31", "isActive": "1" }, "ledger": { "ledgerID": "2", "ledgerTypeID": "2", "objectID": "1", "name": "Amanda LLC", "isActive": "1", "dateTimeCreated": "2023-09-29 23:46:23", "dateTimeModified": "2026-03-26 13:49:41" }, "restricted": "0", "payeeLedger": { "ledgerID": "297", "ledgerTypeID": "3", "objectID": "170", "name": "2001 Blake Street, Denver, CO 80205", "isActive": "1", "dateTimeCreated": "2023-09-29 23:46:23", "dateTimeModified": "2024-06-10 14:31:36" } } ], "payouts": [], "workOrder": { "workOrderID": "5954", "workOrderNumber": "105781", "workOrderProjectID": null, "recurringWorkOrderID": null, "isInternal": "0", "propertyID": "630", "unitID": "607", "leaseID": "2746", "vendorContactID": "3381", "primaryWorkOrderStatusID": "2", "workOrderStatusID": "1", "vendorWorkOrderStatusID": "2", "priorityID": "2", "description": "

    c

", "isOwnerApproved": "0", "isVacant": "0", "isSharedWithTenant": "1", "isSharedWithOwner": "1", "createdByUserID": "1", "dateTimeCreated": "2026-04-22 17:39:33", "dateTimeModified": "2026-04-22 17:39:49", "portfolioID": "359", "assignedToUserID": "381140" } } ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Void Bill `DELETE /accounting/bills/{billID}` Operation ID: `voidBill` Voids a bill, reversing its accounting impact. The bill remains in the system with `isVoided: "1"` and cannot be deleted. ##### Use Cases - Cancel a bill entered in error before any payments are applied. - Void a bill and simultaneously void its linked discount or markup child bills. ##### Business Rules - **A bill cannot be voided if any payments have been applied to it.** If transactions exist against the bill, the void will be rejected. Unapply or reverse any payments before attempting to void. - **Linked discount/markup bills:** When a bill is created with a discount or markup, companion child bills (`discountBill`, `markupBill`) are generated automatically. To void those companion bills at the same time, set `voidLinkedBills: true` in the request body. If omitted or `false`, only the parent bill is voided. ##### Available Includes (12+) The void response supports the same includes as `GET /accounting/bills/{billID}`. Pass a comma-separated list in the `includes` query parameter. | Include name | What it adds | | ---------------- | ----------------------------------------------------------------------- | | `contact` | Full payee contact record (vendor/owner details, ACH info, insurance). | | `charges` | Line-item charges posted to ledgers for this bill. | | `bankAccount` | The bank account used to pay this bill. | | `leaseCharges` | Tenant-responsible charge transactions, each with property/unit/ledger. | | `payouts` | Payouts that have been applied toward this bill. | | `workOrder` | The linked work order, if any. | | `parentBill` | The parent bill when this is a discount or markup child bill. | | `discountBill` | The associated discount bill (voided when `voidLinkedBills: true`). | | `markupBill` | The associated markup bill (voided when `voidLinkedBills: true`). | | `markupDiscount` | Computed markup and discount dollar amounts for the bill. | | `utility` | The utility associated with this bill, if any. | | `property` | The property associated with this bill, if any. | ##### Related Endpoints - `GET /accounting/bills/{billID}` - Retrieve a bill and its current state. - `POST /accounting/bills` - Create a new bill. Parameters: - `billID` (path, integer, required) - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `contact`, `charges`, `bankAccount`, `leaseCharges`, `payouts`, `workOrder`, `parentBill`, `discountBill`, `markupBill`, `markupDiscount`, `utility`, `property`. Request body: - `application/json`: object - `voidLinkedBills` (boolean): When `true`, any discount and/or markup child bills linked to this bill are also voided in the same operation. When `false` or omitted, only the parent bill is voided. Example: ```json { "voidLinkedBills": true } ``` Responses: - `200`: Bill successfully voided. - `application/json`: object - `bill` (`bill`, required) - `contact` (object | null): Payee contact details (if includes=contact). - `contactID` (string, pattern `^-?[0-9]+$`) - `contactTypeID` (string, pattern `^-?[0-9]+$`) - `vendorTypeID` (string | null, pattern `^-?[0-9]+$`) - `name` (string) - `firstName` (string | null) - `lastName` (string | null) - `email` (string | null, email) - `phone` (string | null) - `countryID` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `payoutTypeID` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `holdPayments` (string, pattern `^-?[0-9]+$`) - `discountPercent` (string | null, decimal) - `isBillApprovalExempt` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string) - `charges` (object[]): Ledger charge lines (if includes=charges). - `bankAccount` (object | null): Bank account used for payment (if includes=bankAccount). - `bankAccountID` (string | null, pattern `^-?[0-9]+$`) - `leaseCharges` (object[]): Tenant-responsible charge transactions (if includes=leaseCharges). - `transaction` (object): The accounting transaction record for this lease charge. - `transactionID` (string, pattern `^-?[0-9]+$`) - `transactionTypeID` (string, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `amountPaid` (string | null, decimal) - `description` (string | null) - `isVoided` (string, one of "0", "1") - `datePosted` (string, date) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `property` (object | null): The property associated with the lease charge. - `unit` (object | null): The unit associated with the lease charge. - `ledger` (object | null): The ledger the charge was posted to. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `restricted` (string): `"1"` if the current user cannot view this charge, `"0"` otherwise. - `payouts` (object[]): Payouts applied to this bill (if includes=payouts). - `workOrder` (object | null): Linked work order (if includes=workOrder). - `workOrderID` (string, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `vendorContactID` (string | null, pattern `^-?[0-9]+$`) - `workOrderStatusID` (string, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (string, pattern `^-?[0-9]+$`) - `priorityID` (string, pattern `^-?[0-9]+$`) - `description` (string | null) - `isVacant` (string, one of "0", "1") - `isSharedWithTenant` (string, one of "0", "1") - `isSharedWithOwner` (string, one of "0", "1") - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `parentBill` (`bill`) - `discountBill` (one of several shapes): The companion discount bill linked to this bill, if any. Voided alongside the parent when `voidLinkedBills: true`. - One of: - Option 1: `bill` - Option 2: null - `markupBill` (one of several shapes): The companion markup bill linked to this bill, if any. Voided alongside the parent when `voidLinkedBills: true`. - One of: - Option 1: `bill` - Option 2: null - `markupDiscount` (object | null): Computed markup and discount totals (if includes=markupDiscount). - `discountAmount` (number) - `markupAmount` (number) - `utility` (object | null): Linked utility (if includes=utility). - `property` (object | null): Linked property (if includes=property). Example: ```json { "bill": { "billID": "15051", "billBatchID": null, "parentBillID": null, "payeeContactID": "67", "billTypeID": "1", "bankAccountID": "146", "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "test", "serviceAccountNumber": null, "description": "test description", "workOrderID": "5815", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "1", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "contact": { "contactID": "67", "contactTypeID": "3", "vendorTypeID": "9", "name": "Walter's Windows", "firstName": null, "lastName": null, "email": "walter@rentvine.com", "phone": "+14436420607", "countryID": "US", "address": "9470 Corkscrew Palms Cir", "address2": null, "city": "Naples", "stateID": "FL", "postalCode": "33928", "payoutTypeID": "4", "isActive": "1", "holdPayments": "0", "discountPercent": "10.0000", "isBillApprovalExempt": "0", "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2025-11-07 21:37:00", "contactType": "Vendor" }, "charges": [], "bankAccount": { "bankAccountID": null }, "leaseCharges": [ { "transaction": { "transactionID": "80842", "transactionTypeID": "1", "leaseID": "2963", "billID": "15051", "chargeAccountID": "37", "amount": "100.00", "amountPaid": "0.00", "description": "test description", "isVoided": "0", "datePosted": "2026-04-22", "dateTimeCreated": "2026-04-22 21:59:34", "dateTimeModified": "2026-04-22 21:59:34" }, "property": { "propertyID": "601", "address": "9910 Estero Oaks Drive", "city": "Fort Myers", "stateID": "FL", "postalCode": "33967", "isActive": "1" }, "unit": { "unitID": "583", "propertyID": "601", "address": "9910 Estero Oaks Drive", "city": "Fort Myers", "stateID": "FL", "isActive": "1" }, "ledger": { "ledgerID": "866", "ledgerTypeID": "2", "objectID": "297", "name": "WalterDeVeasTestPortfolio", "isActive": "1" }, "restricted": "0" } ], "payouts": [], "workOrder": { "workOrderID": "5815", "workOrderNumber": "105642", "propertyID": "495", "unitID": "474", "leaseID": "2162", "vendorContactID": null, "workOrderStatusID": "27", "primaryWorkOrderStatusID": "4", "priorityID": "2", "description": "

test

", "isVacant": "0", "isSharedWithTenant": "1", "isSharedWithOwner": "1", "dateTimeCreated": "2026-03-17 18:26:08", "dateTimeModified": "2026-04-22 21:59:34" }, "parentBill": null, "discountBill": { "billID": "15052", "billBatchID": null, "parentBillID": "15051", "payeeContactID": "1", "billTypeID": "2", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "test", "serviceAccountNumber": null, "description": null, "workOrderID": "5815", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "1", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "1", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "markupBill": { "billID": "15053", "billBatchID": null, "parentBillID": "15051", "payeeContactID": "1", "billTypeID": "2", "bankAccountID": null, "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "test", "serviceAccountNumber": null, "description": null, "workOrderID": "5815", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "1", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "1", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": null, "utilityPeriodEndDate": null, "importAccountCommitID": null }, "markupDiscount": { "discountAmount": 0, "markupAmount": 0 }, "utility": null, "property": null } ``` - `400`: Cannot void the bill. - `application/json`: object - `error` (string) Example: ```json { "error": "Cannot void bill - transactions have been paid against this bill." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Approve Bill `POST /accounting/bills/{billID}/approve` Operation ID: `approveBill` Approves a bill, marking it as authorized for payment. Once approved, the bill's `isApproved` flag is set to `1` and `approvedByUserID` is recorded. ##### Use Cases - Authorize a vendor bill before it can be included in a payment batch. - Complete a two-step approval workflow where bills are created and reviewed before payment. - Fulfill a master-level approval when a bill's total exceeds a configured threshold. ##### Business Rules - Requires the **ApproveBill** permission (`Accounting` component). - If the bill total meets or exceeds the account's master-approval threshold, the **ApproveBillMaster** permission is also required. - The bill must exist. A `400` is returned if the `billID` is not found. - The caller must have full access to the bill under the account's restrictions policy. - On success the response is identical to `GET /accounting/bills/{billID}` — the same `includes` query parameter is supported. ##### Related Endpoints - `GET /accounting/bills/{billID}` - Retrieve a bill and its current approval state. - `POST /accounting/bills` - Create a bill. - `POST /accounting/bills/{billID}` - Update a bill. - `DELETE /accounting/bills/{billID}` - Void a bill. Parameters: - `billID` (path, integer, required) - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `contact`, `charges`, `bankAccount`, `leaseCharges`, `payouts`, `workOrder`, `parentBill`, `discountBill`, `markupBill`, `markupDiscount`, `utility`, `property`. Responses: - `200`: Bill successfully approved. - `application/json`: object - `bill` (`bill`, required) Example: ```json { "bill": { "billID": "14973", "billBatchID": null, "parentBillID": null, "payeeContactID": "1", "billTypeID": "1", "bankAccountID": "170", "billDate": "2026-04-22", "dateDue": "2026-04-22", "reference": "12345", "paymentMemo": "test memo", "serviceAccountNumber": "0001", "description": "test description", "workOrderID": "5954", "discountPercent": "0.0000", "markupPercent": "0.0000", "isVoided": "0", "isApproved": "1", "approvedByUserID": "501195", "managementFeeBatchID": null, "isDiscount": "0", "isMarkup": "0", "managementFeeMode": "2", "propertyID": null, "utilityID": null, "utilityPeriodStartDate": "2026-04-22", "utilityPeriodEndDate": "2027-04-22", "importAccountCommitID": null } } ``` - `400`: Bill could not be approved. - `application/json`: object - `error` (string) Example: ```json { "error": "Bill 14973 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Print Bill PDF `GET /accounting/bills/{billID}/print` Operation ID: `printBill` Renders a bill as a PDF document and streams the binary content directly in the response body. The PDF is generated from the bill's data and rendered using the portfolio's branding/letterhead when a `portfolioID` is provided. ##### Use Cases - Download a printable copy of a bill to send to a vendor or attach to a work order. - Generate a PDF receipt for a paid bill for record-keeping or audit purposes. - Produce a branded bill PDF using a specific portfolio's letterhead. ##### Business Rules - The bill must exist; if `{billID}` does not match any bill, a `400` error is returned. - The `portfolioID` query parameter is optional. When omitted, the PDF is rendered without portfolio-specific branding. - The response content type is `application/pdf`. Clients should treat the body as a binary stream, not JSON. ##### Related Endpoints - `GET /accounting/bills/{billID}` - Retrieve bill data as JSON. - `GET /accounting/bills` - List all bills. Parameters: - `billID` (path, integer, required): Unique identifier of the bill to print. - `portfolioID` (query, integer): Portfolio ID used to apply branded letterhead/styling to the rendered PDF. Responses: - `200`: PDF of the bill streamed as binary content. - `application/pdf`: string, binary - `400`: Bill not found. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Bill 15054 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Payables `GET /accounting/payables/search` Operation ID: `searchPayables` Returns a paginated list of payable transactions (bill charges) with joined bill, ledger, portfolio, property, unit, and payee contact data. Each result row represents one transaction line from a bill, so a multi-line bill produces multiple rows. ##### Use Cases - Build a payables queue filtered by approval status, due date, or payee vendor. - Find all open (unpaid) charges across a set of properties or portfolios. - Identify bills that require master approval because their total meets or exceeds the configured approval threshold. - Export payables data for reconciliation against an external AP system. ##### Business Rules - Results are restricted to the authenticated user's accessible portfolios. Charges on portfolios outside the user's access are automatically excluded. - The `isPaid` filter compares `amountPaid` to `amount`. A transaction where `amountPaid < amount` is unpaid (`isPaid=false`); a transaction where `amountPaid = amount` is fully paid (`isPaid=true`). Partially-paid charges always appear when `isPaid=false`. - `requiresMasterApproval=true` only has effect when a Bill Approval Maximum Threshold is configured in Accounting Settings. It matches unapproved **parent** bills whose total charge amount meets or exceeds that threshold. Child bills are excluded from this filter (they defer to their parent's approval state). - Both singular and plural variants of ID array parameters are accepted (`payeeContactID` / `payeeContactIDs`, `portfolioID` / `portfolioIDs`, `propertyID` / `propertyIDs`, `unitID` / `unitIDs`). Pass multiple values as a comma-separated string: `propertyIDs=101,102,103`. - Default sort is `transaction.datePosted` descending. Append `|asc` or `|desc` to any `orderBy` value to control direction (e.g. `orderBy=transaction.amount|asc`). ##### Related Endpoints - `GET /accounting/bills` - List bills (bill-level, not transaction-level). - `GET /accounting/bills/{billID}` - Retrieve a single bill with full detail and includes. - `GET /accounting/payables` - Simple bill-charge list with account and vendor includes. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Full-text search applied across multiple fields. Matches any transaction or bill where the search string appears in: - `transaction.description` - `ledger.name` - `portfolio.name` - `property.address` - `bill.reference` - `contact.name` (payee) Also matches rows where `transaction.amount` equals the search string exactly (useful for looking up a specific dollar amount). - `isVoided` (query, boolean): Filter by voided status of the transaction. - `false` — return only active (non-voided) transactions. - `true` — return only voided transactions. Omit to return both. - `isApproved` (query, boolean): Filter by the bill's approval status. - `false` — unapproved bills only. - `true` — approved bills only. Omit to return both. - `isPaid` (query, boolean): Filter by payment status of the transaction. - `false` — open charges where `amountPaid < amount`. - `true` — fully paid charges where `amountPaid = amount`. Omit to return both paid and unpaid. - `amountMin` (query, number, double): Return only transactions where `amount` is greater than or equal to this value. - `amountMax` (query, number, double): Return only transactions where `amount` is less than or equal to this value. - `datePostedMin` (query, string, date): Return only transactions posted on or after this date (`transaction.datePosted`). Format: `YYYY-MM-DD`. - `datePostedMax` (query, string, date): Return only transactions posted on or before this date (`transaction.datePosted`). Format: `YYYY-MM-DD`. - `billDateMin` (query, string, date): Return only transactions whose bill date (`bill.billDate`) is on or after this date. Format: `YYYY-MM-DD`. - `billDateMax` (query, string, date): Return only transactions whose bill date (`bill.billDate`) is on or before this date. Format: `YYYY-MM-DD`. - `dateDueMin` (query, string, date): Return only transactions whose bill due date (`bill.dateDue`) is on or after this date. Format: `YYYY-MM-DD`. - `dateDueMax` (query, string, date): Return only transactions whose bill due date (`bill.dateDue`) is on or before this date. Format: `YYYY-MM-DD`. - `ledgerTypeID` (query, `ledger_types_request`): Return only transactions posted to ledgers of this type. - `payeeContactIDs` (query, string): Comma-separated list of payee contact IDs to filter by. Also accepted as singular `payeeContactID` for a single value. Example: `payeeContactIDs=200,201,215` - `portfolioIDs` (query, string): Comma-separated list of portfolio IDs to filter by. Also accepted as singular `portfolioID` for a single value. Example: `portfolioIDs=50,51` - `propertyIDs` (query, string): Comma-separated list of property IDs to filter by. Also accepted as singular `propertyID` for a single value. Example: `propertyIDs=101,102,103` - `unitIDs` (query, string): Comma-separated list of unit IDs to filter by. Also accepted as singular `unitID` for a single value. Example: `unitIDs=310,311` - `requiresMasterApproval` (query, boolean): When `true`, return only unapproved parent bills whose total charge amount meets or exceeds the Bill Approval Maximum Threshold configured in Accounting Settings. Child bills are excluded. Has no effect if no threshold is configured. - `orderBy` (query, string): Sort the results by a specific column. Append `|asc` or `|desc` to control direction. Default: `transaction.datePosted|desc`. **Sortable columns:** - `bill.billDate` - `bill.dateDue` - `bill.reference` - `contact.name` - `ledger.name` - `property.name` - `transaction.datePosted` - `transaction.amount` - `transaction.amountPaid` Responses: - `200`: Successfully retrieved payables. - `application/json`: object[] - Each item: - `bill` (object, required): The parent bill record for this transaction line. - `billID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique bill identifier. - `parentBillID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the parent bill if this is a child (markup/discount) bill. - `billDate` (string, date, required): The date the bill was entered. - `dateDue` (string, date, required): The date payment is due. - `reference` (string | null): Invoice or reference number from the vendor. - `isVoided` (string, required, one of "0", "1"): `1` if the bill has been voided, `0` otherwise. - `description` (string | null): Optional description for the bill. - `payeeContactID` (string, required, pattern `^-?[0-9]+$`): Contact ID of the vendor or payee. - `isApproved` (string, required, one of "0", "1"): `1` if the bill has been approved for payment, `0` otherwise. - `requiresMasterApproval` (string, required, one of "0", "1"): `1` if this bill is unapproved and its total charge amount meets or exceeds the configured Bill Approval Maximum Threshold. Always `0` for child bills or when no threshold is configured. Computed in SQL, so a string like a column. - `transaction` (object, required): The individual transaction (bill charge line) for this row. - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique transaction identifier. - `transactionTypeID` (string, required, pattern `^-?[0-9]+$`): Always `5` (BillCharge) for payables search results. - `billID` (string | null, required, pattern `^-?[0-9]+$`): The bill this transaction belongs to. - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): The ledger charged by this transaction. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): The chart-of-accounts account used for this charge. - `amount` (string, decimal, required): The gross charge amount (decimal encoded as string). - `amountPaid` (string | null, decimal, required): The amount already paid toward this transaction. - `description` (string | null): Line-item description for this transaction. - `discountAmount` (string | null, decimal): Discount applied to this line item. - `markupAmount` (string | null, decimal): Markup applied to this line item. - `isVoided` (string, required, one of "0", "1"): `1` if this transaction line has been voided, `0` otherwise. - `datePosted` (string, date, required): The date the transaction was posted to the ledger. - `ledger` (object, required): The ledger (property, portfolio, or manager account) charged. - `ledgerID` (string, required, read-only, pattern `^-?[0-9]+$`) - `name` (string, required): Display name of the ledger. - `ledgerTypeID` (`ledger_types`, required) - `portfolio` (object | null): The portfolio associated with the transaction. May be null if the ledger is not portfolio-linked. - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `name` (string | null): Portfolio name. - `contacts` (string | null): Serialized contact associations for the portfolio. - `property` (object | null): The property associated with the transaction. May be null for manager-level charges. - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `name` (string | null): Property name. - `propertyTypeID` (string | null, pattern `^-?[0-9]+$`) - `isMultiUnit` (string | null, one of "0", "1", null): `1` if the property has multiple units. - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `unit` (object | null): The unit associated with the transaction. Null when the charge is at the property or portfolio level. - `unitID` (string | null, pattern `^-?[0-9]+$`) - `unitName` (string | null) - `unitAddress` (string | null) - `unitAddress2` (string | null) - `unitCity` (string | null) - `unitStateID` (string | null) - `unitPostalCode` (string | null) - `contact` (object, required): The payee contact (vendor or other payee) for the bill. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`): Identifies the contact type (e.g. `4` = Vendor). - `name` (string, required): Full display name of the contact. Example: ```json [ { "bill": { "billID": "14201", "parentBillID": null, "billDate": "2026-03-15", "dateDue": "2026-04-15", "reference": "INV-20260315", "isVoided": "0", "description": "HVAC repair - Unit 4B", "payeeContactID": "200", "isApproved": "0", "requiresMasterApproval": "1" }, "transaction": { "transactionID": "88432", "transactionTypeID": "5", "billID": "14201", "primaryLedgerID": "960", "chargeAccountID": "37", "amount": "350.00", "amountPaid": "0.00", "description": "HVAC compressor replacement", "discountAmount": "0.00", "markupAmount": "0.00", "isVoided": "0", "datePosted": "2026-03-15" }, "ledger": { "ledgerID": "960", "name": "123 Main St Operating", "ledgerTypeID": "3" }, "portfolio": { "portfolioID": "50", "name": "Sunset Properties LLC", "contacts": null }, "property": { "propertyID": "101", "name": "Sunset Apartments", "propertyTypeID": "1", "isMultiUnit": "1", "address": "123 Main St", "address2": null, "city": "Austin", "stateID": "TX", "postalCode": "78701" }, "unit": { "unitID": "310", "unitName": "Unit 4B", "unitAddress": "123 Main St", "unitAddress2": "Apt 4B", "unitCity": "Austin", "unitStateID": "TX", "unitPostalCode": "78701" }, "contact": { "contactID": "200", "contactTypeID": "4", "name": "Austin HVAC Services" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Deposits #### List Deposits `GET /accounting/deposits` Operation ID: `listDeposits` Returns a paginated list of bank deposits. Each item in the response includes the deposit record and its associated bank account. ##### Use Cases - Display a list of deposits for a specific bank account. - Filter deposits by reconciliation ID to see what was deposited in a given reconciliation cycle. ##### Business Rules - Results are scoped to the authenticated user's portfolio restrictions. - The `account` object is always included in each list item. - Use `GET /accounting/deposits/search` for richer filtering with min/max amounts and date ranges. ##### Related Endpoints - `GET /accounting/deposits/search` - Search deposits with advanced filters. - `GET /accounting/deposits/{depositID}` - Retrieve a single deposit with includes support. - `POST /accounting/deposits` - Create a new deposit. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Full-text search against deposit number and description. - `bankAccountID` (query, integer): Filter by a specific bank account ID. - `reconciliationID` (query, integer): Filter deposits associated with a specific reconciliation ID. Responses: - `200`: Successfully retrieved deposits. - `application/json`: object - `deposit` (`deposit`, required) - `token` (string, required): Session token associated with this response. Example: ```json { "deposit": { "depositID": "4210", "bankAccountID": "31", "reconciliationID": "3", "previousReconciliationID": null, "depositNumber": "28", "description": "Rent Payments", "amount": "24225.00", "isVoided": "0", "dateDeposited": "2021-04-14", "dateTimeCreated": "2021-04-14 13:40:48" }, "token": "1777036078" } ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Deposit `POST /accounting/deposits` Operation ID: `createDeposit` Creates a new bank deposit, optionally adding transactions, bulk payments, and file attachments in the same request. On success, returns the newly created deposit (same shape as `GET /accounting/deposits/{depositID}`). ##### Use Cases - Create a deposit and attach existing undeposited transactions to it. - Create a deposit with bulk payments from a bulk payment batch. ##### Business Rules - Requires the `Accounting > ModifyDeposit` permission. - Each `transactionID` in `transactions` must exist and pass portfolio restrictions. - Each `bulkPaymentID` in `bulkPayments` must exist. - The `attachments` array contains `fileID` values for pre-uploaded files. - After creation the endpoint forwards to `GET /accounting/deposits/{depositID}` and returns the full deposit detail. ##### Related Endpoints - `GET /accounting/deposits/transactions/undeposited` - Retrieve undeposited transactions to include. - `GET /accounting/deposits/{depositID}` - View the created deposit. Request body, required: - `application/json`: object - `bankAccountID` (string | integer, required, pattern `^-?[0-9]+$`): The bank account to deposit into. - `depositNumber` (string | null): Optional reference number. - `description` (string | null): Optional description. - `dateDeposited` (string, date, required): The date of the deposit. - `amount` (string | number, decimal, required): Total deposit amount as a decimal string. - `transactions` (object[]): List of transactions to include in this deposit. - `transactionID` (string | integer, required, pattern `^-?[0-9]+$`) - `_index` (integer): Optional ordering index. - `bulkPayments` (object[]): List of bulk payments to include in this deposit. - `bulkPaymentID` (string | integer, required, pattern `^-?[0-9]+$`) - `_index` (integer): Optional ordering index. - `attachments` (integer[]): File IDs of documents to attach to this deposit. Example: ```json { "bankAccountID": 146, "depositNumber": "27", "description": null, "dateDeposited": "2026-04-24", "attachments": [], "transactions": [ { "transactionID": 80911 }, { "transactionID": 78052 } ], "bulkPayments": [], "amount": "1400.00" } ``` Responses: - `200`: Deposit created successfully. Returns the new deposit detail. - `application/json`: object - `deposit` (`deposit`, required) - `transactions` (object[]): Deposited transactions (if includes=transactions). Example: ```json { "deposit": { "depositID": "589", "bankAccountID": "146", "reconciliationID": null, "previousReconciliationID": null, "depositNumber": "27", "description": null, "amount": "1400.00", "isVoided": "0", "dateDeposited": "2026-04-24", "dateTimeCreated": "2026-04-24 13:11:51" } } ``` - `400`: Validation error or invalid input. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Deposits `GET /accounting/deposits/search` Operation ID: `searchDeposits` Returns a paginated, searchable list of deposits with advanced filtering options including amount ranges, date ranges, reconciliation state, and bank account. Each result item contains a `deposit` object, the associated bank `account` object, and a `reconciliation` object (populated when the deposit is linked to a reconciliation, otherwise all fields are `null`). ##### Use Cases - Search deposits by amount range for audit or reconciliation workflows. - Filter by `isReconciled=false` to find deposits pending reconciliation. - Filter by `bankAccountIDs` to scope results to specific bank accounts. - Search deposit number, description, amount, or account name/number via `search`. ##### Business Rules - Both `bankAccountIDs` (comma-separated) and `bankAccountID` (single integer) are accepted; `bankAccountIDs` takes precedence. - Similarly, `reconciliationIDs` takes precedence over `reconciliationID`. - Results are restricted to the authenticated user's portfolio. - Results are ordered by `dateDeposited DESC`, then `depositID DESC`. ##### Related Endpoints - `GET /accounting/deposits` - Simple list with basic filters. - `GET /accounting/deposits/{depositID}` - Retrieve a single deposit with includes support. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `bankAccountIDs` (query, string): Comma-separated list of bank account IDs to filter by. - `bankAccountID` (query, integer): Single bank account ID to filter by (use `bankAccountIDs` for multiple). - `isVoided` (query, boolean): Filter by voided state. `true` returns only voided, `false` returns only non-voided. - `showVoided` (query, boolean): When `false`, returns only voided deposits. Distinct from `isVoided` — use `isVoided=false` to exclude voided deposits, `showVoided=false` to show only voided. - `isReconciled` (query, boolean): Filter by reconciliation state. `true` returns only deposits linked to a reconciliation. `false` returns only unreconciled deposits. - `amountMin` (query, string): Minimum deposit amount (inclusive). - `amountMax` (query, string): Maximum deposit amount (inclusive). - `dateDepositedMin` (query, string, date): Earliest deposit date (inclusive), ISO 8601 date. - `dateDepositedMax` (query, string, date): Latest deposit date (inclusive), ISO 8601 date. - `reconciliationIDs` (query, string): Comma-separated list of reconciliation IDs to filter by. - `reconciliationID` (query, integer): Single reconciliation ID to filter by (use `reconciliationIDs` for multiple). - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved matching deposits. - `application/json`: object[] - Each item: - `deposit` (`deposit`, required) - `account` (combined object, required) - All of: - Option 1: `account` - Option 2: object - `reconciliation` (`reconciliation`, required): The reconciliation this deposit is linked to. All fields are `null` when the deposit has not been reconciled. - All of: - Option 1: `reconciliation` Example: ```json [ { "deposit": { "depositID": "552", "bankAccountID": "31", "reconciliationID": "88", "previousReconciliationID": "87", "depositNumber": "2024-0165", "description": "March 2026 Rent Deposits", "amount": "2330.00", "isVoided": "0", "dateDeposited": "2026-06-25", "dateTimeCreated": "2026-03-24 20:55:56" }, "account": { "accountID": "31", "parentAccountID": "5", "accountTypeID": "3", "accountCategoryID": "2", "number": "1150", "name": "Client Trust Account", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": "1", "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": "Bank of America", "bankAccountTypeID": "2", "bankAccountCiphertextID": "24", "bankAccountNumberTruncated": "2846", "bankAccountAddress": "1234 Bank Way", "bankAccountAddress2": "Suite 100", "bankAccountCity": "Naples", "bankAccountStateID": "FL", "bankAccountPostalCode": "34135", "bankAccountCountryID": "US", "isCheckingEnabled": "1", "checkCompanyName": "123 PM LLC", "checkSignatory": "Michael Maxwell", "checkAddress": "23190 Fashion Drive", "checkAddress2": "Suite 200", "checkCity": "Dr Estero", "checkStateID": "FL", "checkPostalCode": "33928", "checkCountryID": "US", "bankAccountNextCheckNumber": "529", "bankAccountNextDepositNumber": "2024-0179", "checkTemplateID": "2", "creditCardGatewayID": "3", "achGatewayID": "1", "cashCardGatewayID": "5", "remoteCheckGatewayID": "4", "isFromImport": "0", "importSourceKey": "import-src-2023-001", "isNachaEnabled": "1", "isNachaFileBalanced": "0", "nachaOriginName": "123 PM LLC", "nachaOriginNumber": "23466998", "nachaDestinationName": "World Bank", "nachaDestinationNumber": "77879288", "nachaCompanyIdentification": "23466998", "nachaCompanyName": "123 PM LLC", "nachaOriginatingFinancialInstitutionID": "77879288", "nachaAdapterID": "2", "isBillApprovalExempt": "0", "exportInvoiceServiceName": "QuickBooks", "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-04-23 15:31:05", "dateTimeDeactivated": "2027-01-01 00:00:00" }, "reconciliation": { "reconciliationID": "88", "reconciliationVersionID": "1", "bankAccountID": "31", "statementStartDate": "2026-03-01", "statementEndDate": "2026-03-31", "statementEndingBalance": "24500.00", "isCurrent": "1", "isVoided": "0", "previousStatementEndingBalance": "21000.00", "moneyInTotal": "35000.00", "moneyOutTotal": "31500.00", "reconciledMoneyInTotal": "33500.00", "reconciledMoneyOutTotal": "30000.00", "unreconciledMoneyInTotal": "1500.00", "unreconciledMoneyOutTotal": "1500.00", "reconciledBalance": "3500.00", "adjustedCashBalance": "24500.00", "bankAccountBalance": "24500.00", "undepositedPaymentsBalance": "0.00", "paymentsDepositedAfterStatementEndDateBalance": "0.00", "unsettledElectronicTransactionsBalance": "250.00", "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00", "adjustmentsTotal": "0.00", "reconciledAdjustmentsTotal": "0.00", "unreconciledAdjustmentsTotal": "0.00", "bankAdjustmentBalance": "0.00", "bankAccountUndepositedBalance": "0.00", "unsettledPaymentBalance": "250.00", "unsettledPaymentReturnBalance": "0.00", "unsettledPayoutBalance": "0.00", "unsettledPayoutReturnBalance": "0.00", "createdByUserID": "42", "dateTimeCreated": "2026-04-01 10:00:00" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Undeposited Transactions `GET /accounting/deposits/transactions/undeposited` Operation ID: `listUndepositedTransactions` Returns all transactions not yet assigned to a deposit, scoped to a specific bank account. This endpoint populates the transaction picker when creating or editing a deposit. The result is a union of two item types returned in the same array: - **Regular transactions** (`depositTransactionTypeID: 1`, `objectTypeID: 9`) — lease payments, owner payments, and other payments that have not been deposited and are not routed through a bank gateway. - **Bulk payments** (`depositTransactionTypeID: 2`, `objectTypeID: 84`) — undeposited bulk payment batches. For bulk payments the `ledger`, `property`, and `unit` objects will be `null`. ##### Use Cases - Retrieve all undeposited transactions for a bank account before creating a new deposit. - Filter by `transactionTypeID` to show only specific payment types (e.g. lease payments only). - Filter by `createdByUserID` to show transactions entered by a specific user. ##### Business Rules - `bankAccountID` is required and must refer to an account of type Bank. - Voided transactions are excluded. - Transactions already assigned to a deposit (`depositID IS NOT NULL`) are excluded. - Transactions routed through a bank gateway (`bankAccountGatewayID IS NOT NULL`) are excluded. - Results are restricted to the authenticated user's portfolio. - Results are **not** paginated — the full matching list is returned in a single array, ordered by `datePosted DESC`. ##### Related Endpoints - `POST /accounting/deposits` - Create a deposit using transactions from this list. - `POST /accounting/deposits/{depositID}/transactions` - Add transactions to an existing deposit. Parameters: - `bankAccountID` (query, integer, required): The bank account to retrieve undeposited transactions for. Must be a Bank-type account. - `createdByUserID` (query, integer): Filter by the ID of the user who created the transactions. - `transactionTypeID` (query, integer): Filter by a specific transaction type ID (e.g. 2 = LeasePayment). Only applies to regular transactions, not bulk payments. Responses: - `200`: Successfully retrieved undeposited transactions. - `application/json`: object[] - Each item: - `transaction` (object, required) - `depositTransactionTypeID` (integer, required, one of 1, 2): Discriminator for the item type. * `1` - Regular transaction (lease, owner, or other payment) * `2` - Bulk payment - `objectTypeID` (string, required, one of "9", "84"): Object type of the item. * `9` - Regular transaction * `84` - Bulk payment - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the underlying object (equals `transactionID` for regular transactions, `bulkPaymentID` for bulk payments). - `transactionID` (string | null, pattern `^-?[0-9]+$`): Transaction ID. Null for bulk payments. - `transactionTypeID` (string | null, pattern `^-?[0-9]+$`): Transaction type ID. Null for bulk payments. - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`): Bulk payment ID. Null for regular transactions. - `bulkPaymentTypeID` (string | null, pattern `^-?[0-9]+$`): Bulk payment type ID. Null for regular transactions. - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`): Primary ledger ID of the transaction. Null for bulk payments. - `amount` (string, decimal, required): Transaction amount as a decimal string. - `datePosted` (string, date, required): Date the transaction was posted. - `description` (string | null): Optional memo or description. - `reference` (string | null): Optional reference or check number. - `ledger` (object | null, required): Ledger associated with the transaction. Null for bulk payments. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `payer` (object, required): Payer information. For OtherPayment transactions the name comes from `receivedFrom`; for all others it is the contact name. - `name` (string | null) - `property` (object | null, required): Property associated with the transaction. Null for bulk payments. - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `countryID` (string) - `unit` (object | null, required): Unit associated with the transaction. Null for bulk payments. - `unitID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `createdByUser` (object, required): User who created the transaction or bulk payment. - `userID` (string, pattern `^-?[0-9]+$`) Example: ```json [ { "transaction": { "depositTransactionTypeID": 1, "objectTypeID": "9", "objectID": "80923", "transactionID": "80923", "transactionTypeID": "2", "bulkPaymentID": null, "bulkPaymentTypeID": null, "primaryLedgerID": "2", "amount": "1200.00", "datePosted": "2026-04-23", "description": "April rent", "reference": "156163516" }, "ledger": { "ledgerID": "2", "ledgerTypeID": "2", "name": "Amanda LLC" }, "payer": { "name": "Zach Blaylock" }, "property": { "propertyID": "157", "name": "Amour Court", "address": "8686 Armour Court", "address2": null, "city": "Naples", "stateID": "FL", "postalCode": "34119", "countryID": "US" }, "unit": { "unitID": "165", "name": "Amour Court", "address": "8686 Armour Court", "address2": null, "city": "Naples", "stateID": "FL", "postalCode": "34119", "countryID": "US" }, "createdByUser": { "userID": "901735" } } ] ``` - `400`: Validation error — missing or invalid query parameters. - `application/json`: object Example: ```json { "bankAccountID": [ "Bank Account is required" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Deposit `GET /accounting/deposits/{depositID}` Operation ID: `getDeposit` Retrieves a single deposit by ID. The base response always includes the deposit record. Additional data can be requested via the `includes` query parameter. ##### Use Cases - Load a deposit detail page including its transactions and reconciliation info. - Check reconciliation status before allowing an edit or void action. ##### Business Rules - Returns a 400 error if the deposit does not exist. - Access is verified via the authenticated user's license for the deposit's portfolio. - The `restrictions` include adds access-control metadata (read/write/void permissions) derived from the user's license for this deposit. ##### Available Includes (4+) Use `?includes=transactions,reconciliation` to request additional data. - **transactions** — Array of transactions associated with this deposit, including ledger and property context for each entry. - **reconciliation** — The reconciliation record this deposit is linked to (or `null` if unreconciled). - **previousReconciliation** — The previous reconciliation record if the deposit was moved during a re-reconciliation (or `null`). - **restrictions** — Access-control metadata indicating what actions the current user can perform on this deposit. ##### Related Endpoints - `GET /accounting/deposits` - List all deposits. - `POST /accounting/deposits/{depositID}` - Update this deposit. - `DELETE /accounting/deposits/{depositID}` - Void this deposit. - `POST /accounting/deposits/{depositID}/reconcile` - Reconcile this deposit. Parameters: - `depositID` (path, integer, required): The ID of the deposit to retrieve. - `includes` (query, string): Comma-separated list of additional data to include. Available values: `transactions`, `reconciliation`, `previousReconciliation`, `restrictions`. Responses: - `200`: Successfully retrieved the deposit. - `application/json`: object - `deposit` (`deposit`, required) - `transactions` (object[]): Transactions in this deposit (if includes=transactions). Each item contains the transaction record plus denormalized ledger, payer, property, and unit context. - `transaction` (object): The deposited transaction record. - `depositTransactionTypeID` (string): Type of deposit transaction (e.g. "1" = payment). - `objectTypeID` (string, pattern `^-?[0-9]+$`): Object type the transaction belongs to. - `objectID` (string, pattern `^-?[0-9]+$`): ID of the related object (e.g. lease ID). - `transactionID` (string, pattern `^-?[0-9]+$`): Unique identifier for the transaction. - `transactionTypeID` (string, pattern `^-?[0-9]+$`): Type of transaction (e.g. "2" = payment received). - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`): Bulk payment ID if part of a bulk payment batch, otherwise null. - `bulkPaymentTypeID` (string | null, pattern `^-?[0-9]+$`): Bulk payment type ID if applicable, otherwise null. - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`): The ledger this transaction is posted to. - `amount` (string, decimal): Transaction amount as a decimal string. - `datePosted` (string, date): Date the transaction was posted. - `description` (string | null): Free-text description of the transaction. - `reference` (string | null): Payment reference or check number. - `ledger` (object): The ledger associated with this transaction. - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `payer` (object): The payer who made the payment. - `name` (string) - `property` (object): The property associated with this transaction. - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `countryID` (string) - `unit` (object): The unit associated with this transaction. - `unitID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `reconciliation` (one of several shapes): The reconciliation record this deposit is linked to (if includes=reconciliation), or null if unreconciled. - One of: - Option 1: `reconciliation` - Option 2: null - `previousReconciliation` (one of several shapes): The previous reconciliation record if the deposit was moved during re-reconciliation (if includes=previousReconciliation), or null. - One of: - Option 1: `reconciliation` - Option 2: null - `restrictions` (object): Access-control metadata for this deposit (if includes=restrictions). - `access` (string): Access level for the authenticated user — `"full"` allows read, write, and void actions; `"read"` is read-only. Example: ```json { "deposit": { "depositID": "1", "bankAccountID": "31", "reconciliationID": "3", "previousReconciliationID": null, "depositNumber": "28", "description": "Rent Payments", "amount": "24225.00", "isVoided": "0", "dateDeposited": "2021-04-14", "dateTimeCreated": "2021-04-14 13:40:48" } } ``` - `400`: Deposit not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Deposit (PUT) `PUT /accounting/deposits/{depositID}` Operation ID: `updateDepositPut` The same update as `POST /accounting/deposits/{depositID}`, sent with PUT: the same body, rules, side effects and responses, including the `includes` it honours. It is not a full replacement: keys left out keep their values. ##### Related Endpoints - `POST /accounting/deposits/{depositID}` - the same update with POST Parameters: - `depositID` (path, integer, required): The ID of the deposit to update, from `GET /accounting/deposits/search`. Request body, required (shared request body `deposit_update`): - `application/json`: object - `depositNumber` (string, max length 100): Updated reference number, up to 100 characters. The deposit must always have one: `null`, `""` or only spaces is refused (`{"depositNumber": ["Deposit Number is required for this type of deposit"]}`), and so is an update that leaves it out when the stored deposit has none. - `description` (string | null, max length 1000): Updated description, up to 1000 characters. - `dateDeposited` (string, date): Updated deposit date. `null` is refused (`Date Deposited is invalid`). Example: ```json { "depositNumber": "29", "description": "October rent deposits (revised)", "dateDeposited": "2024-10-23" } ``` Responses: - `200`: see shared response `deposit_update_200` - `400`: see shared response `deposit_update_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Deposit `POST /accounting/deposits/{depositID}` Operation ID: `updateDeposit` Updates editable fields on an existing deposit. Only `depositNumber`, `description`, and `dateDeposited` may be changed after creation, and only the keys sent change: keys left out keep their values. On success, returns the updated deposit (same shape as `GET /accounting/deposits/{depositID}`). ##### Business Rules - Requires the **Modify Deposit** permission (`Accounting` › `ModifyDeposit`), checked first: a key without it gets the 403 even for a deposit that doesn't exist. - A key restricted to some portfolios gets 403 `Access Denied` for a deposit outside them. - Refused with a 400: a voided deposit (`{"isVoided": ["Cannot modify voided deposit"]}`), a reconciled one, a missing or empty body, and a field that breaks its limit (see the request body). - `bankAccountID` and `amount` cannot be changed after creation: sent in the body, they are ignored. - A value that isn't a number as `depositID` answers the stock 404. - The update answers like `GET /accounting/deposits/{depositID}` and honours its `includes` (`transactions`, `reconciliation`, `previousReconciliation`, `restrictions`), whose objects aren't documented on this operation yet. ##### Side Effects - Adds a `Deposit Updated` entry to the deposit's history log when a field changes. No transaction or ledger entry is written. ##### Related Endpoints - `PUT /accounting/deposits/{depositID}` - the same update with PUT - `POST /accounting/deposits/{depositID}/transactions` - Add/remove transactions. - `DELETE /accounting/deposits/{depositID}` - Void the deposit. Parameters: - `depositID` (path, integer, required): The ID of the deposit to update, from `GET /accounting/deposits/search`. Request body, required (shared request body `deposit_update`): - `application/json`: object - `depositNumber` (string, max length 100): Updated reference number, up to 100 characters. The deposit must always have one: `null`, `""` or only spaces is refused (`{"depositNumber": ["Deposit Number is required for this type of deposit"]}`), and so is an update that leaves it out when the stored deposit has none. - `description` (string | null, max length 1000): Updated description, up to 1000 characters. - `dateDeposited` (string, date): Updated deposit date. `null` is refused (`Date Deposited is invalid`). Example: ```json { "depositNumber": "29", "description": "October rent deposits (revised)", "dateDeposited": "2024-10-23" } ``` Responses: - `200`: see shared response `deposit_update_200` - `400`: see shared response `deposit_update_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Deposit `DELETE /accounting/deposits/{depositID}` Operation ID: `voidDeposit` Voids a deposit, reversing its effect on the bank account balance. The deposit record is marked `isVoided = 1` and the associated transactions are undeposited. Returns the deposit record after voiding. ##### Business Rules - Requires the `Accounting > VoidDeposit` permission. - Requires full portfolio access to the deposit (not just read access). - A voided deposit cannot be un-voided via API. ##### Related Endpoints - `POST /accounting/deposits/{depositID}/reconcile` - Reconcile a deposit instead of voiding. - `GET /accounting/deposits/{depositID}` - Check deposit state before voiding. Parameters: - `depositID` (path, integer, required): The ID of the deposit to void. Responses: - `200`: Deposit voided successfully. Returns the updated deposit record. - `application/json`: `deposit` Example: ```json { "depositID": "33", "bankAccountID": "31", "reconciliationID": null, "previousReconciliationID": "22", "depositNumber": "54", "description": "December rent deposits", "amount": "11781.00", "isVoided": "1", "dateDeposited": "2021-12-14", "dateTimeCreated": "2021-12-14 20:35:15" } ``` - `400`: Deposit not found or validation error. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit id is required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Add Transactions to Deposit `POST /accounting/deposits/{depositID}/transactions` Operation ID: `addDepositTransactions` Adds one or more transactions (and/or bulk payments) to an existing deposit. This endpoint is used to incrementally build up a deposit rather than specifying all transactions at creation time. ##### Use Cases - Add a forgotten transaction to an existing deposit before reconciliation. - Attach bulk payments (ACH batches) to a deposit. ##### Business Rules - Requires the `Accounting > ModifyDeposit` permission. - Each `transactionID` in `transactions` must exist and pass portfolio access checks. - Each `bulkPaymentID` in `bulkPayments` must exist. - Returns `{ "success": true }` on success, not the updated deposit. Fetch the deposit separately via `GET /accounting/deposits/{depositID}?includes=transactions` to see the updated state. ##### Related Endpoints - `GET /accounting/deposits/transactions/undeposited` - Get available undeposited transactions. - `GET /accounting/deposits/{depositID}` - View the deposit with transactions included. Parameters: - `depositID` (path, integer, required): The ID of the deposit to add transactions to. Request body, required: - `application/json`: object - `transactions` (integer[]): List of transaction IDs to add to the deposit. - `bulkPayments` (integer[]): List of bulk payment IDs to add to the deposit. Example: ```json { "transactions": [ 9903, 9904 ] } ``` Responses: - `200`: Transactions added successfully. - `application/json`: object - `success` (boolean, required) Example: ```json { "success": true } ``` - `400`: Deposit or transaction not found, or invalid input. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit 9999 not found." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Print Deposit `GET /accounting/deposits/{depositID}/print` Operation ID: `printDeposit` Renders a printable PDF for the given deposit and streams it as the response body. The response `Content-Type` is `application/pdf`. ##### Use Cases - Download a PDF receipt for a bank deposit to attach to physical bank records. - Generate a deposit slip for accounting audit purposes. ##### Business Rules - Returns a 400 error if the deposit does not exist. - Access is verified via the authenticated user's license for the deposit's portfolio. - The response is streamed directly — there is no JSON envelope. ##### Related Endpoints - `GET /accounting/deposits/{depositID}` - Retrieve deposit data in JSON format. Parameters: - `depositID` (path, integer, required): The ID of the deposit to print. Responses: - `200`: PDF document streamed successfully. - `application/pdf`: string, binary - `400`: Deposit not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Reconcile Deposit `POST /accounting/deposits/{depositID}/reconcile` Operation ID: `reconcileDeposit` Marks a deposit as reconciled, optionally linking it to an existing reconciliation record. This performs a single-item reconciliation (as opposed to a full bank statement reconciliation). On success, returns the updated deposit detail. ##### Use Cases - Reconcile a single deposit against a bank statement line item without running a full reconciliation cycle. - Link a deposit to an existing reconciliation by providing `reconciliationID`. ##### Business Rules - Requires both the `Accounting > ModifyDeposit` and `Accounting > ModifyReconciliations` permissions. - If `reconciliationID` is provided and the reconciliation exists, the deposit is linked to it. If no ID is provided, a new reconciliation record is created. - The `isSingleTransaction` flag is set internally — this action reconciles this deposit only, not all items in a reconciliation batch. - Returns the updated deposit via a forward to `GET /accounting/deposits/{depositID}`. ##### Related Endpoints - `POST /accounting/deposits/{depositID}/unreconcile` - Reverse this reconciliation. - `GET /accounting/deposits/{depositID}?includes=reconciliation` - Check reconciliation state. Parameters: - `depositID` (path, integer, required): The ID of the deposit to reconcile. Request body, required: - `application/json`: object - `reconciliationID` (string | integer | null, pattern `^-?[0-9]+$`): The ID of an existing reconciliation to link this deposit to. If omitted or null, a new reconciliation record is created. Example: ```json { "reconciliationID": 88 } ``` Responses: - `200`: Deposit reconciled successfully. Returns the updated deposit detail. - `application/json`: object - `deposit` (`deposit`, required) Example: ```json { "deposit": { "depositID": "4210", "bankAccountID": "12", "reconciliationID": "88", "previousReconciliationID": null, "depositNumber": "DEP-2024-001", "description": "October rent deposits", "amount": "5250.00", "isVoided": "0", "dateDeposited": "2024-10-22", "dateTimeCreated": "2024-10-22 14:00:00" } } ``` - `400`: Deposit not found or invalid input. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Unreconcile Deposit `POST /accounting/deposits/{depositID}/unreconcile` Operation ID: `unreconcileDeposit` Removes the reconciliation link from a deposit, reverting it to an unreconciled state. On success, returns the updated deposit detail with `reconciliationID` set to `null`. ##### Use Cases - Correct a mis-reconciled deposit before closing the accounting period. - Unreconcile a deposit to allow edits to its transactions. ##### Business Rules - Requires both the `Accounting > ModifyDeposit` and `Accounting > ModifyReconciliations` permissions. - The `previousReconciliationID` field on the deposit will record the reconciliation that was removed. - This action is single-item only — it does not affect other items in the reconciliation. - Returns the updated deposit via a forward to `GET /accounting/deposits/{depositID}`. ##### Related Endpoints - `POST /accounting/deposits/{depositID}/reconcile` - Reconcile the deposit again. - `GET /accounting/deposits/{depositID}?includes=reconciliation` - Check current reconciliation state. Parameters: - `depositID` (path, integer, required): The ID of the deposit to unreconcile. Responses: - `200`: Deposit unreconciled successfully. Returns the updated deposit detail. - `application/json`: object - `deposit` (`deposit`, required) Example: ```json { "deposit": { "depositID": "4210", "bankAccountID": "12", "reconciliationID": null, "previousReconciliationID": "88", "depositNumber": "DEP-2024-001", "description": "October rent deposits", "amount": "5250.00", "isVoided": "0", "dateDeposited": "2024-10-22", "dateTimeCreated": "2024-10-22 14:00:00" } } ``` - `400`: Deposit not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Deposit 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Invoices #### List Invoices `GET /accounting/invoices` Operation ID: `listInvoices` Returns a paginated list of invoices. Invoices are inbound documents (uploaded PDFs or vendor-created line items) in various processing states. The AI extraction service populates predicted fields for uploaded invoices. ##### Use Cases - Display a queue of invoices pending review (`invoiceStatusID=2`). - Filter invoices assigned to a specific user for workflow management. - Pull all invoices associated with a work order. ##### Business Rules - Results are restricted to the authenticated user's portfolio. - Both singular and plural filter parameters are accepted (e.g. `invoiceStatusID` and `invoiceStatusIDs`); the plural form takes precedence. - Results are paginated; default page size is 25. ##### Related Endpoints - `GET /accounting/invoices/{invoiceID}` - Retrieve a single invoice with full detail. - `POST /accounting/invoices/upload` - Upload a new invoice PDF. Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Full-text search against invoice reference and payee name. - `invoiceStatusIDs` (query, string): Comma-separated list of invoice status IDs to filter by. - `invoiceStatusID` (query, integer): Single invoice status ID filter. - `payeeContactIDs` (query, string): Comma-separated list of payee contact IDs to filter by. - `payeeContactID` (query, integer): Single payee contact ID filter. - `assignedToUserIDs` (query, string): Comma-separated list of user IDs the invoice is assigned to. - `assignedToUserID` (query, integer): Single assigned user ID filter. - `workOrderIDs` (query, string): Comma-separated list of work order IDs to filter by. - `workOrderID` (query, integer): Single work order ID filter. - `dateCreatedMin` (query, string, date): Earliest creation date (inclusive), ISO 8601 date. - `dateCreatedMax` (query, string, date): Latest creation date (inclusive), ISO 8601 date. Responses: - `200`: Successfully retrieved invoices. - `application/json`: object[] - Each item: - `invoice` (object, required): Core invoice record fields. - `invoiceID` (string, required, read-only, pattern `^-?[0-9]+$`) - `invoiceTypeID` (string, required, one of "1", "2"): * `1` - Uploaded * `2` - Created - `invoiceStatusID` (string, required, one of "1", "2", "3", "4", "5"): * `1` - Processing * `2` - Ready * `3` - Converted * `4` - Declined * `5` - Not Processed - `invoiceSourceID` (string, required, one of "1", "2", "3", "4", "5"): * `1` - Portal * `2` - Upload * `3` - Email * `4` - Mobile * `5` - Manager - `invoiceFileID` (string | null, pattern `^-?[0-9]+$`) - `payeeContactID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `workOrderID` (string | null, pattern `^-?[0-9]+$`) - `reference` (string | null) - `declinedMessage` (string | null) - `predictedFields` (object | null): Structured AI extraction predictions. Each key maps to a prediction object with `value` (extracted value or null), and optionally `source` (`"predicted"`) and `confidence` (0–1 float). - `datePosted` (string | null, date) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `predictedReference` (string | null) - `predictedServiceAccountNumber` (string | null) - `invoiceFile` (object | null, required): File record for the uploaded invoice PDF, or null if no file. - `fileID` (string, pattern `^-?[0-9]+$`) - `title` (string | null) - `fileType` (string | null) - `isImage` (string, one of "0", "1") - `contact` (object, required): Confirmed payee contact, or null values if not yet assigned. - `contactID` (string | null, pattern `^-?[0-9]+$`) - `name` (string | null) - `contactTypeID` (string | null, pattern `^-?[0-9]+$`) - `property` (object, required): Property assignment context derived from the predicted ledger. - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `workOrder` (object, required): Associated work order summary, or null values if not linked. - `workOrderID` (string | null, pattern `^-?[0-9]+$`) - `workOrderNumber` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `bill` (object, required): Bill this invoice was converted to, or null values if not yet converted. - `billID` (string | null, pattern `^-?[0-9]+$`) - `reference` (string | null) - `submittedBy` (object, required): User who submitted the invoice. - `userID` (string | null, pattern `^-?[0-9]+$`) - `firstName` (string | null) - `lastName` (string | null) - `email` (string | null, email) - `createdInvoice` (object, required): Address and ledger context for manually-created invoices (invoiceTypeID=2). - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `ledgerID` (string | null, pattern `^-?[0-9]+$`) - `total` (string | null): Sum of line item amounts (decimal string), or null if no line items. - `addressFull` (string): Formatted full address string. Example: ```json [ { "invoice": { "invoiceID": "1296", "invoiceTypeID": "1", "invoiceStatusID": "3", "invoiceSourceID": "2", "invoiceFileID": "9704", "payeeContactID": null, "billID": "15077", "workOrderID": null, "reference": null, "declinedMessage": null, "predictedFields": { "amount": { "value": null }, "ledger": { "value": null }, "dueDate": { "value": "2026-03-31", "source": "predicted", "confidence": 0.563 }, "billDate": { "value": "2026-03-31", "source": "predicted", "confidence": 0.563 }, "accountID": { "value": null }, "lineItems": [], "reference": { "value": null }, "workOrderID": { "value": null }, "payeeContact": { "value": null }, "serviceEndDate": { "value": "2026-02-20", "source": "predicted", "confidence": 0.657 }, "defaultDiscount": { "value": null }, "serviceStartDate": { "value": "2026-01-21", "source": "predicted", "confidence": 0.646 }, "serviceAccountNumber": { "value": "in 4100:", "source": "predicted", "confidence": 0.449 } }, "datePosted": null, "dateTimeCreated": "2026-04-23 20:35:37", "predictedReference": null, "predictedServiceAccountNumber": "in 4100:" }, "invoiceFile": { "fileID": "9704", "title": "Image 3-31-26 at 5.43 PM.png", "fileType": "png", "isImage": "1" }, "contact": { "contactID": null, "name": null, "contactTypeID": null }, "property": { "assignedToUserID": null }, "workOrder": { "workOrderID": null, "workOrderNumber": null, "assignedToUserID": null }, "bill": { "billID": "15077", "reference": null }, "submittedBy": { "userID": "782351", "firstName": "Jake", "lastName": "Parrish", "email": null }, "createdInvoice": { "address": null, "address2": null, "city": null, "stateID": null, "ledgerID": null, "total": null, "addressFull": "" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Upload Invoice `POST /accounting/invoices/upload` Operation ID: `uploadInvoice` Uploads an invoice PDF or image file. The file is stored and an invoice record is created in `Processing` status. The AI extraction service processes the file asynchronously and populates the `predicted*` fields when complete. The invoice transitions to `Ready` status once extraction is done. ##### Use Cases - Allow a property manager to upload a vendor invoice PDF from the manager portal. - Trigger AI-powered field extraction for invoice automation workflows. ##### Business Rules - The request must be `multipart/form-data` with the file as the first upload. - The file must be a valid upload (checked by the internal file validation layer). - The new invoice is created with `invoiceStatusID=1` (Processing) and `invoiceSourceID=2` (Upload). - On success, forwards to `GET /accounting/invoices/{invoiceID}` and returns the full invoice detail. - The AI prediction runs asynchronously via the queue — the `predicted*` fields will be populated after a short delay. ##### Related Endpoints - `GET /accounting/invoices/{invoiceID}` - Poll for updated prediction results. - `POST /accounting/invoices/{invoiceID}/decline` - Decline an invoice after review. Request body, required: - `multipart/form-data`: object - `file` (string, binary, required): The invoice PDF or image file to upload. Responses: - `200`: Invoice uploaded and created successfully. Returns the new invoice detail. - `application/json`: object - `invoice` (`invoice`, required) - `lineItems` (object[], required): Line items (empty until AI extraction completes). Example: ```json { "invoice": { "invoiceID": "1299", "receivedInvoiceEmailID": "5001", "invoiceTypeID": "1", "invoiceStatusID": "1", "invoiceSourceID": "2", "invoiceFileID": "9753", "payeeContactID": "150", "billID": "201", "workOrderID": "301", "reference": "INV-2026-001", "submittedByUserID": "501195", "submittedByEmail": "manager@example.com", "declinedMessage": "Invoice requires additional review.", "predictedFields": { "amount": { "value": "375.00" }, "ledger": { "value": "Operating Account" }, "dueDate": { "value": "2026-05-15" }, "billDate": { "value": "2026-04-27" }, "accountID": { "value": 50 }, "lineItems": [], "reference": { "value": "INV-4421" }, "workOrderID": { "value": 301 }, "payeeContact": { "value": 210 }, "serviceEndDate": { "value": "2026-04-30" }, "defaultDiscount": { "value": "5.00" }, "serviceStartDate": { "value": "2026-04-01" }, "serviceAccountNumber": { "value": "SVC-001" } }, "predictedPayeeContactID": "210", "predictedPayeeContactName": "Acme Plumbing", "predictedDefaultDiscount": "5.00", "predictedWorkOrderID": "301", "predictedLedgerID": "401", "predictedLedgerAddress": "123 Main St", "predictedAccountID": "50", "predictedBillDate": "2026-04-27", "predictedDueDate": "2026-05-15", "predictedReference": "INV-4421", "predictedServiceAccountNumber": "SVC-001", "predictedAmount": "375.00", "predictedServiceStartDate": "2026-04-01", "predictedServiceEndDate": "2026-04-30", "datePosted": "2026-04-27", "dateTimeCreated": "2026-04-27 12:38:52" }, "lineItems": [] } ``` - `400`: Invalid file supplied. - `application/json`: object - `error` (string) Example: ```json { "error": "Invalid file supplied in upload" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Invoice `GET /accounting/invoices/{invoiceID}` Operation ID: `getInvoice` Retrieves a single invoice by ID. The base response includes the invoice record and its line items (actual or AI-predicted depending on `invoiceTypeID`). Additional related data can be requested via the `includes` query parameter. ##### Use Cases - Load a full invoice detail page including the vendor contact and predicted field data. - Display line items for a Created (manually entered) invoice. - Pull the associated work order and property for routing/approval context. ##### Business Rules - Returns a 400 error if the invoice does not exist. - `lineItems` are always returned — for `invoiceTypeID=2` (Created) these come from `InvoiceLineItems`; for uploaded invoices they come from the AI prediction data. - The `workOrder`, `unit`, `property`, `lease`, and `ledger` includes are nested: `unit`, `property`, `lease`, and `ledger` require `workOrder` to also be included. ##### Available Includes (7+) Use `?includes=contact,workOrder,property` to request additional data. - **contact** — The confirmed or predicted payee contact record. - **predictedInvoice** — The raw AI extraction result for uploaded invoices. - **invoiceFile** — The file record for the uploaded invoice PDF. - **files** — Attachments shared with the vendor on this invoice. - **workOrder** — The associated work order, if set. - **unit** — The unit linked to the work order (requires `workOrder`). - **property** — The property linked to the work order (requires `workOrder`). - **lease** — The lease linked to the work order (requires `workOrder`). - **ledger** — The ledger for the unit or property (requires `workOrder`). ##### Related Endpoints - `GET /accounting/invoices` - List all invoices. - `POST /accounting/invoices/{invoiceID}/decline` - Decline this invoice. - `GET /accounting/invoices/{invoiceID}/print` - Download the invoice as a PDF. Parameters: - `invoiceID` (path, integer, required): The ID of the invoice to retrieve. - `includes` (query, string): Comma-separated list of additional data to include. Available values: `contact`, `predictedInvoice`, `invoiceFile`, `files`, `workOrder`, `unit`, `property`, `lease`, `ledger`. Responses: - `200`: Successfully retrieved the invoice. - `application/json`: object - `invoice` (`invoice`, required) - `lineItems` (one of several shapes[], required): Line items, in one of two shapes depending on the invoice type. A Created invoice (`invoiceTypeID=2`) returns its stored line item rows, with every value a string. Any other invoice returns the line items the AI prediction read from the uploaded document, with `amount`, `unitPrice` and `quantity` as JSON numbers (or `null` when the prediction has no value). - One of: - Created invoice line item: object - `invoiceLineItemID` (string, required, pattern `^-?[0-9]+$`) - `invoiceID` (string, required, pattern `^-?[0-9]+$`) - `description` (string, required) - `amount` (string, decimal, required) - Predicted line item: object - `description` (string | null, required) - `amount` (number | null, required) - `unitPrice` (number | null, required) - `quantity` (number | null, required): Can be fractional, such as `1.5`. - `productCode` (string | null, required) - `contact` (object | null): The payee contact (if includes=contact). - `contactID` (string, pattern `^-?[0-9]+$`) - `firstName` (string | null) - `lastName` (string | null) - `companyName` (string | null) - `predictedInvoice` (object | null): Raw AI extraction result (if includes=predictedInvoice). - `invoiceFile` (object | null): The uploaded invoice PDF file record (if includes=invoiceFile). - `fileID` (string, pattern `^-?[0-9]+$`) - `fileName` (string | null) - `url` (string, uri) - `files` (object[] | null): Attachments shared with the vendor (if includes=files). - `workOrder` (object | null): The associated work order (if includes=workOrder). - `workOrderID` (string, pattern `^-?[0-9]+$`) - `description` (string | null) - `unit` (object | null): The unit from the work order (if includes=unit and workOrder). - `property` (object | null): The property from the work order (if includes=property and workOrder). - `lease` (object | null): The lease from the work order (if includes=lease and workOrder). - `ledger` (object | null): The ledger for the unit or property (if includes=ledger and workOrder). Example: ```json { "invoice": { "invoiceID": "1285", "receivedInvoiceEmailID": "23", "invoiceTypeID": "1", "invoiceStatusID": "2", "invoiceSourceID": "3", "invoiceFileID": "9511", "payeeContactID": "415", "billID": null, "workOrderID": null, "reference": "INV-2026-0406", "submittedByUserID": "782351", "submittedByEmail": "parker.biggs@example.com", "declinedMessage": null, "predictedFields": { "amount": { "value": -400, "source": "predicted", "confidence": 0.332 }, "ledger": { "value": null }, "dueDate": { "value": "2026-04-06" }, "billDate": { "value": "2026-04-06" }, "accountID": { "value": null }, "lineItems": [], "reference": { "value": "INV-2026-0406", "source": "predicted", "confidence": 0.712 }, "workOrderID": { "value": null }, "payeeContact": { "value": null }, "serviceEndDate": { "value": "2026-04-30", "source": "predicted", "confidence": 0.501 }, "defaultDiscount": { "value": null }, "serviceStartDate": { "value": "2026-04-01", "source": "predicted", "confidence": 0.481 }, "serviceAccountNumber": { "value": "ACCT-9811", "source": "predicted", "confidence": 0.39 } }, "predictedPayeeContactID": "415", "predictedPayeeContactName": "Pacific Gas & Electric", "predictedDefaultDiscount": null, "predictedWorkOrderID": null, "predictedLedgerID": "3201", "predictedLedgerAddress": "456 Oak Ave, Portland, OR", "predictedAccountID": "1105", "predictedBillDate": "2026-04-06", "predictedDueDate": "2026-04-06", "predictedReference": "INV-2026-0406", "predictedServiceAccountNumber": "ACCT-9811", "predictedAmount": "-400.00", "predictedServiceStartDate": "2026-04-01", "predictedServiceEndDate": "2026-04-30", "datePosted": null, "dateTimeCreated": "2026-04-06 13:39:22" }, "lineItems": [] } ``` - `400`: Invoice not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Invoice 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Print Invoice `GET /accounting/invoices/{invoiceID}/print` Operation ID: `printInvoice` Renders a printable PDF for the given invoice and streams it as the response body. The response `Content-Type` is `application/pdf`. ##### Use Cases - Download a PDF copy of an invoice to send to an owner or attach to a bill. - Generate an invoice PDF for record-keeping before converting to a bill. ##### Business Rules - Returns a 400 error if the invoice does not exist. - The response is streamed directly — there is no JSON envelope. ##### Related Endpoints - `GET /accounting/invoices/{invoiceID}` - Retrieve invoice data in JSON format. Parameters: - `invoiceID` (path, integer, required): The ID of the invoice to print. Responses: - `200`: PDF document streamed successfully. - `application/pdf`: string, binary - `400`: Invoice not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Invoice not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Decline Invoice `POST /accounting/invoices/{invoiceID}/decline` Operation ID: `declineInvoice` Declines an invoice, setting its status to `Declined` (4) and optionally sending a decline notification to the vendor. On success, returns the updated invoice detail. ##### Use Cases - Reject a vendor invoice that does not match an approved work order or has incorrect details. - Decline a duplicate or invalid invoice submission. ##### Business Rules - The invoice `invoiceStatusID` is set to `4` (Declined) internally regardless of the value provided in the request body. - `declinedMessage` is stored on the invoice and included in the notification email if `sendNotification` is true. - `sendNotification` defaults to `true` if not provided in the request body. - On success, forwards to `GET /accounting/invoices/{invoiceID}` and returns the full invoice detail. ##### Related Endpoints - `GET /accounting/invoices/{invoiceID}` - View the declined invoice. - `POST /accounting/invoices/upload` - Upload a replacement invoice. Parameters: - `invoiceID` (path, integer, required): The ID of the invoice to decline. Request body, required: - `application/json`: object - `declinedMessage` (string | null): Message explaining why the invoice was declined. Sent to the vendor if `sendNotification` is true. - `sendNotification` (boolean, default true): Whether to send a decline notification email to the vendor. Example: ```json { "declinedMessage": "Invoice amount does not match the approved work order estimate.", "sendNotification": true } ``` Responses: - `200`: Invoice declined successfully. Returns the updated invoice detail. - `application/json`: object - `invoice` (`invoice`, required) - `lineItems` (object[], required) Example: ```json { "invoice": { "invoiceID": "1299", "receivedInvoiceEmailID": "5001", "invoiceTypeID": "1", "invoiceStatusID": "4", "invoiceSourceID": "2", "invoiceFileID": "9753", "payeeContactID": "150", "billID": "201", "workOrderID": "301", "reference": "INV-2026-001", "submittedByUserID": "501195", "submittedByEmail": "manager@example.com", "declinedMessage": "test", "predictedFields": { "amount": { "value": "375.00" }, "ledger": { "value": "Operating Account" }, "dueDate": { "value": "2026-04-27" }, "billDate": { "value": "2026-04-27" }, "accountID": { "value": 50 }, "lineItems": [], "reference": { "value": "INV-4421" }, "workOrderID": { "value": 301 }, "payeeContact": { "value": 210 }, "serviceEndDate": { "value": "2026-04-30" }, "defaultDiscount": { "value": "5.00" }, "serviceStartDate": { "value": "2026-04-01" }, "serviceAccountNumber": { "value": "SVC-001" } }, "predictedPayeeContactID": "210", "predictedPayeeContactName": "Acme Plumbing", "predictedDefaultDiscount": "5.00", "predictedWorkOrderID": "301", "predictedLedgerID": "401", "predictedLedgerAddress": "123 Main St", "predictedAccountID": "50", "predictedBillDate": "2026-04-27", "predictedDueDate": "2026-04-27", "predictedReference": "INV-4421", "predictedServiceAccountNumber": "SVC-001", "predictedAmount": "375.00", "predictedServiceStartDate": "2026-04-01", "predictedServiceEndDate": "2026-04-30", "datePosted": "2026-04-27", "dateTimeCreated": "2026-04-27 12:38:52" }, "lineItems": [] } ``` - `400`: Invoice not found or invalid input. - `application/json`: object - `error` (string) Example: ```json { "error": "Invoice 9999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Ledgers #### List Ledgers `GET /accounting/ledgers` Operation ID: `listLedgers` Returns an array of `{"ledger": {...}}` items matching the given search criteria, with no paging. At least one of `search` or `ledgerIDs` must be provided: a request with neither (an empty `search` counts as none) is refused with a 400 whose body is the bare JSON string `"Search Failed"`. ##### Use Cases - Typeahead / autocomplete: pass `search` to find ledgers by name. - Batch lookup: pass `ledgerIDs` to fetch a known set of ledgers by ID. - Filtered listing: combine `ledgerTypeID` with `search` to narrow results to a specific ledger type (e.g. only property operating accounts). ##### Business Rules - Needs no permission. - Only active ledgers are returned, and only ledgers whose portfolio, property or unit still exists. A key restricted to some portfolios gets only their ledgers. A `ledgerIDs[]` lookup drops any ID these filters leave out, with no error. - `search` and `ledgerIDs[]` together must both match. `search=0` counts as no search (the 400). - On an account that bills its management fees and hides the manager ledger, manager ledgers (type `1`) are left out. This is an account setting, not a permission: every key on the account gets the same rows. - Not paginated: every matching ledger comes back in one array, with no pagination headers, so a short `search` can return over a thousand ledgers. A `search` of only spaces matches every ledger. - `ledgerIDs[]` values that aren't positive integers are dropped; when none is left the answer is 200 `[]`, not the 400. A single `ledgerIDs=100` (no brackets) is read as a one-item list; a comma list (`100,101`) isn't split. - A `ledgerTypeID` of `0`, or one that isn't a number, is ignored (no type filter); any other value outside 1 to 4 matches nothing: 200 `[]`. - Results are ordered by search relevance rank, then ledger type, then name. ##### Related Endpoints - `GET /accounting/ledgers/search` — Paginated ledger search with extended filters. - `GET /accounting/ledgers/{ledgerID}` (undocumented) — Retrieve a single ledger with optional includes. Parameters: - `search` (query, string): Search string matched against the ledger name. - `ledgerTypeID` (query, integer, one of 1, 2, 3, 4): Filter results to a single ledger type. * `1` - Manager * `2` - Portfolio * `3` - Property * `4` - Unit - `ledgerIDs[]` (query, integer[]): Filter by one or more ledger IDs. Pass each value as a separate query parameter: `ledgerIDs[]=100&ledgerIDs[]=101`. Responses: - `200`: Successfully retrieved ledgers. - `application/json`: object[] - Each item: - `ledger` (`ledger`, required) Example: ```json [ { "ledger": { "ledgerID": "100", "ledgerTypeID": "2", "name": "Operating Account", "objectID": "500", "isActive": "1" } }, { "ledger": { "ledgerID": "101", "ledgerTypeID": "2", "name": "Security Deposit Account", "objectID": "501", "isActive": "1" } } ] ``` - `400`: Neither `search` nor `ledgerIDs` was given (an empty `search` counts as none). The body is a bare JSON string, not an object. - `application/json`: string Example: ``` Search Failed ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Search Ledgers `GET /accounting/ledgers/search` Operation ID: `searchLedgers` Paginated search across all ledgers with filtering by type, status, and modification date. Results include a left-joined `unit` object populated only when the ledger is of type Unit (ledgerTypeID 4). ##### Use Cases - Retrieve all active ledgers modified after a given date for sync/reconciliation. - Filter to a specific set of ledger types (e.g. property and portfolio) for a reporting UI. - Look up a single known ledger by `ledgerID` to confirm its current state. - Combine `search` + `ledgerTypeIDs` to power a filtered autocomplete when exact IDs are not known. ##### Business Rules - Portfolio/access restrictions are applied automatically — results are limited to ledgers the authenticated user has permission to view. - `isActive` filters on ledger status; omit it to receive both active and inactive records. - `ledgerTypeIDs` accepts a comma-separated string or repeated array values; `ledgerTypeID` (singular) is accepted as a convenience fallback for a single type. - The `unit` object is always present in each item but its fields will be `null` for non-unit ledgers. ##### Related Endpoints - `GET /accounting/ledgers` — Lightweight, non-paginated ledger lookup (typeahead / batch ID lookup). - `GET /accounting/ledgers/{ledgerID}` — Single ledger detail with optional includes. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `isActive` (query, boolean) - `ledgerID` (query, integer): Filter to a single ledger by its primary key. - `ledgerTypeIDs[]` (query, integer[]): Filter by an array of ledgerTypeIDs - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved ledgers. - `application/json`: object[] - Each item: - `ledger` (object, required) - `ledgerID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the ledger. - `ledgerTypeID` (`ledger_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the owning entity (property, unit, portfolio, or manager). - `name` (string, required): Display name of the ledger. - `isActive` (string, required, one of "0", "1"): `1` if active, `0` if inactive. - `dateTimeCreated` (string, required, read-only): When the ledger was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): When the ledger was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `unit` (object | null, required): Unit details joined from `property_units`. Populated only when `ledger.ledgerTypeID` is `4` (Unit). All fields are `null` for non-unit ledgers. - `unitID` (string | null, read-only, pattern `^-?[0-9]+$`): Unit primary key. - `propertyID` (string | null, pattern `^-?[0-9]+$`): ID of the property this unit belongs to. - `name` (string | null): Unit name or number. - `address` (string | null): Primary street address of the unit. - `address2` (string | null): Secondary address line of the unit. - `leaseID` (string | null, pattern `^-?[0-9]+$`): ID of the active lease on this unit, if any. Example: ```json [ { "ledger": { "ledgerID": "100", "ledgerTypeID": "3", "objectID": "500", "name": "Operating Account", "isActive": "1", "dateTimeCreated": "2023-01-15 09:00:00", "dateTimeModified": "2024-06-01 14:22:00" }, "unit": { "unitID": null, "propertyID": null, "name": null, "address": null, "address2": null, "leaseID": null } } ] ``` - `400`: Search query failed validation. - `application/json`: object - `error` (string) Example: ```json { "error": "Search Failed" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Reconciliations A reconciliation matches a bank account's records against one bank statement: the deposits, payments, transfers and adjustments the statement cleared are marked reconciled, and the period's balances and transactions are recorded. Each bank account has one current reconciliation, the newest; the next one starts the day after it ends. List, read, complete (create) and void reconciliations here. Single payment returns and bank fees are reconciled into an existing reconciliation, or removed from it, with `POST /accounting/transactions/{transactionID}/reconcile` and `/unreconcile`; deposits with their own endpoints. Keys restricted to portfolio groups can't list, read, complete or void reconciliations, since a reconciliation spans every portfolio that uses the bank account. #### List Reconciliations `GET /accounting/reconciliations` Operation ID: `listReconciliations` Lists completed bank reconciliations, newest statement first, with the bank account each one belongs to. Voided reconciliations are listed too, unless `isVoided` filters them out. ##### Use Cases - Find a bank account's current reconciliation (`bankAccountID` with `isCurrent=true`) before reconciling a transaction into it. - Review a bank account's reconciliation history, or the ones whose balance changed after completion (`excludeInBalanceReconciliations=true`). ##### Business Rules - No permission is checked beyond a valid API key. - A key restricted to any portfolio group gets 403 `{"error": "Access Denied"}`: a reconciliation spans every portfolio that uses the bank account, so restricted keys can't read reconciliations at all. - Sorted by `statementEndDate`, newest first, then by `reconciliationID`, highest first. - A filter value the API can't read (a date it can't parse, a non-numeric balance, a flag other than `true`/`false`/`1`/`0`/`yes`/`no`) is ignored, and the list comes back unfiltered by it. ##### Related Endpoints - `GET /accounting/reconciliations/{reconciliationID}` - One reconciliation, with its transactions and balances. - `POST /accounting/reconciliations` - Complete a reconciliation. - `GET /accounting/bank-accounts` - The bank accounts to filter by. Parameters: - `search` (query, string): Keeps the reconciliations whose statement ending balance equals this value exactly, or whose bank account's number, name or bank name contains it. Send a number (`5250.00`) to match an ending balance, and text to match the bank account. - `bankAccountID` (query, integer): Keeps one bank account's reconciliations. Bank account IDs come from `GET /accounting/bank-accounts`. - `bankAccountIDs[]` (query, integer[]): Keeps the reconciliations of any of these bank accounts. Send each ID as its own `bankAccountIDs[]=` value (`bankAccountIDs[]=124&bankAccountIDs[]=125`); a comma-separated value (`bankAccountIDs=124,125`) keeps only the first ID. - `isCurrent` (query, string): `true` (or `1`, `yes`) keeps only each bank account's current reconciliation, `false` (or `0`, `no`) only the others. Any other value is ignored. - `isVoided` (query, string): `true` (or `1`, `yes`) keeps only voided reconciliations, `false` (or `0`, `no`) only the ones that aren't. Any other value is ignored. - `statementEndingBalanceMin` (query, string): Keeps the reconciliations whose statement ending balance is at least this amount. Ignored when it isn't a number. - `statementEndingBalanceMax` (query, string): Keeps the reconciliations whose statement ending balance is at most this amount. Ignored when it isn't a number. - `statementStartDateMin` (query, string): Keeps the statements that start on or after this date (`YYYY-MM-DD` or `MM/DD/YYYY`). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp. - `statementStartDateMax` (query, string): Keeps the statements that start on or before this date (`YYYY-MM-DD` or `MM/DD/YYYY`). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp. - `statementEndDateMin` (query, string): Keeps the statements that end on or after this date (`YYYY-MM-DD` or `MM/DD/YYYY`). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp. - `statementEndDateMax` (query, string): Keeps the statements that end on or before this date (`YYYY-MM-DD` or `MM/DD/YYYY`). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp. - `excludeInBalanceReconciliations` (query, string): `true` (or `1`, `yes`) keeps only the reconciliations whose `changeTransactionBalance` isn't `0.00`: those whose changes after completion don't net to zero. `false` or any other value applies no filter. - `page` (query, integer, default 1): The page to return. A value below 1 is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit; 0, a negative value or a value that isn't a number serves 15. Responses: - `200`: The reconciliations on the requested page. - `application/json`: object[] - Each item: - `reconciliation` (`reconciliation_list_item`, required) - `account` (object, required): The bank account the reconciliation belongs to. - `accountID` (string, required, pattern `^-?[0-9]+$`): The bank account's ID (the reconciliation's `bankAccountID`). - `parentAccountID` (string | null, required, pattern `^-?[0-9]+$`): The parent account, or null. - `accountTypeID` (`account_types`, required) - `accountCategoryID` (string | null, required, pattern `^-?[0-9]+$`): The account's category, or null. - `number` (string, required, max length 10): The account number in the chart of accounts. - `name` (string, required, max length 100): The account's name. - `isActive` (string, required, one of "0", "1"): `1` when the account is active. Example: ```json [ { "reconciliation": { "reconciliationID": "21", "reconciliationVersionID": "2", "bankAccountID": "124", "statementStartDate": "2026-03-01", "statementEndDate": "2026-03-31", "statementEndingBalance": "5250.00", "isCurrent": "1", "isVoided": "0", "previousStatementEndingBalance": "29868.81", "moneyInTotal": "0.00", "moneyOutTotal": "0.00", "reconciledMoneyInTotal": "0.00", "reconciledMoneyOutTotal": "0.00", "unreconciledMoneyInTotal": "0.00", "unreconciledMoneyOutTotal": "0.00", "reconciledBalance": "0.00", "adjustedCashBalance": "0.00", "bankAccountBalance": "0.00", "undepositedPaymentsBalance": "0.00", "paymentsDepositedAfterStatementEndDateBalance": "0.00", "unsettledElectronicTransactionsBalance": "0.00", "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00", "adjustmentsTotal": "0.00", "reconciledAdjustmentsTotal": "0.00", "unreconciledAdjustmentsTotal": "0.00", "bankAdjustmentBalance": "0.00", "bankAccountUndepositedBalance": "0.00", "unsettledPaymentBalance": "0.00", "unsettledPaymentReturnBalance": "0.00", "unsettledPayoutBalance": "0.00", "unsettledPayoutReturnBalance": "0.00", "createdByUserID": "2", "dateTimeCreated": "2026-11-14 21:06:46", "changeTransactionBalance": "0.00" }, "account": { "accountID": "124", "parentAccountID": null, "accountTypeID": "3", "accountCategoryID": null, "number": "352298", "name": "Operating Checking", "isActive": "1" } } ] ``` - `401`: see shared response `error_401` - `403`: The key is restricted to one or more portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `429`: see shared response `error_429` #### Create Reconciliation `POST /accounting/reconciliations` Operation ID: `createReconciliation` Completes a bank reconciliation: marks the transactions cleared on the bank statement as reconciled, and records the statement period, its balances and a snapshot of the period's transactions. The new reconciliation becomes the bank account's current one. ##### Use Cases - Close a bank statement: send the statement's end date and ending balance with every deposit, payment, transfer and adjustment it cleared. - Attach the bank statement file (upload it first with `POST /files`). ##### Business Rules - Requires the **Modify Reconciliations** permission (`Accounting` › `ModifyReconciliations`); without it the API answers 403 `{"error": "Permission Denied"}`. - A key restricted to any portfolio group gets 403 `{"error": "Access Denied"}`. - The statement period starts the day after the bank account's current reconciliation ends, whatever `statementStartDate` says. `statementStartDate` is used, and required, only when the bank account has no current reconciliation: its first, or after every reconciliation it had was voided. - `statementEndingBalance` must equal the current reconciliation's ending balance (0.00 when there is none), plus the money-in items in `transactions`, minus the money-out items; otherwise 400 `Failed reconciled balance check`. - Each item in `transactions` must still be unreconciled and dated on or before `statementEndDate`, with the amount and date it has now, and sent once. Its `reconciliationTransactionTypeID` and `reconciliationObjectTypeID` must be the pair the item is listed under: money in (`1`) for a deposit (`4`), a bank transfer in (`2`) or a payout return (`11`); money out (`2`) for a payout (`5`), a payment return (`9`), a bank fee (`10`) or a bank transfer out (`3`); either direction for a bank adjustment (`1`), a transaction entry (`7`) or a settlement (`8`), as its amount goes. The transaction type Adjustment (`3`) and the object type Transaction (`6`) never match. The items reconcilable for a period, with their pairs, amounts and dates, are the ones `GET /accounting/reconciliations/unreconciled` (undocumented) lists. - Only one completion or Bank Sync matching run works on a bank account at a time: while another holds it the API answers 400 `This reconciliation is being updated, please try again.` Retry a moment later. - The body is checked in this order: an empty body; `transactions`; `bankAccountID`; the end date and ending balance; whether every item can still be reconciled, once; the balance; each item's amount and date; that the ledgers' balances add up to the bank balance; the new record's own rules (a bank account, a start date when there is no current reconciliation, an end date not before the start); then `attachments`. - `statementEndingBalance` and each item's `amount` are decimal numbers: a string such as `"2450.00"`, or a JSON number. Each item's `reconciliationObjectTypeID` is one of the listed values. - `viewState` and `matches`, which the Manager screen sends for Bank Sync, are optional and left out here. ##### Side Effects - Each item in `transactions` is marked reconciled with the new reconciliation's ID. - The bank account's previous current reconciliation is no longer current. - Every unreconciled item dated on or before `statementEndDate` (older ones included) is copied to the reconciliation's `transactions` include, with whether it was reconciled; payments and payouts that couldn't be reconciled go to `unreconcilableTransactions`, and the ledgers' balances to `ledgerBalances`. - Each item it reconciles gets an entry in its activity history: "Deposit Reconciled", "Payout Reconciled", "Payout Return Reconciled", "Bank Adjustment Reconciled", "Settlement Reconciled", "Source Bank Transfer Reconciled" or "Destination Bank Transfer Reconciled", or "Transaction Reconciled" for a payment return or bank fee. A transaction entry gets none. - Each file in `attachments` is attached to the reconciliation. Supporting documents and bank statements attached to the bank account's in-progress reconciliation move to the new one, which then ends. - When the bank account's in-progress reconciliation uses Bank Sync, its bank transactions that weren't cleared move to the next period's in-progress reconciliation. Linking bank transactions to the cleared items (`matchedBankTransactions`) needs `matches`, which this reference leaves out, so a reconciliation created without it links none. ##### Related Endpoints - `GET /accounting/reconciliations/{reconciliationID}` - Read the reconciliation back with its includes. - `DELETE /accounting/reconciliations/{reconciliationID}` - Void it. - `GET /accounting/bank-accounts` - The bank accounts to reconcile. Request body, required: - `application/json`: object - `bankAccountID` (string | integer, required, pattern `^-?[0-9]+$`): The bank account being reconciled, from `GET /accounting/bank-accounts`. It must be a bank account. - `statementStartDate` (string): First day of the statement period (`YYYY-MM-DD` or `MM/DD/YYYY`). Required, and used, only when the bank account has no current reconciliation (its first, or after every one it had was voided); otherwise the period starts the day after the current reconciliation ends, whatever this says. - `statementEndDate` (string, required): Last day of the statement period (`YYYY-MM-DD` or `MM/DD/YYYY`). It can't be before the start of the period. - `statementEndingBalance` (string | number, decimal, required, pattern `^-?[0-9]+(\.[0-9]+)?$`): The ending balance on the bank statement, as a decimal number. - `transactions` (object[], required): The items the statement cleared. Send an empty array when it cleared none. - `reconciliationTransactionTypeID` (`reconciliation_transaction_types_request`, required) - `reconciliationObjectTypeID` (`reconciliation_object_types_request`, required) - `objectID` (string | integer, required, pattern `^-?[0-9]+$`): The item's ID in the table `reconciliationObjectTypeID` names (a deposit's `depositID`, a payout's `payoutID`, a bank fee's or payment return's `transactionID`), as `GET /accounting/reconciliations/unreconciled` (undocumented) lists it. - `amount` (string | number, decimal, required, pattern `^-?[0-9]+(\.[0-9]+)?$`): The item's amount, as a decimal number, which must match its current amount. - `datePosted` (string, required): The item's date (`YYYY-MM-DD` or `MM/DD/YYYY`), which must match its current date. - `attachments` (string | integer[]): Files to attach to the reconciliation, by `fileID` from `POST /files`. Example: ```json { "bankAccountID": 395, "statementStartDate": "2026-04-01", "statementEndDate": "2026-04-30", "statementEndingBalance": "2450.00", "transactions": [ { "reconciliationTransactionTypeID": 1, "reconciliationObjectTypeID": 4, "objectID": 59, "amount": "2450.00", "datePosted": "2026-04-10" } ], "attachments": [ 28 ] } ``` Responses: - `200`: The reconciliation was completed. The body is the saved record as the API held it in memory; read it back with `GET /accounting/reconciliations/{reconciliationID}` for every value as a string. - `application/json`: `reconciliation_created` Example: ```json { "reconciliationID": "205", "reconciliationVersionID": 2, "bankAccountID": 395, "statementStartDate": "2026-04-01", "statementEndDate": "2026-04-30", "statementEndingBalance": "2450.00", "isCurrent": 1, "isVoided": 0, "previousStatementEndingBalance": 0, "moneyInTotal": 2450, "moneyOutTotal": 0, "reconciledMoneyInTotal": 2450, "reconciledMoneyOutTotal": 0, "unreconciledMoneyInTotal": 0, "unreconciledMoneyOutTotal": 0, "reconciledBalance": 2450, "adjustedCashBalance": 0, "bankAccountBalance": "0.00", "undepositedPaymentsBalance": "0.00", "paymentsDepositedAfterStatementEndDateBalance": "0.00", "unsettledElectronicTransactionsBalance": "0.00", "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00", "adjustmentsTotal": 0, "reconciledAdjustmentsTotal": 0, "unreconciledAdjustmentsTotal": 0, "bankAdjustmentBalance": 0, "bankAccountUndepositedBalance": 0, "unsettledPaymentBalance": 0, "unsettledPaymentReturnBalance": 0, "unsettledPayoutBalance": 0, "unsettledPayoutReturnBalance": 0, "createdByUserID": "138", "dateTimeCreated": "2026-11-14 21:18:00" } ``` - `400`: The body was refused, or another completion or matching run holds the bank account. The body is either `{"error": "..."}` or field errors keyed by what they concern (`reconciliation`, `reconciliation.`, `reconciliationID`, `isParsed`, `attachments`, an item key such as `transaction_1_4_42.transaction`), each with a list of messages. - `application/json`: object Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The key lacks the permission, or is restricted to one or more portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `429`: see shared response `error_429` #### Get Reconciliation `GET /accounting/reconciliations/{reconciliationID}` Operation ID: `getReconciliation` Returns one completed (or voided) bank reconciliation, with the related records the `includes` parameter asks for: the bank account, the snapshot of the period's transactions taken at completion, the transactions that couldn't be reconciled, the changes made after completion, the ledger balances and the Bank Sync matches. ##### Use Cases - Show a reconciliation report: its totals with `transactions` and `ledgerBalances`. - Check what changed after completion (`reconciliationChangeTransactions`, `changeTransactionBalance`). ##### Business Rules - No permission is checked beyond a valid API key. - A key restricted to any portfolio group gets 403 `{"error": "Access Denied"}`. - An ID with no reconciliation answers 400 `{"error": "Reconciliation not found"}`. ##### Available Includes (6) - `bankAccount` - The bank account, every column of it. - `transactions` - Every unreconciled item dated on or before the statement end date when the reconciliation was completed (older ones included), cleared or not. - `unreconcilableTransactions` - The payments and payouts in the period that couldn't be reconciled at completion, grouped by why; every group is always sent, as an empty list when it has none. - `reconciliationChangeTransactions` - The transactions reconciled into or removed from the reconciliation on their own after completion, leaving out the ones a void cancelled. Also adds `changeTransactionBalance`. - `ledgerBalances` - Each ledger's balance in the bank account at the statement end date, leaving out ledgers whose balances are both zero. - `matchedBankTransactions` - The Bank Sync transactions confirmed as matches for the cleared items, grouped by item. ##### Related Endpoints - `GET /accounting/reconciliations` - List reconciliations. - `DELETE /accounting/reconciliations/{reconciliationID}` - Void this reconciliation. - `POST /accounting/transactions/{transactionID}/reconcile` - Reconcile one more transaction into it. Parameters: - `reconciliationID` (path, integer, required): The reconciliation's ID, from `GET /accounting/reconciliations`. - `includes` (query, string): Comma-separated related records to add: `bankAccount`, `transactions`, `unreconcilableTransactions`, `reconciliationChangeTransactions`, `ledgerBalances`, `matchedBankTransactions`. Names it doesn't recognise are ignored. Responses: - `200`: The reconciliation, with the includes that were asked for. - `application/json`: object - `reconciliation` (`included_reconciliation`, required) - `bankAccount` (`account-2`) - `transactions` (object[]): The unreconciled items dated on or before the statement end date at completion. Requires the `transactions` include. - `reconciliationTransaction` (`reconciliation_transaction`, required) - `token` (string, required, pattern `^[0-9]+$`): The server's current Unix time when the list was read, as a string of digits. Carries no meaning for the row. - `unreconcilableTransactions` (object): The period's payments and payouts that couldn't be reconciled at completion, by reason. Requires the `unreconcilableTransactions` include. - `undepositedPayments` (`reconciliation_unreconcilable_transaction`[], required): Payments received in the period but not yet deposited (type `1`). - `paymentDepositedAfterStatementEndDate` (`reconciliation_unreconcilable_transaction`[], required): Payments received in the period but deposited after it (type `2`). - `unsettledElectronicTransaction` (`reconciliation_unreconcilable_transaction`[], required): Electronic payments, payouts and payout returns not settled by the end of the period (type `3`). - `electronicTransactionSettledAfterStatementEndDate` (`reconciliation_unreconcilable_transaction`[], required): Electronic transactions in the period that settled after it (type `4`). - `reconciliationChangeTransactions` (object[]): The changes made after completion, without the voided ones. Requires the `reconciliationChangeTransactions` include. - `reconciliationChangeTransaction` (`reconciliation_change_transaction`, required) - `changeTransactionBalance` (number): Net of the changes in `reconciliationChangeTransactions`: money in added and money out removed count positive, money out added and money in removed count negative. A JSON number (`-15`, `0`), since the API computes it. Sent with the `reconciliationChangeTransactions` include. - `ledgerBalances` (object[]): Each ledger's share of the bank account's balance at the statement end date, without the ledgers whose current and future balances are both zero. Requires the `ledgerBalances` include. - `ledger` (object, required): The ledger. - `ledgerID` (string, required, pattern `^-?[0-9]+$`): The ledger's ID. - `name` (string, required, max length 200): The ledger's name. - `ledgerBalance` (object, required): The ledger's balances in the bank account. - `currentBalance` (string, decimal, required): The ledger's balance in the bank account as of the statement end date. - `futureBalance` (string | null, decimal, required): The ledger's balance including transactions dated after the statement end date, or null. - `matchedBankTransactions` (one of several shapes): The Bank Sync transactions confirmed as matches for the items this reconciliation cleared, keyed by the item (`_`, such as `4_51` for deposit 51). An empty JSON array (`[]`), not an object, when there are none. Requires the `matchedBankTransactions` include. - One of: - Option 1: object - Option 2: `reconciliation_matched_bank_transaction`[] Example: ```json { "reconciliation": { "reconciliationID": "147", "reconciliationVersionID": "2", "bankAccountID": "363", "statementStartDate": "2026-06-18", "statementEndDate": "2026-07-18", "statementEndingBalance": "24996.25", "isCurrent": "1", "isVoided": "0", "previousStatementEndingBalance": "3842.06", "moneyInTotal": "0.00", "moneyOutTotal": "0.00", "reconciledMoneyInTotal": "0.00", "reconciledMoneyOutTotal": "0.00", "unreconciledMoneyInTotal": "0.00", "unreconciledMoneyOutTotal": "0.00", "reconciledBalance": "0.00", "adjustedCashBalance": "0.00", "bankAccountBalance": "0.00", "undepositedPaymentsBalance": "0.00", "paymentsDepositedAfterStatementEndDateBalance": "0.00", "unsettledElectronicTransactionsBalance": "0.00", "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00", "adjustmentsTotal": "0.00", "reconciledAdjustmentsTotal": "0.00", "unreconciledAdjustmentsTotal": "0.00", "bankAdjustmentBalance": "0.00", "bankAccountUndepositedBalance": "0.00", "unsettledPaymentBalance": "0.00", "unsettledPaymentReturnBalance": "0.00", "unsettledPayoutBalance": "0.00", "unsettledPayoutReturnBalance": "0.00", "createdByUserID": "2", "dateTimeCreated": "2026-11-14 21:15:40" }, "bankAccount": { "accountID": "363", "parentAccountID": null, "accountTypeID": "3", "accountCategoryID": null, "number": "889749", "name": "Operating Checking", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "0", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": "First Example Bank", "bankAccountTypeID": null, "bankAccountCiphertextID": null, "bankAccountNumberTruncated": null, "bankAccountAddress": null, "bankAccountAddress2": null, "bankAccountCity": null, "bankAccountStateID": null, "bankAccountPostalCode": null, "bankAccountCountryID": null, "isCheckingEnabled": "0", "checkCompanyName": null, "checkSignatory": null, "checkAddress": null, "checkAddress2": null, "checkCity": null, "checkStateID": null, "checkPostalCode": null, "checkCountryID": null, "bankAccountNextCheckNumber": null, "bankAccountNextDepositNumber": null, "checkTemplateID": null, "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "0", "isNachaFileBalanced": "0", "nachaOriginName": null, "nachaOriginNumber": null, "nachaDestinationName": null, "nachaDestinationNumber": null, "nachaCompanyIdentification": null, "nachaCompanyName": null, "nachaOriginatingFinancialInstitutionID": null, "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2026-11-14 21:15:40", "dateTimeModified": "2026-11-14 21:15:40", "dateTimeDeactivated": null }, "transactions": [ { "reconciliationTransaction": { "reconciliationTransactionID": "24", "reconciliationID": "147", "isReconciled": "1", "reconciliationTransactionTypeID": "1", "reconciliationObjectTypeID": "4", "objectID": "53", "transactionEntryTransactionID": "123", "datePosted": "2026-04-15", "description": "April rent deposit", "reference": "DEP-1042", "amount": "100.00" }, "token": "1794690941" } ], "unreconcilableTransactions": { "undepositedPayments": [ { "unreconcilableTransactionID": "21", "reconciliationID": "147", "unreconcilableTransactionTypeID": "1", "objectTypeID": "9", "objectID": "123", "transactionTypeID": "9", "transactionID": "123", "datePosted": "2026-04-29", "description": "Monthly service fee", "reference": "FEE-0426", "amount": "15.00" } ], "paymentDepositedAfterStatementEndDate": [ { "unreconcilableTransactionID": "22", "reconciliationID": "147", "unreconcilableTransactionTypeID": "2", "objectTypeID": "9", "objectID": "123", "transactionTypeID": "9", "transactionID": "123", "datePosted": "2026-04-29", "description": "Monthly service fee", "reference": "FEE-0426", "amount": "15.00" } ], "unsettledElectronicTransaction": [ { "unreconcilableTransactionID": "23", "reconciliationID": "147", "unreconcilableTransactionTypeID": "3", "objectTypeID": "9", "objectID": "123", "transactionTypeID": "9", "transactionID": "123", "datePosted": "2026-04-29", "description": "Monthly service fee", "reference": "FEE-0426", "amount": "15.00" } ], "electronicTransactionSettledAfterStatementEndDate": [ { "unreconcilableTransactionID": "24", "reconciliationID": "147", "unreconcilableTransactionTypeID": "4", "objectTypeID": "9", "objectID": "123", "transactionTypeID": "9", "transactionID": "123", "datePosted": "2026-04-29", "description": "Monthly service fee", "reference": "FEE-0426", "amount": "15.00" } ] }, "reconciliationChangeTransactions": [ { "reconciliationChangeTransaction": { "reconciliationChangeTransactionID": "36", "reconciliationID": "147", "bankAccountID": "363", "reconciliationChangeTypeID": "1", "reconciliationTransactionTypeID": "2", "reconciliationObjectTypeID": "6", "objectID": "123", "transactionEntryTransactionID": "123", "datePosted": "2026-04-29", "description": "Monthly service fee", "reference": "FEE-0426", "amount": "15.00", "dateTimeCreated": "2026-11-14 21:15:40" } } ], "changeTransactionBalance": -15, "ledgerBalances": [ { "ledger": { "ledgerID": "155", "name": "NKDN9522 - Maple Street Rentals" }, "ledgerBalance": { "currentBalance": "1250.00", "futureBalance": "1310.00" } } ], "matchedBankTransactions": { "4_53": [ { "reconciliationBankTransactionID": "12", "reconciliationBankStatementID": "22", "sourceKey": "linked-1", "datePosted": "2026-04-15", "amount": "100.00", "bankTransactionTypeID": "1", "description": null, "reference": null, "confidence": 95, "reconciliationBankTransactionMatchID": 12, "reconciliationID": 147 } ] } } ``` - `400`: No reconciliation has this ID. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Reconciliation 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The key is restricted to one or more portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Reconciliation `DELETE /accounting/reconciliations/{reconciliationID}` Operation ID: `voidReconciliation` Voids a bank account's current reconciliation: everything it reconciled becomes unreconciled again, and the reconciliation before it becomes current. The voided reconciliation stays readable, with `isVoided` `1`. ##### Use Cases - Redo a reconciliation completed with the wrong items or balance: void it, then complete it again. ##### Business Rules - Requires the **Void Reconciliations** permission (`Accounting` › `VoidReconciliations`); without it the API answers 403 `{"error": "Permission Denied"}`. - A key restricted to any portfolio group gets 403 `{"error": "Access Denied"}`. - Only the bank account's current reconciliation can be voided, one at a time from the newest; an older one, or one already voided, answers 400 `Only the most current reconciliation can be deleted`. - An ID with no reconciliation answers 400 `{"error": "Reconciliation not found"}`. - Only one completion, void or Bank Sync matching run works on a bank account at a time: while another holds it the API answers 400 `This reconciliation is being updated, please try again.` ##### Side Effects - The reconciliation is kept, marked voided and no longer current. - Every deposit, payment, transfer, adjustment and transaction it reconciled, those reconciled into it after completion included, is unreconciled; each keeps the voided reconciliation's ID as its `previousReconciliationID`. - Each item it unreconciles gets the matching "… Unreconciled" entry in its activity history ("Deposit Unreconciled", "Payout Unreconciled", "Transaction Unreconciled", and the rest as on create). A transaction entry gets none. - Its change records are voided, so the `reconciliationChangeTransactions` include no longer lists them. - The bank account's newest reconciliation that isn't voided becomes current again. - With Bank Sync, the bank transactions it had cleared go back to the bank account's in-progress reconciliation, so the redo can match them again. ##### Related Endpoints - `GET /accounting/reconciliations/{reconciliationID}` - Read the voided reconciliation. - `POST /accounting/reconciliations` - Complete the reconciliation again. Parameters: - `reconciliationID` (path, integer, required): The reconciliation's ID, from `GET /accounting/reconciliations` (use `isCurrent=true` to find the one that can be voided). Responses: - `200`: The reconciliation was voided. The body is the record as it was read before the void, with the two flags the void changed. - `application/json`: `reconciliation_voided` Example: ```json { "reconciliationID": "259", "reconciliationVersionID": "2", "bankAccountID": "560", "statementStartDate": "2026-04-01", "statementEndDate": "2026-04-30", "statementEndingBalance": "3450.00", "isCurrent": 0, "isVoided": 1, "previousStatementEndingBalance": "1000.00", "moneyInTotal": "2450.00", "moneyOutTotal": "0.00", "reconciledMoneyInTotal": "2450.00", "reconciledMoneyOutTotal": "0.00", "unreconciledMoneyInTotal": "0.00", "unreconciledMoneyOutTotal": "0.00", "reconciledBalance": "3450.00", "adjustedCashBalance": "0.00", "bankAccountBalance": "0.00", "undepositedPaymentsBalance": "0.00", "paymentsDepositedAfterStatementEndDateBalance": "0.00", "unsettledElectronicTransactionsBalance": "0.00", "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00", "adjustmentsTotal": "0.00", "reconciledAdjustmentsTotal": "0.00", "unreconciledAdjustmentsTotal": "0.00", "bankAdjustmentBalance": "0.00", "bankAccountUndepositedBalance": "0.00", "unsettledPaymentBalance": "0.00", "unsettledPaymentReturnBalance": "0.00", "unsettledPayoutBalance": "0.00", "unsettledPayoutReturnBalance": "0.00", "createdByUserID": "213", "dateTimeCreated": "2026-11-14 21:18:36" } ``` - `400`: The reconciliation can't be voided, doesn't exist, or another run holds its bank account. - `application/json`: one of several shapes - One of: - Option 1: object - `error` (string, required) - Option 2: object - `reconciliationID` (string[], required) Example: ```json { "reconciliationID": [ "Only the most current reconciliation can be deleted" ] } ``` - `401`: see shared response `error_401` - `403`: The key lacks the permission, or is restricted to one or more portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ### Transactions #### Search Transactions `GET /accounting/transactions/search` Operation ID: `searchTransactions` Returns a paginated, searchable list of accounting transactions with associated ledger, property, portfolio, and unit context. Each result item contains the transaction plus denormalized lookup data useful for display in transaction lists and reports. ##### Use Cases - Search transactions by date range, amount, or text for audit and reconciliation. - Filter by `transactionTypeIDs` to show only specific payment types (e.g. rent payments). - Filter by `primaryLedgerIDs` to scope results to a specific bank account ledger. - Pull recent transactions modified after a given timestamp for sync workflows. ##### Business Rules - Results are restricted to the authenticated user's portfolio. - Both `propertyIDs` (comma-separated) and `propertyID` (single integer) are accepted; `propertyIDs` takes precedence. - Similarly, `transactionTypeIDs` takes precedence over `transactionTypeID`. - The `ledger`, `property`, `portfolio`, and `unit` fields are joined from related tables and may be null if the transaction has no associated property or unit. ##### Related Endpoints - `GET /accounting/transactions/entries/search` - Search individual debit/credit entries. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `isVoided` (query, boolean): Filter by isVoided - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `datePostedMin` (query, string, date): Filter by minumum datePosted - `datePostedMax` (query, string, date): Filter by maximum datePosted - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `transactionTypeIDs[]` (query, integer[]): Filter by an array of transactionTypeIDs - `propertyIDs[]` (query, integer[]): Filter by an array of propertyIDs - `transactionEntriesLedgerIDs[]` (query, integer[]): Filter by an array of transactionEntriesLedgerIDs - `primaryLedgerIDs[]` (query, integer[]): Filter by an array of primaryLedgerIDs - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved matching transactions. - `application/json`: object[] - Each item: - `transaction` (`transaction`, required) - `ledger` (object | null) - `ledgerID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `property` (object | null) - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `isMultiUnit` (string, one of "0", "1") - `portfolio` (object | null) - `portfolioID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `unit` (object | null) - `unitID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `transactionEntries` (object): Aggregated data from the transaction's debit/credit entries. - `ledgerNames` (string | null): Comma-separated list of ledger names involved in this transaction's entries. Example: ```json [ { "transaction": { "transactionID": "9901", "transactionTypeID": "1", "primaryLedgerID": "401", "billID": null, "bulkPaymentID": null, "payoutID": null, "payoutReturnID": null, "contactID": null, "amount": "1500.00", "description": "Rent Income", "reference": null, "isVoided": "0", "datePosted": "2024-10-01", "dateTimeCreated": "2024-10-01 08:00:00", "dateTimeModified": "2024-10-01 08:00:00" }, "ledger": { "ledgerID": "401", "name": "Smith Portfolio Trust" }, "property": { "propertyID": "100", "name": "123 Main St", "address": "123 Main St", "address2": null, "city": "Springfield", "stateID": "IL", "postalCode": "62701", "isMultiUnit": "0" }, "portfolio": { "portfolioID": "50", "name": "Smith Portfolio" }, "unit": { "unitID": "200", "name": null, "address": "123 Main St", "address2": null, "city": "Springfield", "stateID": "IL", "postalCode": "62701" }, "transactionEntries": { "ledgerNames": "Smith Portfolio Trust" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Transaction `GET /accounting/transactions/{transactionID}` Operation ID: `getTransaction` Returns one accounting transaction of any type (a charge, a payment, a bill, a journal entry, ...), with the related records the `includes` parameter asks for. Posting a journal entry answers with this same shape. ##### Use Cases - Read a journal entry back after posting it, with its lines (`entries`) and history (`transactionLogs`, `cashEntryArchives`). - Follow a payment return to the payment it returned (`returnedTransaction`), or a payment to its bulk receipt. ##### Business Rules - No permission is checked beyond a valid API key. - A key restricted to some portfolios gets 403 `{"error": "Access Denied"}` for a transaction whose primary ledger it can't access (a manager-ledger transaction needs an unrestricted key). - An ID with no transaction answers 400 `{"error": "Transaction not found"}`. ##### Available Includes (17) - `ledger` - The primary ledger, or null when there is none. - `portfolio` - The portfolio; `false` when the transaction has none. - `property` - The property, or null. - `unit` - The unit, or null. - `lease` - The lease, or null. - `account` - Always null. - `contact` - The contact (tenant, owner or vendor), or null. - `reconciliation` - The reconciliation that reconciled the transaction, or null. - `previousReconciliation` - The reconciliation it was reconciled in before, or null. - `returnedTransaction` - The transaction this one returned, or null. - `bulkPayment` - The bulk receipt the transaction belongs to, or null. - `transactionLogs` - Every change made to the transaction, newest first. - `entries` - The cash-basis lines that aren't voided, newest first, with their ledgers and related records. - `cashEntries` - Every cash-basis line, with its ledger. - `accrualEntries` - Every accrual-basis line, with its ledger. - `cashEntryArchives` - The cash-basis lines a change replaced. - `accrualEntryArchives` - The accrual-basis lines a change replaced. ##### Related Endpoints - `GET /accounting/transactions/search` - Search transactions. - `GET /accounting/journal-entries/search` - Search journal entries. - `DELETE /accounting/journal-entries/{transactionID}` - Void a journal entry. Parameters: - `transactionID` (path, integer, required): The transaction's ID, from `GET /accounting/transactions/search`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `ledger`, `portfolio`, `property`, `unit`, `lease`, `account`, `contact`, `reconciliation`, `previousReconciliation`, `returnedTransaction`, `bulkPayment`, `transactionLogs`, `entries`, `cashEntries`, `accrualEntries`, `cashEntryArchives`, `accrualEntryArchives`. Unknown names are ignored. Responses: - `200`: The transaction, with the includes that were asked for. - `application/json`: `transaction_view` Example: ```json { "transaction": { "transactionID": "101", "transactionTypeID": "11", "managementFeeMode": "2", "primaryLedgerID": "306", "portfolioID": "111", "propertyID": "104", "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "140.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Reclassify October landscaping invoice to repairs", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-10-31", "dateTimeCreated": "2026-11-12 23:44:27", "dateTimeModified": "2026-11-12 23:44:27" } } ``` - `400`: No transaction has this ID. - `application/json`: object - `error` (string, required): `Transaction not found`. Example: ```json { "error": "Transaction 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Reconcile Transaction `POST /accounting/transactions/{transactionID}/reconcile` Operation ID: `reconcileTransaction` Adds one payment return or bank fee to an existing reconciliation of its bank account, outside a full reconciliation: use it for an item that cleared the bank after the reconciliation that should have held it was completed. Answers with the transaction as `GET /accounting/transactions/{transactionID}` returns it, and takes the same `includes`. ##### Use Cases - Reconcile a bank fee or a returned payment that was missed when the statement was reconciled. ##### Business Rules - Requires the **Modify Reconciliations** permission (`Accounting` › `ModifyReconciliations`); without it the API answers 403 `{"error": "Permission Denied"}`. - Only lease payment returns, owner payment returns, other payment returns and bank fees can be reconciled one at a time; other types (deposits have their own endpoint) answer 400 `Transaction type cannot be reconciled`. - The transaction must not be voided or already reconciled, and the reconciliation must belong to the transaction's bank account and not be voided. It doesn't have to be the current one. - A key restricted to portfolio groups can reconcile only transactions in its groups' portfolios; for any other the API answers 400 `{"portfolioID": ["You do not have access to the portfolio"]}` and changes nothing. - A key restricted to portfolio groups can't list reconciliations (403), so it needs the reconciliation's ID from elsewhere: an unrestricted key, or the `previousReconciliationID` of a transaction it removed. - An ID with no transaction answers 400 `{"error": "Transaction not found"}`. ##### Side Effects - The transaction's `reconciliationID` is set, and its `previousReconciliationID` cleared. - A change record (money out added, object type `6` Transaction, whatever the transaction's type) is written to the reconciliation, so its `changeTransactionBalance` falls by the transaction's amount. Reconciling a transaction back into a reconciliation it was removed from, when that reconciliation holds exactly one removal record for it with the same date and amount, deletes that record instead. - A "Transaction Reconciled" entry is added to the transaction's activity history (the Manager screen's history), not to the `transactionLogs` include. ##### Related Endpoints - `POST /accounting/transactions/{transactionID}/unreconcile` - Undo it. - `GET /accounting/reconciliations` - Find the bank account's reconciliations (`bankAccountID`, `isCurrent=true`). - `GET /accounting/reconciliations/{reconciliationID}` - See the change (`includes=reconciliationChangeTransactions`). - `POST /accounting/deposits/{depositID}/reconcile` - Reconcile a deposit. Parameters: - `transactionID` (path, integer, required): The transaction's ID, from `GET /accounting/transactions/search`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `ledger`, `portfolio`, `property`, `unit`, `lease`, `account`, `contact`, `reconciliation`, `previousReconciliation`, `returnedTransaction`, `bulkPayment`, `transactionLogs`, `entries`, `cashEntries`, `accrualEntries`, `cashEntryArchives`, `accrualEntryArchives`. Unknown names are ignored. Request body, required: - `application/json`: object - `reconciliationID` (string | integer, required, pattern `^-?[0-9]+$`): The reconciliation to add the transaction to, from `GET /accounting/reconciliations`. One that doesn't exist answers 400 `Reconciliation is required to reconcile a transaction`. Example: ```json { "reconciliationID": 73 } ``` Responses: - `200`: The transaction was reconciled. The body is the transaction as `GET /accounting/transactions/{transactionID}` returns it, with the includes that were asked for. - `application/json`: `transaction_view` Example: ```json { "transaction": { "transactionID": "49", "transactionTypeID": "9", "managementFeeMode": "1", "primaryLedgerID": "75", "portfolioID": "40", "propertyID": null, "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": "227", "chargeAccountID": "228", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "15.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Monthly service fee", "reference": "FEE-0426", "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": "73", "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-29", "dateTimeCreated": "2026-11-14 21:07:04", "dateTimeModified": "2026-11-14 21:07:05" } } ``` - `400`: The body was refused, the transaction or the reconciliation can't take part, or the transaction doesn't exist. Field errors are keyed by what they concern, each with a list of messages. - `application/json`: object Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The key's role lacks Modify Reconciliations. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Unreconcile Transaction `POST /accounting/transactions/{transactionID}/unreconcile` Operation ID: `unreconcileTransaction` Removes one reconciled transaction from its reconciliation, leaving the rest of the reconciliation as it is. Answers with the transaction as `GET /accounting/transactions/{transactionID}` returns it, and takes the same `includes`. The request has no body. ##### Use Cases - Undo `POST /accounting/transactions/{transactionID}/reconcile`, or take a transaction out of a completed reconciliation it shouldn't be in. ##### Business Rules - Requires the **Modify Reconciliations** permission (`Accounting` › `ModifyReconciliations`); without it the API answers 403 `{"error": "Permission Denied"}`. - The transaction must be reconciled; otherwise 400 `Transaction is not reconciled`. - A key restricted to portfolio groups can unreconcile only transactions in its groups' portfolios; for any other the API answers 400 `{"portfolioID": ["You do not have access to the portfolio"]}` and changes nothing. - An ID with no transaction answers 400 `{"error": "Transaction not found"}`. ##### Side Effects - The transaction's `reconciliationID` is cleared, and its `previousReconciliationID` set to the reconciliation it was removed from. - A change record (money out removed, object type `6` Transaction) is written to that reconciliation, so its `changeTransactionBalance` rises by the transaction's amount: back to where it was for a transaction reconciled into it on its own, above it for one the full reconciliation cleared. - A "Transaction Unreconciled" entry is added to the transaction's activity history (the Manager screen's history), not to the `transactionLogs` include. ##### Related Endpoints - `POST /accounting/transactions/{transactionID}/reconcile` - Reconcile it again. - `GET /accounting/reconciliations/{reconciliationID}` - See the change (`includes=reconciliationChangeTransactions`). - `POST /accounting/deposits/{depositID}/unreconcile` - Unreconcile a deposit. Parameters: - `transactionID` (path, integer, required): The transaction's ID, from `GET /accounting/transactions/search`. - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `ledger`, `portfolio`, `property`, `unit`, `lease`, `account`, `contact`, `reconciliation`, `previousReconciliation`, `returnedTransaction`, `bulkPayment`, `transactionLogs`, `entries`, `cashEntries`, `accrualEntries`, `cashEntryArchives`, `accrualEntryArchives`. Unknown names are ignored. Responses: - `200`: The transaction was removed from its reconciliation. The body is the transaction as `GET /accounting/transactions/{transactionID}` returns it, with the includes that were asked for. - `application/json`: `transaction_view` Example: ```json { "transaction": { "transactionID": "75", "transactionTypeID": "9", "managementFeeMode": "1", "primaryLedgerID": "101", "portfolioID": "53", "propertyID": null, "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": "267", "chargeAccountID": "268", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "15.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Monthly service fee", "reference": "FEE-0426", "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": "88", "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-29", "dateTimeCreated": "2026-11-14 21:07:08", "dateTimeModified": "2026-11-14 21:07:08" } } ``` - `400`: The transaction isn't reconciled, the key can't reach it, or it doesn't exist. - `application/json`: object Example: ```json { "transactionID": [ "Transaction is not reconciled" ] } ``` - `401`: see shared response `error_401` - `403`: The key's role lacks Modify Reconciliations. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Create Other Payment `POST /accounting/other-payments` Operation ID: `createOtherPayment` Records a miscellaneous payment receipt against a ledger (e.g. a Money Order, Cash, or Check received that is not a lease rent payment). Creates a transaction of type `12` (Other Payment) and returns the newly created transaction. ##### Use Cases - Record a cash, check, or money order receipt that isn't a standard rent payment. - Collect HOA dues, utility reimbursements, or other ad-hoc income against a ledger. - Attach scanned copies of receipts via `attachments` (array of `fileID` values). ##### Business Rules - Requires the `ModifyOtherPayments` permission under the `Accounting` component. - `ledgerID` is required and must reference a valid, accessible ledger. - `chargeAccountID` identifies the income account to credit. - `bankAccountID` identifies the bank account to debit. - `paymentTypeID` must be one of the defined payment type integers (1–8). - After a successful save the response is identical to `GET /accounting/other-payments/{transactionID}`. ##### Related Endpoints - `GET /accounting/other-payments/{transactionID}` - Retrieve a specific other payment. - `PUT /accounting/other-payments/{transactionID}` - Update an existing other payment. - `DELETE /accounting/other-payments/{transactionID}` - Void an other payment. Request body, required: - `application/json`: object - `ledgerID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the ledger to post the payment against. - `receivedFrom` (string | null): Name or description of the payer. - `amount` (string | number, decimal, required): Payment amount. - `chargeAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Income account ID to credit. - `datePosted` (string, date, required): Date the payment was received. - `reference` (string | null): Check number, transaction reference, or other identifier. - `description` (string | null): Internal memo describing the payment. - `bankAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Bank account ID to debit. - `attachments` (integer[]): Array of `fileID` integers from previously uploaded files. - `paymentTypeID` (one of several shapes, required) - One of: - Option 1: `payment_types_request` - Option 2: null - `depositID` (string | integer | null, pattern `^-?[0-9]+$`): Deposit ID to associate this payment with, if applicable. Example: ```json { "ledgerID": 1165, "receivedFrom": "123pm", "amount": 1000, "chargeAccountID": 106, "datePosted": "2026-05-15", "reference": "Test Reference", "description": "Test Description", "bankAccountID": 31, "attachments": [], "paymentTypeID": 4 } ``` Responses: - `200`: Other payment successfully created. - `application/json`: object - `transaction` (object, required) - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the created transaction. - `transactionTypeID` (string, required, read-only, pattern `^-?[0-9]+$`): Always `12` for Other Payment. - `managementFeeMode` (string | null, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): Ledger the payment was posted against. - `portfolioID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Portfolio derived from the ledger. - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `contactID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account debited. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account credited. - `equityAccountID` (string | null, pattern `^-?[0-9]+$`) - `destinationBankAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountFilterTypeID` (string | null, pattern `^-?[0-9]+$`) - `prepaymentAccountID` (string | null, pattern `^-?[0-9]+$`) - `unallocatedAccountID` (string | null, pattern `^-?[0-9]+$`) - `payoutID` (string | null, pattern `^-?[0-9]+$`) - `payoutReturnID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal, required): Payment amount as a decimal string. - `amountPaid` (string | null, decimal) - `amountAllocated` (string | null, decimal) - `processingFee` (string | null, decimal) - `convenienceFee` (string | null, decimal) - `convenienceFeeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `reference` (string | null) - `receivedFrom` (string | null): Name of the payer. - `returnTransactionID` (string | null, pattern `^-?[0-9]+$`) - `returnTypeID` (string | null, pattern `^-?[0-9]+$`) - `returnDescription` (string | null) - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`) - `paymentTypeID` (one of several shapes) - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `billCreditTransactionID` (string | null, pattern `^-?[0-9]+$`) - `discountAmount` (string | null, decimal) - `markupAmount` (string | null, decimal) - `managementFeeAmountPaid` (string | null, decimal) - `isAdditionalManagementFee` (string | null, one of "0", "1", null) - `managementFeePercent` (string | null, decimal) - `isSuppressed` (string, required, one of "0", "1"): `0` = visible, `1` = suppressed. - `managementFeeExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeePeriodDate` (string | null, date) - `managementFeeSalesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxAmountPaid` (string | null, decimal) - `managementFeeSalesTaxPercent` (string | null, decimal) - `managementFeeSalesTaxIncomeAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeSalesTaxExpenseAccountID` (string | null, pattern `^-?[0-9]+$`) - `managementFeeBatchID` (string | null, pattern `^-?[0-9]+$`) - `isSalesTaxCharge` (string | null, one of "0", "1", null) - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`) - `salesTaxInitiatedFromTransactionID` (string | null, pattern `^-?[0-9]+$`) - `isVoided` (string, required, one of "0", "1"): `0` = active, `1` = voided. - `bankAccountGatewayID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountGatewayTransactionID` (string | null) - `settlementID` (string | null, pattern `^-?[0-9]+$`) - `paymentAccountName` (string | null) - `paymentAccountNumberTruncated` (string | null) - `depositID` (string | null, pattern `^-?[0-9]+$`) - `reconciliationID` (string | null, pattern `^-?[0-9]+$`) - `previousReconciliationID` (string | null, pattern `^-?[0-9]+$`) - `achStatusID` (string | null, pattern `^-?[0-9]+$`) - `bankTransferID` (string | null, pattern `^-?[0-9]+$`) - `lateFeePeriod` (string | null, pattern `^-?[0-9]+$`) - `isFromManager` (string | null, one of "0", "1", null) - `isMoveInCharge` (string | null, one of "0", "1", null) - `isProrated` (string | null, one of "0", "1", null) - `isMoveOutTransaction` (string | null, one of "0", "1", null) - `moveOutAmount` (string | null, decimal) - `discountMarkupBillChargeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `recurringObjectID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`) - `withholdingTaxContactID` (string | null, pattern `^-?[0-9]+$`) - `datePosted` (string, date, required) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json { "transaction": { "transactionID": "83657", "transactionTypeID": "12", "managementFeeMode": "2", "primaryLedgerID": "1165", "portfolioID": "416", "propertyID": null, "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": "31", "chargeAccountID": "106", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "1000.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Test Description", "reference": "Test Reference", "receivedFrom": "123pm", "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": "4", "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-05-15", "dateTimeCreated": "2026-05-15 18:34:26", "dateTimeModified": "2026-05-15 18:34:26" } } ``` - `400`: Validation error. - `application/json` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Lease Charge `POST /accounting/leases/{leaseID}/charges` Operation ID: `createLeaseCharge` Posts a new charge transaction against a lease. The charge is recorded against the specified chart-of-account entry and immediately increases the lease's outstanding balance. Management fees and sales tax charges may be auto-generated depending on the account's configuration and the portfolio's management fee settings. ##### Use Cases - Posting a one-time rent charge outside the recurring schedule (e.g. a prorated amount or a missed month). - Applying a non-rent fee such as a parking fee, maintenance reimbursement, or NSF fee. - Recording an amenity or utility charge billed directly to the tenant. ##### Business Rules - Requires the **Add Charge** permission under the Leasing component. - The lease must exist and fall within the authenticated user's accessible portfolios; a `400` is returned otherwise. - `chargeAccountID` must reference a valid income-type chart-of-account entry configured for lease charges; invalid accounts are rejected with a `400`. - `datePosted` must be a valid calendar date in `YYYY-MM-DD` format. - `amount` is accepted as a decimal string (e.g. `"1000.00"`). - If the account is subject to management fees, a management fee charge transaction is automatically created and linked to this charge. - If the account is subject to sales tax, a corresponding sales tax charge transaction is automatically created. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/payments` - Apply a payment against this or other charges on the lease. - `GET /accounting/transactions/search` - Search and retrieve existing transactions for the lease. - `GET /leases/{leaseID}/recurring-charges` - Manage recurring charges that auto-generate transactions. Parameters: - `leaseID` (path, integer, required): ID of the lease to post the charge against. Request body, required: - `application/json`: object - `datePosted` (string, date, required): Date the charge should be posted to the ledger (`YYYY-MM-DD`). - `amount` (string | number, decimal, required): Charge amount as a decimal string. - `chargeAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Chart-of-account ID to post this charge against. Must be an income-type account enabled for lease charges. - `description` (string, required): Label for the charge as it appears on statements and the tenant ledger. Example: ```json { "datePosted": "2026-04-25", "amount": "1500.00", "chargeAccountID": "9", "description": "April Rent" } ``` Responses: - `200`: Charge transaction created successfully. - `application/json`: object - `transaction` (`transaction_detail`, required) Example: ```json { "transaction": { "transactionID": "80980", "transactionTypeID": "1", "managementFeeMode": "2", "primaryLedgerID": "1212", "portfolioID": "435", "propertyID": "708", "unitID": "687", "leaseID": "2982", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": "9", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "1000.00", "amountPaid": "0.00", "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Rent Income", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": "0.00", "isAdditionalManagementFee": "0", "managementFeePercent": "0.01", "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": "10", "managementFeeSalesTaxAmountPaid": "0.00", "managementFeeSalesTaxPercent": "7.0000", "managementFeeSalesTaxIncomeAccountID": "9", "managementFeeSalesTaxExpenseAccountID": "38", "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": "0", "isProrated": "0", "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-25", "dateTimeCreated": "2026-04-25 20:08:26", "dateTimeModified": "2026-04-25 20:08:26" } } ``` - `400`: Charge could not be created. - `application/json`: object - `error` (string) Example: ```json { "error": "Lease 2982 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Lease Payment `POST /accounting/leases/{leaseID}/payments` Operation ID: `createLeasePayment` Records a payment received from a tenant against a lease. The payment can be applied to specific outstanding charges via the `receipts` array, applied automatically to the oldest charges first, or held as a prepayment (unapplied credit) for future application. An email receipt is optionally sent to the tenant on success. ##### Use Cases - Recording a rent check payment and applying it to the current month's rent charge. - Accepting a partial payment and holding the remainder as a prepayment. - Applying a payment automatically across all outstanding charges without specifying individual receipts. - Posting an online payment received via the resident portal. ##### Business Rules - Requires the **Add Payment** permission under the Leasing component. - The lease must exist and fall within the authenticated user's accessible portfolios; a `400` is returned otherwise. - `bankAccountID` defaults to the portfolio's primary trust account when `null`; provide a specific bank account ID to override. - `leaseTenantID` identifies which tenant on the lease is making the payment; this controls the `contactID` recorded on the transaction and determines where the email receipt is sent. - `prepaymentAccountID` controls where unallocated funds are held. Use `-1` to apply to the portfolio's default prepayment account. Set `hasPrepayment: true` and supply `prepaymentAmount` to split the payment between charges and prepayment. - If `applyAutomatically` is `true`, the server allocates the payment to outstanding charges from oldest to newest, ignoring the `receipts` array. - If `applyAutomatically` is `false`, supply a `receipts` array specifying which charge transactions to apply the payment to and the amount to apply to each. - `receipts[].chargeTransactionID` must reference a charge transaction on this lease. - The sum of `receipts[].amount` plus `prepaymentAmount` should equal `amount`. - `emailReceipt: true` triggers an email receipt to the tenant identified by `leaseTenantID`. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/charges` - Create a charge before applying a payment. - `GET /accounting/transactions/search` - Search existing payment and charge transactions for the lease. Parameters: - `leaseID` (path, integer, required): ID of the lease to record the payment against. Request body, required: - `application/json`: object - `bankAccountID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the bank account to deposit the payment into. Pass `null` to use the portfolio's default trust account. - `emailReceipt` (boolean, default false): Whether to send a payment receipt email to the tenant identified by `leaseTenantID`. - `leaseID` (string | integer, pattern `^-?[0-9]+$`): ID of the lease (must match the `{leaseID}` path parameter). - `prepaymentAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Account to hold unallocated (prepayment) funds. Use `"-1"` for the portfolio's default prepayment account. Required when `hasPrepayment` is `true`. - `amount` (string | number, decimal, required): Total payment amount as a decimal string. - `datePosted` (string, date, required): Date the payment should be posted to the ledger (`YYYY-MM-DD`). - `prepaymentAmount` (string | number | null, decimal): Portion of `amount` to hold as a prepayment (unapplied credit). Required when `hasPrepayment` is `true`. - `reference` (string | null): External reference number such as a check number or ACH trace ID. - `leaseTenantID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the lease-tenant record identifying the paying tenant. Controls `contactID` on the transaction and email receipt recipient. - `description` (string | null): Free-text label for this payment as it appears on the tenant ledger. - `applyAutomatically` (boolean, default false): When `true`, the server applies the payment to outstanding charges oldest-first, ignoring the `receipts` array. When `false`, use the `receipts` array to specify exactly which charges to apply the payment to. - `receipts` (object[]): List of charge transactions to apply this payment to. Required when `applyAutomatically` is `false` and there are charges to apply the payment against. - `chargeTransactionID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the charge transaction to apply this payment receipt to. - `amount` (string | number, decimal, required): Amount to apply from this payment to the specified charge. - `hasPrepayment` (boolean, default false): Whether any portion of this payment should be held as a prepayment. When `true`, supply `prepaymentAccountID` and `prepaymentAmount`. Example: ```json { "bankAccountID": null, "emailReceipt": true, "leaseID": "2982", "prepaymentAccountID": null, "amount": "1500.00", "datePosted": "2026-04-25", "prepaymentAmount": null, "reference": "1001", "leaseTenantID": "3356", "description": "April rent payment", "applyAutomatically": false, "receipts": [ { "chargeTransactionID": "80976", "amount": 1500 } ], "hasPrepayment": false } ``` Responses: - `200`: Payment transaction created successfully. - `application/json`: object - `transaction` (`transaction_detail`, required) Example: ```json { "transaction": { "transactionID": "80977", "transactionTypeID": "2", "managementFeeMode": "2", "primaryLedgerID": "1212", "portfolioID": "435", "propertyID": "708", "unitID": "687", "leaseID": "2982", "billID": null, "contactID": "5194", "bankAccountID": "46", "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": "1", "prepaymentAccountID": null, "unallocatedAccountID": "3", "payoutID": null, "payoutReturnID": null, "amount": "1000.00", "amountPaid": null, "amountAllocated": "500.00", "processingFee": null, "convenienceFee": "0.00", "convenienceFeeTransactionID": null, "description": "April rent payment", "reference": "1234", "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": "3", "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-04-25", "dateTimeCreated": "2026-04-25 20:01:18", "dateTimeModified": "2026-04-25 20:01:18" } } ``` - `400`: Payment could not be recorded. - `application/json`: object - `error` (string) Example: ```json { "error": "Lease 2982 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Lease Refunded Return `POST /accounting/leases/{leaseID}/refunded-returns` Operation ID: `createLeaseRefundedReturn` Records a refunded return on a lease: a manual tenant credit to the lease's unallocated (prepayment) account, funded from an equity account. It is used when a payment whose credit was already refunded to the tenant comes back from the bank, to restore the credit the refund drew on. It isn't linked to a specific returned payment. The response is the new refunded return as `GET /accounting/leases/refunded-returns/{transactionID}` (undocumented) returns it, with the same includes. ##### Use Cases - Restoring a tenant's credit by hand after a refunded payment was returned, funded from the owner distribution account (the Manager app's default). ##### Business Rules - Requires the **Modify Lease Transactions** permission (`Accounting` › `ModifyLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - The body must not be empty (`{}` counts as empty): `400` `{"error": "invalid input."}`. - `amount` (above `0.00`), `datePosted`, `description`, `equityAccountID` and `unallocatedAccountID` are required; a missing one answers `400` with a validation map keyed `transaction.` (`description`: `Description is required`). - `equityAccountID` must be an equity account (`Equity account must be of type equity`) and `unallocatedAccountID` a prepayment account (`Unallocated account must be of type prepayment`). - A `leaseID` with no lease answers `400` `{"error": "Failed to get lease details"}`, not `404`; for an API user restricted to portfolio groups it answers `403` `{"error": "Access Denied"}` instead, since the restriction check runs first. A path value that isn't a number answers the stock `404`. - A non-numeric `amount` answers `500` with no body. ##### Side Effects - The refunded return posts a credit of `amount` to `unallocatedAccountID` and a debit of `amount` to `equityAccountID`, so the tenant's credit balance rises by `amount`. From the code, not covered by a contract test: - A create entry is added to its transaction log. ##### Available Includes (3) - `property` - the lease's property - `unit` - the lease's unit - `lease` - the lease ##### Related Endpoints - `DELETE /accounting/leases/refunded-returns/{transactionID}` - Void a refunded return. - `POST /accounting/leases/payments/{transactionID}/return` - Return a payment; it records a refunded return by itself when part of the payment's credit had been refunded. - `GET /accounting/accounts/search` - Find the account IDs. Parameters: - `leaseID` (path, integer, required): ID of the lease to credit. - `includes` (query, string): Comma-separated related records to add to the response, each under its own key: `property`, `unit`, `lease`. Request body, required: - `application/json`: object - `amount` (string | number, decimal, required): Amount to credit; must be above `0.00`. - `datePosted` (string, required): Date the refunded return posts to the ledger (`YYYY-MM-DD` or `MM/DD/YYYY`). - `description` (string, required): Free-text description shown on the ledger; required, and can't be blank. - `equityAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Equity account that funds the credit (debited); the Manager app defaults to the owner distribution account. The IDs come from `GET /accounting/accounts/search`. - `unallocatedAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Account that receives the credit; it must be a prepayment account. Use the account the lease's payments hold unapplied credit in (their `unallocatedAccountID`), normally the accounting settings' prepayment account. The IDs come from `GET /accounting/accounts/search`. Example: ```json { "amount": "120.00", "datePosted": "2026-11-09", "description": "Refunded payment returned", "equityAccountID": "453", "unallocatedAccountID": "3" } ``` Responses: - `200`: The new refunded return under `transaction`, plus the requested includes. - `application/json`: object - `transaction` (`lease_transaction`, required) - `property` (`included_property`): The lease's property, with the `property` include. - `unit` (`included_unit`): The lease's unit, with the `unit` include. - `lease` (`included_lease`): The lease, with the `lease` include. Example: ```json { "transaction": { "transactionID": "580", "transactionTypeID": "25", "managementFeeMode": "2", "primaryLedgerID": "888", "portfolioID": "458", "propertyID": "430", "unitID": "430", "leaseID": "430", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": null, "equityAccountID": "453", "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": "3", "payoutID": null, "payoutReturnID": null, "amount": "120.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Refunded payment returned", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 05:07:20", "dateTimeModified": "2026-11-09 05:07:20" } } ``` - `400`: The body is empty or incomplete, or the lease doesn't exist (for an unrestricted API user). - `application/json`: `lease_transaction_error` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_modify_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` - `500`: A non-numeric `amount` makes the amount arithmetic throw; production answers `500` with no body (a local server with debugging on prints an HTML stack trace instead). #### Create Lease Deposit Release Credit `POST /accounting/leases/{leaseID}/deposit-release-credits` Operation ID: `createLeaseDepositReleaseCredit` Releases part or all of a lease's collected security deposit as a tenant credit, and can apply that credit to open charges (final charges at move-out) in the same request. The credit can't release more than was collected on each deposit account, and its parts (`depositReleases`) must add up to its `amount`. The response is the new credit as `GET /accounting/leases/deposit-release-credits/{transactionID}` (undocumented) returns it, with the same includes. ##### Use Cases - Applying a security deposit to move-out charges (cleaning, damages, unpaid rent). - Releasing a deposit as a credit, to refund it with `POST /accounting/leases/{leaseID}/payouts`. ##### Business Rules - Requires the **Modify Lease Transactions** permission (`Accounting` › `ModifyLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - The body must not be empty (`{}` counts as empty): `400` `{"error": "invalid input."}`. - At least one deposit release is required, each naming a deposit liability account the lease has collected a deposit on, for no more than its collected balance; and the releases must add up to `amount`. Each failure answers `400` with its message (see the examples). - `description` is required: without it the API answers `400` `{"depositReleaseCredit.description": ["Description is required"]}`. - An account whose collected deposit is already fully released counts as not collected, and answers `Cannot release a deposit that has not been collected`. - Each `receipts` entry must name an open charge on this lease: a charge on another lease answers `400` `{"depositReleaseCredit.receipt.receipt": ["Invalid Charge or Payment."]}`, and one that doesn't exist `{"depositReleaseCredit.receipt.receipt": ["Could not locate receipt charge transaction"]}`. Applying more than a charge's open amount (`depositReleaseCredit.receipt.charge.amountPaid`), or more than the credit (`depositReleaseCredit.receipt.payment.amountAllocated`), answers `400` (see the examples). - A `leaseID` with no lease has no collected deposit, so it answers `400` `{"depositRelease": ["Cannot release a deposit that has not been collected"]}`, not `404`; for an API user restricted to portfolio groups it answers `403` `{"error": "Access Denied"}` instead, since the restriction check runs first. A path value that isn't a number answers the stock `404`. - A non-numeric `amount` answers `500` with no body. ##### Side Effects - A deposit-release credit (type `19`) is posted for `amount`, and one deposit-release row is written per `depositReleases` entry; the collected deposit left to release drops by `amount`. - Each `receipts` entry applies the credit to that charge. From the code, not covered by a contract test: - The credit posts to the account settings' security-deposit release account (or, when there is none, the unallocated credit account), so its unapplied part is a tenant credit. - A create entry is added to its transaction log, and the lease's last-activity date is updated. - Applying the credit to a charge takes the management fee due on that charge, as any payment does: the charge's and the receipt's `managementFeeAmountPaid` rise (seen on a live call, where 12.50 was taken on a 125.00 charge). ##### Available Includes (7) - `account` - always `false`: the include looks up a column these transactions don't have - `contact` - always `false`: a deposit-release credit has no contact - `lease` - the lease - `property` - the lease's property - `unit` - the lease's unit - `receipts` - the charges the credit was applied to - `depositReleases` - the credit's deposit-release rows ##### Related Endpoints - `DELETE /accounting/leases/deposit-release-credits/{transactionID}` - Void a deposit-release credit. - `GET /accounting/leases/{leaseID}/charges/for-payment` (undocumented) - Find the lease's open charges for `receipts`. - `GET /leases/{leaseID}/deposit-balances` (undocumented) - The deposit accounts the lease has collected on, with the balance left to release on each. Parameters: - `leaseID` (path, integer, required): ID of the lease whose deposit is released. - `includes` (query, string): Comma-separated related records to add to the response, each under its own key: `account`, `contact`, `lease`, `property`, `unit`, `receipts`, `depositReleases`. Request body, required: - `application/json`: object - `amount` (string | number, decimal, required): Amount to release; must equal the sum of `depositReleases[].amount`. - `datePosted` (string, required): Date the credit posts to the ledger (`YYYY-MM-DD` or `MM/DD/YYYY`). - `description` (string, required): Free-text description shown on the ledger; required, and can't be blank. - `depositReleases` (object[], required): The deposit accounts to release from, and how much from each. - `liabilityAccountID` (string | integer, required, pattern `^-?[0-9]+$`): A deposit liability account the lease has collected a deposit on. The accounts and the balance left on each come from `GET /leases/{leaseID}/deposit-balances` (undocumented). - `amount` (string | number, decimal, required): Amount to release from that account; no more than its collected balance on the lease. - `receipts` (object[]): Open charges on the lease to apply the credit to, and how much to each. Optional. - `chargeTransactionID` (string | integer, required, pattern `^-?[0-9]+$`): An open charge on the lease. The IDs come from `GET /accounting/leases/{leaseID}/charges/for-payment` (undocumented). - `amount` (string | number, decimal, required): Amount of the credit to apply to that charge. - `datePosted` (string): Date the application posts (`YYYY-MM-DD` or `MM/DD/YYYY`); defaults to the credit's `datePosted`. Example: ```json { "amount": "400.00", "datePosted": "2026-11-09", "description": "Security deposit applied to final charges", "depositReleases": [ { "liabilityAccountID": "360", "amount": "400.00" } ], "receipts": [ { "chargeTransactionID": "451", "amount": "250.00" } ] } ``` Responses: - `200`: The new deposit-release credit under `transaction`, plus the requested includes. - `application/json`: object - `transaction` (`lease_transaction`, required) - `account` (boolean, one of false): With the `account` include, always `false`: it looks up the transaction's `accountID`, which these transactions don't have. - `contact` (boolean, one of false): With the `contact` include, always `false`; a deposit-release credit has no contact. - `lease` (`included_lease`): The lease, with the `lease` include. - `property` (`included_property`): The lease's property, with the `property` include. - `unit` (`included_unit`): The lease's unit, with the `unit` include. - `receipts` (object[]): The credit's receipts that aren't voided, with the `receipts` include: the receipt, and the charge and payout it applies to (left joins, so a missing one arrives with every value null). - `receipt` (`included_receipt`, required) - `charge` (`included_transaction_left_joined`, required) - `payout` (`included_payout_left_joined`, required) - `depositReleases` (`included_deposit_release`[]): The credit's deposit-release rows, with the `depositReleases` include. Example: ```json { "transaction": { "transactionID": "452", "transactionTypeID": "19", "managementFeeMode": "2", "primaryLedgerID": "741", "portfolioID": "382", "propertyID": "359", "unitID": "359", "leaseID": "359", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": "56", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": "56", "payoutID": null, "payoutReturnID": null, "amount": "400.00", "amountPaid": null, "amountAllocated": "250.00", "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Security deposit applied to final charges", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 05:06:47", "dateTimeModified": "2026-11-09 05:06:47" } } ``` - `400`: The body is empty or incomplete, the releases don't fit the collected deposit or the amount, or a receipt names a wrong charge. - `application/json`: `lease_transaction_error` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_modify_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` - `500`: A non-numeric `amount` makes the amount arithmetic throw; production answers `500` with no body (a local server with debugging on prints an HTML stack trace instead). #### Create Lease Payout `POST /accounting/leases/{leaseID}/payouts` Operation ID: `createLeasePayout` Refunds a tenant's credit balance: creates a payout batch holding one payout to the tenant, paid from the given bank account, and applies it to the tenant's payments or credits through `receipts`. Nothing is paid until the batch is approved; the batch is created unapproved unless `isApproved` is sent and honoured (see Business Rules). ##### Use Cases - Refunding a tenant's remaining credit (a prepayment, an overpayment) by check at move-out. - Refunding a credit by ACH to the tenant's bank account, entered or saved. ##### Business Rules - Requires the **Modify Lease Transactions** permission (`Accounting` › `ModifyLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - The body must not be empty (`{}` counts as empty): `400` `{"error": "invalid input."}`. - A `leaseID` with no lease answers `400` `{"error": "Lease 999999999 not found"}`, not `404`. A path value that isn't a number answers the stock `404`. - `isApproved: true` approves the batch only when the API key's role also has the **Approve Payout Batch** permission (`Accounting` › `ApproveBillPay`). Without it the flag is silently ignored and the batch is created unapproved, with a `200`. - Approving needs an MFA code only when the accounting setting `isMFACodeRequiredForPayoutApproval` is on: then `isApproved: true` without `mfaCode` answers `400` `{"mfaCode": ["MFA Code is Required"]}`, and a wrong code `{"mfaCode": ["MFA Code is Invalid"]}`. - The receipts must add up to `amount` exactly, and no receipt may apply more than what is left of the payment or credit it names; otherwise `400` (see the examples). - The payee, from the code (the tests cover `leaseTenantID` and an unknown `contactID`): `contactID` when sent; else the contact of `leaseTenantID`, which must be on this lease; else the lease's first tenant. A `contactID` that names no tenant contact answers `400` `{"payoutBatchContract.checkBatch.checks[0].payeeID": ["Payee cannot be found."]}` (on a check payout). - Each `receipts[].paymentTransactionID` must be a lease payment, credit or deposit-release credit; any other transaction (a charge, say) answers `400` with a validation map naming the payout's liability account (see the `receiptNotAPayment` example). - An ACH payout (`payoutTypeID` `4`, and from the code `3` as well) needs the payee's bank details: a saved `paymentMethodID` or the `refundAch*` fields. Without them it answers `400` with a validation map keyed `payouts[0].`. - A non-numeric `amount` answers `500` with no body. ##### Side Effects - A payout batch is created on `bankAccountID`, with one payout of `amount` to the payee. A check payout takes the bank account's next check number, and the bank account's next check number goes up by one. - Each receipt applies the payout to a tenant payment or credit, so the tenant's credit balance drops by `amount`. - With `isApproved` honoured, the batch is approved and queued for payment; from the code, approval also sends a payout-batch-approved notification and writes a "Payout Batch Modified" log entry. From the code, not covered by a contract test: - An unapproved batch sends the approvers a payout-approval request notification. - The payout's `isMoveOutTransaction` defaults to whether the lease is in move-out (active or completed), unless the body sets it. - A `checkNumber` in the body is used as is, and the bank account's next check number isn't advanced. - A "Payout Batch Created" log entry is written. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/payments` - Record the payment whose credit is refunded. - `GET /accounting/transactions/search` - Find the payments and credits to refund (`receipts[].paymentTransactionID`). - `GET /accounting/accounts/search` - Find the bank account. - `GET /leases/{leaseID}/tenants` - Find the tenant (`leaseTenantID`, `contactID`). Parameters: - `leaseID` (path, integer, required): ID of the lease whose tenant is refunded. Request body, required: - `application/json`: object - `bankAccountID` (string | integer, required, pattern `^-?[0-9]+$`): Bank account the payout is paid from; a missing or unknown one answers `400` `{"bankAccount": ["Bank Account not found"]}`. The IDs come from `GET /accounting/accounts/search`. - `datePosted` (string, required): Date the payout batch posts (`YYYY-MM-DD` or `MM/DD/YYYY`). - `payoutTypeID` (string | integer, one of "1", "2", "3", "4", 1, 2, 3, 4, default 2): How the payout is paid; defaults to a check: * `1` - Other (paid outside Rentvine) * `2` - Check * `3` - eCheck (ACH through the payment processor) * `4` - NACHA (ACH through a file sent to the bank) - `amount` (string | number, decimal, required): Payout amount; must equal the sum of `receipts[].amount`. - `receipts` (object[], required): The tenant payments or credits the payout refunds, and how much from each. - `paymentTransactionID` (string | integer, required, pattern `^-?[0-9]+$`): A lease payment or credit with an unapplied amount. The IDs come from `GET /accounting/transactions/search`. - `amount` (string | number, decimal, required): Amount to refund from that payment or credit. - `leaseTenantID` (string | integer, pattern `^-?[0-9]+$`): Tenant on this lease to pay, when `contactID` isn't sent. The IDs come from `GET /leases/{leaseID}/tenants`. - `contactID` (string | integer, pattern `^-?[0-9]+$`): Contact to pay. The tenants' contact IDs come from `GET /leases/{leaseID}/tenants`. - `description` (string | null): Ignored; a payout has no description. Its ledger transaction is described with `memo`. - `memo` (string | null): Memo printed on the check; it also describes the payout's ledger transaction. - `checkPayeeName` (string | null): Name printed on the check. - `checkNumber` (string | null): Check number to use instead of the bank account's next check number. - `payeeAddress` (string | null): Mailing address of the payee. - `payeeAddress2` (string | null): Second address line of the payee. - `payeeCity` (string | null): City of the payee. - `payeeStateID` (string | null): State of the payee; checked against `payeeCountryID`, so send both: a state without a country answers `400` `State does not exist.`. The values come from `GET /states` (undocumented). - `payeePostalCode` (string | null): Postal code of the payee. - `payeeCountryID` (string | null): Country of the payee. The values come from `GET /countries` (undocumented). - `isApproved` (boolean, default false): Approve the batch now. Honoured only when the API key's role has **Approve Payout Batch**; otherwise ignored. - `mfaCode` (string | null): The approver's MFA code, needed with `isApproved: true` only when the setting `isMFACodeRequiredForPayoutApproval` is on. - `isMoveOutTransaction` (boolean | null): Mark the payout as a move-out refund, or not; when absent or null, it follows the lease's move-out state. - `paymentMethodID` (string | integer | null, pattern `^-?[0-9]+$`): For an ACH payout (`payoutTypeID` `3` or `4`): a saved ACH payment method of the payee to pay to, instead of the `refundAch*` fields. An ID that isn't one of the payee's saved ACH methods answers `400` `{"error": "Saved payment method not found"}`. The IDs come from `GET /leases/{leaseID}/payment-methods` (undocumented). - `refundAchAccountTypeID` (one of several shapes): For an ACH payout without `paymentMethodID`, the payee's bank account type. * `1` - Savings * `2` - Checking - One of: - Option 1: `bank_account_types_request` - Option 2: null - `refundAchRoutingNumber` (string | null): For an ACH payout without `paymentMethodID`, the payee's routing number. - `refundAchAccountNumber` (string | null): For an ACH payout without `paymentMethodID`, the payee's account number. - `refundAchIsCorporateAccount` (string | integer | boolean | null): For an ACH payout without `paymentMethodID`, whether the payee's bank account is a business account. Example: ```json { "bankAccountID": "437", "datePosted": "2026-11-09", "payoutTypeID": 2, "amount": "150.00", "leaseTenantID": "413", "description": "Move-out credit refund", "memo": "Example memo.", "checkPayeeName": "Jordan Example", "payeeAddress": "123 Main St", "payeeCity": "Springfield", "payeePostalCode": "12345", "receipts": [ { "paymentTransactionID": "558", "amount": "150.00" } ] } ``` Responses: - `200`: The new payout batch. - `application/json`: object - `payoutBatch` (object, required): The payout batch the request created. - `payoutBatchID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the payout batch. - `payoutBundleID` (string | null, required, pattern `^-?[0-9]+$`): Payout bundle the batch belongs to; null for a lease refund. - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): Bank account the batch pays from. - `payoutBatchStatusID` (integer, required, one of 1, 2): Status of the batch, sent as a number (it is set in memory, unlike a read, which sends a string): * `1` - Pending (unapproved) * `2` - Approved - `datePosted` (string, date, required): Date the batch posts. - `dateTimeCreated` (string, required, read-only): When the batch was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json { "payoutBatch": { "payoutBatchID": "22", "payoutBundleID": null, "bankAccountID": "437", "payoutBatchStatusID": 1, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 05:07:14" } } ``` - `400`: The body is empty or invalid, the lease or tenant doesn't exist, or the receipts don't fit. - `application/json`: `lease_transaction_error` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_modify_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` - `500`: A non-numeric `amount` makes the amount arithmetic throw; production answers `500` with no body (a local server with debugging on prints an HTML stack trace instead). #### Void Lease Charge `DELETE /accounting/leases/charges/{transactionID}` Operation ID: `voidLeaseCharge` Voids a posted lease charge. This is not a delete: the charge keeps its row and its history, is flagged voided (`isVoided` `'1'` on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided charge can't be changed or voided again. ##### Use Cases - Reversing a charge posted in error, while keeping it in the lease's history. ##### Business Rules - Requires the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - A transaction ID that doesn't exist answers `400` `{"error": "Charge 999999999 not found"}`, and one that isn't a lease charge answers `400` `{"error": "Transaction not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - A charge that is already voided answers `400` `{"isVoided": ["Cannot modify a voided transaction"]}`. - A charge with any payment or credit applied to it (`amountPaid` above `0.00`) can't be voided: `400` `{"amountPaid": ["Cannot void a charge that has receipts applied. You must reverse all receipts before voiding."]}`. Void the payments and credits applied to it first; the void never frees them. ##### Side Effects - Every ledger entry of the charge is voided, and a void entry is added to its transaction log. - The charge's tenant notification, if it hasn't been sent yet, is dropped. From the code, not covered by a contract test: - If the charge is the lease's renters-insurance charge, the lease's link to it is cleared. - An `updateLeaseCharge` event is recorded, and the lease's last-activity date is updated. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/charges` - Post a charge. - `POST /accounting/leases/{leaseID}/credits` (undocumented) - Credit a charge instead of voiding it. - `GET /accounting/transactions/search` - Find the charge to void (`transactionTypeIDs[]` `1`). Parameters: - `transactionID` (path, integer, required): ID of the lease charge to void. Responses: - `200`: The voided charge, flat (no `transaction` wrapper, unlike a read), sent from memory: `isVoided` and a few other values the void sets arrive as numbers. - `application/json`: `lease_transaction_voided` Example: ```json { "transactionID": "50", "transactionTypeID": "1", "managementFeeMode": "2", "primaryLedgerID": "122", "portfolioID": "62", "propertyID": "60", "unitID": "60", "leaseID": "60", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": "9", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "250.00", "amountPaid": 0, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Carpet Cleaning", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": "0.00", "isAdditionalManagementFee": "0", "managementFeePercent": "10.00", "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": 1, "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": 0, "isProrated": 0, "isMoveOutTransaction": 0, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 04:47:27", "dateTimeModified": "2026-11-09 04:47:28" } ``` - `400`: The charge doesn't exist, isn't a lease charge, is already voided, or has payments or credits applied. - `application/json`: `lease_transaction_error` Example: ```json { "isVoided": [ "Cannot modify a voided transaction" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_void_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Lease Credit `DELETE /accounting/leases/credits/{transactionID}` Operation ID: `voidLeaseCredit` Voids a posted lease credit. This is not a delete: the credit keeps its row and its history, is flagged voided (`isVoided` `'1'` on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided credit can't be changed or voided again. ##### Use Cases - Reversing a credit posted in error, while keeping it in the lease's history. ##### Business Rules - Requires the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - A transaction ID that doesn't exist answers `400` `{"error": "Credit 999999999 not found"}`, and one that isn't a lease credit answers `400` `{"error": "Credit 999999999 not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - A credit that is already voided answers `400` `{"isVoided": ["Cannot modify a voided transaction"]}`. - A credit partly refunded to the tenant by a payout that is still active, even an unapproved one, can't be voided: `400` `{"receipt.isVoided": [...], "credit.receipt.isVoided": [...]}`, both `Cannot void a payout receipt that is associated with an active payout`. Void the payout first with `DELETE /accounting/payouts/{payoutID}` (undocumented). ##### Side Effects - The credit's receipts are voided, so any charge it was applied to is open again. - Every ledger entry of the credit is voided, and a void entry is added to its transaction log. From the code, not covered by a contract test: - The lease's last-activity date is updated. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/credits` (undocumented) - Post a credit. - `GET /accounting/transactions/search` - Find the credit to void (`transactionTypeIDs[]` `3`). Parameters: - `transactionID` (path, integer, required): ID of the lease credit to void. Responses: - `200`: The voided credit, flat (no `transaction` wrapper, unlike a read), sent from memory: `isVoided` and a few other values the void sets arrive as numbers. - `application/json`: `lease_transaction_voided` Example: ```json { "transactionID": "66", "transactionTypeID": "3", "managementFeeMode": "2", "primaryLedgerID": "155", "portfolioID": "79", "propertyID": "76", "unitID": "76", "leaseID": "76", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": "9", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": "4", "payoutID": null, "payoutReturnID": null, "amount": "75.00", "amountPaid": null, "amountAllocated": 0, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Rent concession", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": 1, "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": "0", "isMoveInCharge": 0, "isProrated": 0, "isMoveOutTransaction": 0, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 04:48:08", "dateTimeModified": "2026-11-09 04:48:08" } ``` - `400`: The credit doesn't exist, isn't a lease credit, is already voided, or was partly refunded by an active payout. - `application/json`: `lease_transaction_error` Example: ```json { "isVoided": [ "Cannot modify a voided transaction" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_void_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Lease Payment `DELETE /accounting/leases/payments/{transactionID}` Operation ID: `voidLeasePayment` Voids a posted lease payment. This is not a delete: the payment keeps its row and its history, is flagged voided (`isVoided` `'1'`), is taken out of its bank deposit, and its receipts and ledger entries are voided, so the charges it paid are open again and it no longer counts toward the lease's balance. The response is the voided payment as `GET /accounting/leases/payments/{transactionID}` (undocumented) returns it, with the same includes. ##### Use Cases - Reversing a payment entered in error (wrong lease, wrong amount, a duplicate). - Reversing a check that was never deposited. A deposited payment that bounced is returned instead (`POST /accounting/leases/payments/{transactionID}/return`), which keeps the payment and records the return. ##### Business Rules - Requires the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - A transaction ID that doesn't exist, or isn't a lease payment, answers `400` `{"error": "Payment 999999999 not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - These payments can't be voided, each answering `400` with a validation map: - already voided: `{"isVoided": ["Cannot modify a voided transaction"]}`; - gateway-connected (an online payment): `{"isVoided": ["Cannot void a gateway connected transaction"]}`; - returned: `{"isVoided": ["Transaction has been returned and cannot be voided"]}`; - reconciled: `{"depositID": [...], "deposit.transaction.depositID": [...]}`, both `Cannot remove deposit from reconciled transaction`; - part of a bulk payment (bulk receipt) that isn't voided: `{"isVoided": ["Cannot void a transaction that is connected to a bulk payment that is not voided"]}`. Once the bulk payment is voided, its payments can be voided one by one; - partly refunded to the tenant by a payout that is still active, even an unapproved one: `{"receipt.isVoided": [...], "payment.receipt.isVoided": [...]}`, both `Cannot void a payout receipt that is associated with an active payout`. Void the payout first with `DELETE /accounting/payouts/{payoutID}` (undocumented). ##### Side Effects - The payment is taken out of its bank deposit (`depositID` becomes null). - Its receipts are voided, so every charge it paid is open again. - Every ledger entry of the payment is voided, and a void entry is added to its transaction log. From the code, not covered by a contract test: - The lease's last-activity date is updated. ##### Available Includes (12) - `deposit` - the bank deposit; always `false` after a void, which takes the payment out of its deposit - `contact` - the paying tenant's contact - `lease` - the lease - `portfolio` - the portfolio the payment posted to - `property` - the lease's property - `unit` - the lease's unit - `propertyPortfolios` - every ownership period of the property - `returnTransaction` - the return transaction; always null here, since a returned payment can't be voided - `bulkPayment` - the bulk payment it belongs to, or null - `transactionLogs` - the payment's change log, the void included - `receipts` - receipts that aren't voided; always empty after a void - `managementFees` - management fees that aren't voided; empty after a void ##### Related Endpoints - `POST /accounting/leases/{leaseID}/payments` - Record a payment. - `POST /accounting/leases/payments/{transactionID}/return` - Return a deposited payment instead of voiding it. - `GET /accounting/transactions/search` - Find the payment to void (`transactionTypeIDs[]` `2`). Parameters: - `transactionID` (path, integer, required): ID of the lease payment to void. - `includes` (query, string): Comma-separated related records to add to the response, each under its own key: `deposit`, `contact`, `lease`, `portfolio`, `property`, `unit`, `propertyPortfolios`, `returnTransaction`, `bulkPayment`, `transactionLogs`, `receipts`, `managementFees`. Responses: - `200`: The voided payment under `transaction`, plus the requested includes. - `application/json`: `lease_payment_view` Example: ```json { "transaction": { "transactionID": "234", "transactionTypeID": "2", "managementFeeMode": "2", "primaryLedgerID": "394", "portfolioID": "203", "propertyID": "191", "unitID": "191", "leaseID": "191", "billID": null, "contactID": "192", "bankAccountID": "219", "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": "1", "prepaymentAccountID": null, "unallocatedAccountID": "3", "payoutID": null, "payoutReturnID": null, "amount": "500.00", "amountPaid": null, "amountAllocated": "0.00", "processingFee": null, "convenienceFee": "0.00", "convenienceFeeTransactionID": null, "description": "Rent payment", "reference": "1042", "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": "3", "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "1", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 04:52:11", "dateTimeModified": "2026-11-09 04:52:11" } } ``` - `400`: The payment doesn't exist, isn't a lease payment, or can't be voided. - `application/json`: `lease_transaction_error` Example: ```json { "isVoided": [ "Cannot modify a voided transaction" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_void_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Return Lease Payment `POST /accounting/leases/payments/{transactionID}/return` Operation ID: `returnLeasePayment` Records that a deposited lease payment came back from the bank (a bounced check, an NSF). The payment itself is kept unchanged except that it now points at a new return transaction (`returnTransactionID`), which reverses it for the full amount on the same bank account. The charges the payment paid are open again. Optionally, a bank fee and a tenant charge (an NSF fee) are posted in the same request. The response is the original payment, not the return: request `includes=returnTransaction` to get the return transaction too. It is the payment as `GET /accounting/leases/payments/{transactionID}` (undocumented) returns it, with the same includes. ##### Use Cases - Recording a tenant's bounced check, and charging the tenant the lease's NSF fee in the same call. - Recording a returned payment and the bank's return fee, when management fees are kept in the ledger. ##### Business Rules - Requires the **Modify Lease Transactions** permission (`Accounting` › `ModifyLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - The body must not be empty (`{}` counts as empty): `400` `{"error": "invalid input."}`. It must hold a `return` object with a `datePosted`. The checks run in this order: the body; whether the payment is voided or already returned; the `return` object; whether the payment is deposited; and only then the return's own fields. - A transaction ID that doesn't exist, or isn't a lease payment, answers `400` `{"error": "Payment 999999999 not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - Only a payment that is deposited, not voided and not already returned can be returned. A voided or an already returned payment answers `{"payment": ["This payment cannot be returned"]}`; one that isn't in a bank deposit answers `{"transactionID": ["Cannot return a payment that has not been deposited."]}`. A payment in a bulk payment (bulk receipt) is never in a deposit of its own, so it gets the same not-deposited answer. - An online (gateway-connected) payment can't be returned through this API: its returns come from the payment processor, and the request answers `{"return.bankAccountGatewayTransactionID": ["Bank Account Gateway Transaction ID is required for gateway connect transaction"]}`. - `bankFee` is posted only when the account keeps management fees in the ledger; under bill management fees it is ignored. The tenant `charge` is always posted, with the description `NSF Fee`. - When part of the payment's credit was already refunded to the tenant, the refund is recovered (see Side Effects) from the account's owner distribution account. If that can't be saved (for example, the accounting settings name no owner distribution account), the API answers `400` with an empty array `[]` and no message. ##### Side Effects - A return transaction (type `4`, Lease Payment Return) is created for the payment's full amount, on its bank account, dated `return.datePosted`; the payment's `returnTransactionID` points at it. - The payment's charge receipts are voided, so the charges it paid are open again. - If part of the payment's credit had been refunded to the tenant (a payout), a refunded return (a tenant credit funded from the owner distribution account, described `Refunded Payment Returned`) and a matching charge (`Refunded Payment Return Recovery`) are posted for the refunded amount. - With `bankFee` under ledger management fees, a bank fee is posted on the payment's bank account. - With `charge`, a tenant charge described `NSF Fee` is posted on the lease, dated `return.datePosted`. Like any new charge, it is paid at once from the tenant's other unapplied credits (prepayments), if there are any. From the code, not covered by a contract test: - A return entry is added to the payment's transaction log, and a create entry to the return's. - If the payment paid its own convenience-fee charge, that charge is voided. - When the accounting settings lock the tenant portal after a number of returns, and the lease reaches it, the lease's portal payments are disabled (and certified funds required, if the settings say so). - A `createLeasePaymentReturn` event is recorded, and the lease's last-activity date is updated. ##### Available Includes (12) - `deposit` - the bank deposit the payment is in - `contact` - the paying tenant's contact - `lease` - the lease - `portfolio` - the portfolio the payment posted to - `property` - the lease's property - `unit` - the lease's unit - `propertyPortfolios` - every ownership period of the property - `returnTransaction` - the return transaction this request created - `bulkPayment` - the bulk payment it belongs to, or null - `transactionLogs` - the payment's change log - `receipts` - receipts that aren't voided: after a return, only refund (payout) receipts - `managementFees` - management fees that aren't voided; empty after a return ##### Related Endpoints - `DELETE /accounting/leases/payments/{transactionID}` - Void a payment instead (one that was never deposited). - `POST /accounting/leases/{leaseID}/payouts` - Refund a tenant's credit. - `GET /accounting/accounts/search` - Find the account IDs for `bankFee` and `charge`. - `POST /accounting/deposits` and `POST /accounting/deposits/{depositID}/transactions` - Put the payment in a bank deposit, which a return requires. - `GET /accounting/transactions/search` - Find the payment to return (`transactionTypeIDs[]` `2`). Parameters: - `transactionID` (path, integer, required): ID of the lease payment that was returned. - `includes` (query, string): Comma-separated related records to add to the response, each under its own key: `deposit`, `contact`, `lease`, `portfolio`, `property`, `unit`, `propertyPortfolios`, `returnTransaction`, `bulkPayment`, `transactionLogs`, `receipts`, `managementFees`. Request body, required: - `application/json`: object - `return` (object, required): The return transaction. - `datePosted` (string, required): Date the return posts to the ledger (`YYYY-MM-DD` or `MM/DD/YYYY`). - `description` (string | null): Free-text description of the return. It is copied to the return transaction the API creates (`returnTransaction.description` with that include); the response's `transaction` is the payment. - `bankFee` (object): A bank fee the bank charged for the return, posted on the payment's bank account with the return's date. Posted only when the account keeps management fees in the ledger; ignored under bill management fees. Ignored when it has neither key. - `chargeAccountID` (string | integer, pattern `^-?[0-9]+$`): Expense account of the fee; the IDs come from `GET /accounting/accounts/search`. - `amount` (string | number, decimal): Fee amount. - `charge` (object): A charge to the tenant for the return (an NSF fee), posted on the lease with the return's date and the description `NSF Fee`. Ignored when it has neither key. - `chargeAccountID` (string | integer, pattern `^-?[0-9]+$`): Income account of the charge. It is copied to the NSF charge the API posts, which isn't in the response. The IDs come from `GET /accounting/accounts/search`. - `amount` (string | number, decimal): Charge amount. It is copied to the NSF charge the API posts, which isn't in the response. Example: ```json { "return": { "datePosted": "2026-11-09", "description": "Returned check: insufficient funds" }, "charge": { "chargeAccountID": "9", "amount": "35.00" } } ``` Responses: - `200`: The original payment under `transaction` (now with `returnTransactionID` set), plus the requested includes. - `application/json`: `lease_payment_view` Example: ```json { "transaction": { "transactionID": "524", "transactionTypeID": "2", "managementFeeMode": "2", "primaryLedgerID": "811", "portfolioID": "418", "propertyID": "393", "unitID": "393", "leaseID": "393", "billID": null, "contactID": "394", "bankAccountID": "415", "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": "1", "prepaymentAccountID": null, "unallocatedAccountID": "3", "payoutID": null, "payoutReturnID": null, "amount": "500.00", "amountPaid": null, "amountAllocated": "0.00", "processingFee": null, "convenienceFee": "0.00", "convenienceFeeTransactionID": null, "description": "Rent payment", "reference": "1042", "receivedFrom": null, "returnTransactionID": "525", "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": "3", "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": "81", "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": "0", "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 05:07:04", "dateTimeModified": "2026-11-09 05:07:04" }, "returnTransaction": { "transactionID": "525", "transactionTypeID": "4", "managementFeeMode": "2", "primaryLedgerID": "811", "portfolioID": "418", "propertyID": "393", "unitID": "393", "leaseID": "393", "billID": null, "contactID": null, "bankAccountID": "415", "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "500.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Returned check: insufficient funds", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 05:07:04", "dateTimeModified": "2026-11-09 05:07:04" } } ``` - `400`: The body is empty or incomplete, or the payment doesn't exist, isn't a lease payment, or can't be returned. - `application/json`: one of several shapes - One of: - Option 1: `lease_transaction_error` - Option 2: string[] Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_modify_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Lease Refunded Return `DELETE /accounting/leases/refunded-returns/{transactionID}` Operation ID: `voidLeaseRefundedReturn` Voids a posted lease refunded return. This is not a delete: the refunded return keeps its row and its history, is flagged voided (`isVoided` `'1'` on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided refunded return can't be changed or voided again. ##### Use Cases - Reversing a refunded return posted in error, while keeping it in the lease's history. ##### Business Rules - Requires the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - A transaction ID that doesn't exist answers `400` `{"error": "Refunded Return 999999999 not found"}`, and one that isn't a lease refunded return answers `400` `{"error": "Refunded Return 999999999 not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - A refunded return that is already voided answers `400` `{"isVoided": ["Cannot modify a voided transaction"]}`. ##### Side Effects - Every ledger entry of the refunded return is voided (so the tenant credit it gave is gone), and a void entry is added to its transaction log. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/refunded-returns` - Record a refunded return. - `GET /accounting/transactions/search` - Find the refunded return to void (`transactionTypeIDs[]` `25`). Parameters: - `transactionID` (path, integer, required): ID of the lease refunded return to void. Responses: - `200`: The voided refunded return, flat (no `transaction` wrapper, unlike a read), sent from memory: `isVoided` and a few other values the void sets arrive as numbers. - `application/json`: `lease_transaction_voided` Example: ```json { "transactionID": "280", "transactionTypeID": "25", "managementFeeMode": "2", "primaryLedgerID": "503", "portfolioID": "259", "propertyID": "244", "unitID": "244", "leaseID": "244", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": null, "equityAccountID": "255", "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": "3", "payoutID": null, "payoutReturnID": null, "amount": "120.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Refunded payment returned", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": 1, "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": 0, "isProrated": 0, "isMoveOutTransaction": 0, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 04:54:19", "dateTimeModified": "2026-11-09 04:54:19" } ``` - `400`: The refunded return doesn't exist, isn't a lease refunded return, or can't be voided. - `application/json`: `lease_transaction_error` Example: ```json { "isVoided": [ "Cannot modify a voided transaction" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_void_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Void Lease Deposit Release Credit `DELETE /accounting/leases/deposit-release-credits/{transactionID}` Operation ID: `voidLeaseDepositReleaseCredit` Voids a posted lease deposit-release credit. This is not a delete: the deposit-release credit keeps its row and its history, is flagged voided (`isVoided` `'1'` on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided deposit-release credit can't be changed or voided again. ##### Use Cases - Reversing a deposit-release credit posted in error, while keeping it in the lease's history. ##### Business Rules - Requires the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`); without it the API answers `403` `{"error": "Permission Denied"}`. - The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise `403` `{"error": "Access Denied"}`. - A transaction ID that doesn't exist answers `400` `{"error": "Deposit Release Credit 999999999 not found"}`, and one that isn't a lease deposit-release credit answers `400` `{"error": "Deposit Release Credit 999999999 not found"}`; neither is a `404`. A path value that isn't a number answers the stock `404`. - A deposit-release credit that is already voided answers `400` `{"isVoided": ["Cannot modify a voided transaction"]}`. - A deposit-release credit partly refunded to the tenant by a payout that is still active, even an unapproved one, can't be voided: `400` `{"receipt.isVoided": [...], "depositReleaseCredit.receipt.isVoided": [...]}`, both `Cannot void a payout receipt that is associated with an active payout`. Void the payout first with `DELETE /accounting/payouts/{payoutID}` (undocumented). ##### Side Effects - The credit's receipts are voided, so any charge it paid is open again. - Its ledger entries are voided, so the released deposit counts as held again and can be released anew; its deposit-release rows stay (the `depositReleases` include still lists them). A void entry is added to its transaction log. From the code, not covered by a contract test: - The lease's last-activity date is updated. ##### Related Endpoints - `POST /accounting/leases/{leaseID}/deposit-release-credits` - Release a collected deposit. - `GET /accounting/transactions/search` - Find the deposit-release credit to void (`transactionTypeIDs[]` `19`). Parameters: - `transactionID` (path, integer, required): ID of the lease deposit-release credit to void. Responses: - `200`: The voided deposit-release credit, flat (no `transaction` wrapper, unlike a read), sent from memory: `isVoided` and a few other values the void sets arrive as numbers. - `application/json`: `lease_transaction_voided` Example: ```json { "transactionID": "361", "transactionTypeID": "19", "managementFeeMode": "2", "primaryLedgerID": "615", "portfolioID": "317", "propertyID": "298", "unitID": "298", "leaseID": "298", "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": "56", "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": "56", "payoutID": null, "payoutReturnID": null, "amount": "1000.00", "amountPaid": null, "amountAllocated": 0, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Security deposit release", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": 1, "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": 0, "isProrated": 0, "isMoveOutTransaction": 0, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-11-09", "dateTimeCreated": "2026-11-09 04:56:23", "dateTimeModified": "2026-11-09 04:56:24" } ``` - `400`: The deposit-release credit doesn't exist, isn't a lease deposit-release credit, is already voided, or was partly refunded by an active payout. - `application/json`: `lease_transaction_error` Example: ```json { "isVoided": [ "Cannot modify a voided transaction" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `lease_transaction_void_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Search Ledger Transfers `GET /accounting/ledger-transfers/search` Operation ID: `searchLedgerTransfers` Paginated search for ledger transfer transactions. Returns transactions of type LedgerTransfer only, each enriched with the primary ledger, property, portfolio, unit, and the names of all debited/credited ledgers from the transaction entries. ##### Use Cases - List all ledger transfers posted between two dates for a reconciliation report. - Filter by one or more `propertyIDs` to see transfers affecting specific properties. - Filter by `transactionEntriesLedgerIDs` to find transfers that touched a given ledger. - Retrieve voided transfers separately using `isVoided=1`. ##### Business Rules - Only transactions of type LedgerTransfer (transactionTypeID 15) are returned; the type filter is applied server-side and cannot be overridden by the caller. - Portfolio/property access restrictions are applied automatically. - `amountMin` and `amountMax` filter on the absolute transaction amount as a decimal. ##### Related Endpoints - `GET /accounting/recurring-ledger-transfers/search` — Search recurring ledger transfer schedules. - `GET /accounting/transactions/search` — Broad transaction search across all types. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `isVoided` (query, boolean): Filter by isVoided - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `datePostedMin` (query, string, date): Filter by minumum datePosted - `datePostedMax` (query, string, date): Filter by maximum datePosted - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `propertyIDs[]` (query, integer[]): Filter by an array of propertyIDs - `transactionEntriesLedgerIDs[]` (query, integer[]): Filter by an array of transactionEntriesLedgerIDs - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved ledger transfers. - `application/json`: object[] - Each item: - `transaction` (`transaction`, required) - `ledger` (object, required) - `ledgerID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `property` (object, required) - `propertyID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `address` (string | null, required) - `address2` (string | null, required) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `isMultiUnit` (string | null, required, one of "0", "1", null) - `portfolio` (object, required) - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `unit` (object, required) - `unitID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `address` (string | null, required) - `address2` (string | null, required) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `transactionEntries` (object, required) - `ledgerNames` (string | null, required): Comma-separated list of ledger names involved in this transfer. Example: ```json [ { "transaction": { "transactionID": "80943", "transactionTypeID": "15", "primaryLedgerID": null, "billID": null, "bulkPaymentID": null, "description": "Monthly ledger transfer", "isVoided": "0", "amount": "1.00", "datePosted": "2026-04-24", "reference": null, "payoutID": null, "payoutReturnID": null, "dateTimeCreated": "2026-04-24 04:30:11", "dateTimeModified": "2026-04-24 04:30:11", "contactID": null }, "ledger": { "ledgerID": null, "name": null }, "property": { "propertyID": null, "name": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "isMultiUnit": null }, "portfolio": { "portfolioID": null, "name": null }, "unit": { "unitID": null, "name": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null }, "transactionEntries": { "ledgerNames": "Aaron Ziggo, Day Off Investments LLC" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Journal Entry `POST /accounting/journal-entries` Operation ID: `createJournalEntry` Posts a journal entry: a transaction of type `11` (Journal Entry) on one ledger, made of at least two lines that debit and credit chart-of-accounts accounts by equal totals. Answers with the new transaction as `GET /accounting/transactions/{transactionID}` reads it. ##### Use Cases - Reclassify an amount from one account to another on a property's books. - Record an adjustment the other transaction types don't cover, on a portfolio, property, unit or the manager ledger. ##### Business Rules - Requires the **Modify Journal Entries** permission (`Accounting` › `ModifyJournalEntries`); without it, 403 `{"error": "Permission Denied"}`. - A key restricted to some portfolios can post only on a ledger it can access (a manager ledger needs an unrestricted key); any other ledger answers 403 `{"error": "Access Denied"}`. - The checks run in stages, each answering 400 on its own, so fixing one stage's errors can show the next stage's: the empty-body check; `ledgerID` present (`{"ledgerID": "Ledger is Required"}`) and naming a ledger (`Ledger is Invalid`); the ledger restriction above; the lines as a set (at least two, `Journal Entry must have at least 2 entries.`; a debit or a credit on each line, not both; debits equal to credits, `Entries debits must equal credits.`), every failure listed; the entry (`description` and `datePosted` required, a total above zero, `Amount must be greater than 0.00`), every failure listed; then each line in turn, stopping at the first that fails. - A line with a debit above zero is written as a debit, any other line as a credit. A line's own errors are keyed `debitEntry.` or `creditEntry.` and don't say which line failed: an account that doesn't exist (`Account does not exist.`), or a credit line of zero (`Entry must have a credit or debit > 0.00`, with `Credit is required`). So every line needs an amount above zero. - A `debit` or `credit` that isn't a number fails while the lines are read, after the ledger checks, and answers 500 with an empty body. - A property or unit ledger posts on its portfolio's ledger: the transaction's `primaryLedgerID` is the portfolio's ledger, with `propertyID` (and `unitID`) set. - When the account bills its management fees and hides the manager ledger, the manager ledger is refused (`Cannot create a journal entry on the manager ledger when in billed management fee mode`). - The transaction takes the account's management fee mode (`managementFeeMode`). - Send `includes` to get related records in the response, as `GET /accounting/transactions/{transactionID}` takes them. ##### Side Effects - Writes the transaction, a "create" transaction log (`transactionLogs` include) and one cash-and-accrual entry per line (`entries`, `cashEntries` and `accrualEntries` includes). - When the account bills its management fees, a line on an account whose fees are suppressed for the property is written with `isSuppressed` `1`. ##### Related Endpoints - `GET /accounting/transactions/{transactionID}` - Read the entry back, with includes. - `DELETE /accounting/journal-entries/{transactionID}` - Void the entry. - `GET /accounting/journal-entries/search` - Search journal entries. - `GET /accounting/ledgers/search` - Search ledgers, for `ledgerID`. - `GET /accounting/accounts` - List accounts, for each line's `accountID`. Parameters: - `includes` (query, string): Comma-separated list of related records to add to the response, each under its own key: `ledger`, `portfolio`, `property`, `unit`, `lease`, `account`, `contact`, `reconciliation`, `previousReconciliation`, `returnedTransaction`, `bulkPayment`, `transactionLogs`, `entries`, `cashEntries`, `accrualEntries`, `cashEntryArchives`, `accrualEntryArchives`. Unknown names are ignored. Request body, required: - `application/json`: `journal_entry_request` Example: ```json { "ledgerID": "109", "datePosted": "2026-10-31", "description": "Reclassify October landscaping invoice to repairs", "entries": [ { "accountID": "259", "description": "Sprinkler valve repair", "debit": "125.00" }, { "accountID": "260", "description": "Moved from landscaping", "credit": "125.00" } ] } ``` Responses: - `200`: The entry was posted. The body is the new transaction, with the includes that were asked for. - `application/json`: `transaction_view` Example: ```json { "transaction": { "transactionID": "24", "transactionTypeID": "11", "managementFeeMode": "2", "primaryLedgerID": "107", "portfolioID": "38", "propertyID": "35", "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "125.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Reclassify October landscaping invoice to repairs", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": "0", "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": null, "isProrated": null, "isMoveOutTransaction": null, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-10-31", "dateTimeCreated": "2026-11-12 23:26:02", "dateTimeModified": "2026-11-12 23:26:02" } } ``` - `400`: see shared response `journal_entry_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` - `500`: A line's `debit` or `credit` isn't a number (for example `"abc"`). The body is empty. #### Search Journal Entries `GET /accounting/journal-entries/search` Operation ID: `searchJournalEntries` Paginated search for journal entry transactions. Returns transactions of type JournalEntry only, each enriched with the primary ledger, property, portfolio, unit, and the names of all debited/credited ledgers from the transaction entries. ##### Use Cases - List all journal entries posted within a date range for an audit or reconciliation. - Filter by `propertyIDs` to find journal entries affecting a specific property. - Filter by `transactionEntriesLedgerIDs` to find entries that touched a given ledger. - Retrieve voided journal entries using `isVoided=1`. ##### Business Rules - Only transactions of type JournalEntry (transactionTypeID 11) are returned; the type filter is applied server-side and cannot be overridden by the caller. - Portfolio/property access restrictions are applied automatically. - `amountMin` and `amountMax` filter on the absolute transaction amount as a decimal. ##### Related Endpoints - `GET /accounting/recurring-journal-entries/search` — Search recurring journal entry schedules. - `GET /accounting/transactions/search` — Broad transaction search across all types. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `isVoided` (query, boolean): Filter by isVoided - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `datePostedMin` (query, string, date): Filter by minumum datePosted - `datePostedMax` (query, string, date): Filter by maximum datePosted - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `propertyIDs[]` (query, integer[]): Filter by an array of propertyIDs - `transactionEntriesLedgerIDs[]` (query, integer[]): Filter by an array of transactionEntriesLedgerIDs - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved journal entries. - `application/json`: object[] - Each item: - `transaction` (`transaction`, required) - `ledger` (object, required) - `ledgerID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `property` (object, required) - `propertyID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `address` (string | null, required) - `address2` (string | null, required) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `isMultiUnit` (string | null, required, one of "0", "1", null) - `portfolio` (object, required) - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `unit` (object, required) - `unitID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `address` (string | null, required) - `address2` (string | null, required) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `transactionEntries` (object, required) - `ledgerNames` (string | null, required): Comma-separated list of ledger names involved in this journal entry. Example: ```json [ { "transaction": { "transactionID": "50196", "transactionTypeID": "11", "primaryLedgerID": "728", "billID": null, "bulkPaymentID": null, "description": "Year-end adjustment", "isVoided": "0", "amount": "10000.00", "datePosted": "2026-01-01", "reference": null, "payoutID": null, "payoutReturnID": null, "dateTimeCreated": "2025-01-16 18:38:26", "dateTimeModified": "2026-01-05 20:55:59", "contactID": null }, "ledger": { "ledgerID": "728", "name": "Operating Reserve" }, "property": { "propertyID": null, "name": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "isMultiUnit": null }, "portfolio": { "portfolioID": "255", "name": "Main Portfolio" }, "unit": { "unitID": null, "name": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null }, "transactionEntries": { "ledgerNames": "Operating Account, Maintenance Reserve" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Void Journal Entry `DELETE /accounting/journal-entries/{transactionID}` Operation ID: `voidJournalEntry` Voids a journal entry: the transaction and its lines are marked voided and stay on record, with a "void" log. It answers with the voided transaction itself, not wrapped in `transaction`. ##### Use Cases - Reverse a journal entry posted in error while keeping its history. ##### Business Rules - Requires the **Void Journal Entries** permission (`Accounting` › `VoidJournalEntries`); without it, 403 `{"error": "Permission Denied"}`. **Modify Journal Entries** alone isn't enough. - An ID with no journal entry, including another type of transaction's ID, answers 400 `{"error": "Journal Entry not found"}`. - A key restricted to some portfolios gets 403 `{"error": "Access Denied"}` for an entry outside them. - An entry already voided is refused (`{"isVoided": ["Cannot modify a voided transaction"]}`), and so is one with a reconciled line (`{"reconciliationID": ["Cannot modify a journal entry that has been reconciled"]}`). ##### Side Effects - The transaction's `isVoided` becomes `1`, and so does each of its lines that isn't voided yet (the `cashEntries` and `accrualEntries` includes show them; the `entries` include, which lists only lines that aren't voided, comes back empty). - A "void" transaction log is written (`transactionLogs` include). - Nothing is deleted. ##### Related Endpoints - `GET /accounting/transactions/{transactionID}` - Read the voided entry and its lines. - `POST /accounting/journal-entries` - Post a corrected entry. Parameters: - `transactionID` (path, integer, required): The journal entry's transaction ID, from `GET /accounting/journal-entries/search`. Responses: - `200`: The entry was voided. The body is the voided transaction, not wrapped in `transaction`, with `isVoided` `1` and a few flags as JSON numbers (see the schema). - `application/json`: `journal_entry_voided` Example: ```json { "transactionID": "11", "transactionTypeID": "11", "managementFeeMode": "2", "primaryLedgerID": "62", "portfolioID": "21", "propertyID": "21", "unitID": null, "leaseID": null, "billID": null, "contactID": null, "bankAccountID": null, "chargeAccountID": null, "equityAccountID": null, "destinationBankAccountID": null, "managementFeeIncomeAccountID": null, "prepaymentAccountFilterTypeID": null, "prepaymentAccountID": null, "unallocatedAccountID": null, "payoutID": null, "payoutReturnID": null, "amount": "125.00", "amountPaid": null, "amountAllocated": null, "processingFee": null, "convenienceFee": null, "convenienceFeeTransactionID": null, "description": "Reclassify October landscaping invoice to repairs", "reference": null, "receivedFrom": null, "returnTransactionID": null, "returnTypeID": null, "returnDescription": null, "bulkPaymentID": null, "paymentTypeID": null, "billChargeTransactionID": null, "billCreditTransactionID": null, "discountAmount": null, "markupAmount": null, "managementFeeAmountPaid": null, "isAdditionalManagementFee": null, "managementFeePercent": null, "isSuppressed": "0", "managementFeeExpenseAccountID": null, "managementFeePeriodDate": null, "managementFeeSalesTaxSettingID": null, "managementFeeSalesTaxAmountPaid": null, "managementFeeSalesTaxPercent": null, "managementFeeSalesTaxIncomeAccountID": null, "managementFeeSalesTaxExpenseAccountID": null, "managementFeeBatchID": null, "isSalesTaxCharge": null, "salesTaxSettingID": null, "salesTaxInitiatedFromTransactionID": null, "isVoided": 1, "bankAccountGatewayID": null, "bankAccountGatewayTransactionID": null, "settlementID": null, "paymentAccountName": null, "paymentAccountNumberTruncated": null, "depositID": null, "reconciliationID": null, "previousReconciliationID": null, "achStatusID": null, "bankTransferID": null, "lateFeePeriod": null, "isFromManager": null, "isMoveInCharge": 0, "isProrated": 0, "isMoveOutTransaction": 0, "moveOutAmount": null, "discountMarkupBillChargeTransactionID": null, "recurringObjectID": null, "residentServiceID": null, "residentPackageID": null, "withholdingTaxAgencyID": null, "withholdingTaxContactID": null, "datePosted": "2026-10-31", "dateTimeCreated": "2026-11-12 23:25:52", "dateTimeModified": "2026-11-12 23:25:53" } ``` - `400`: The entry wasn't voided: no journal entry has this ID (one `error`), or a validation message keyed by the field that refused it. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): `Journal Entry not found`, or an unexpected error. - Validation messages: object Example: ```json { "error": "Journal Entry 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Search Recurring Ledger Transfers `GET /accounting/recurring-ledger-transfers/search` Operation ID: `searchRecurringLedgerTransfers` Paginated search for recurring ledger transfer schedules. Each result represents a scheduled transfer that posts ledger-to-ledger transactions on a recurring basis (daily, weekly, monthly, etc.). The `ledgerNames` field contains a comma-separated list of the involved ledger names. ##### Use Cases - List all active recurring ledger transfers to display in a scheduled payments UI. - Filter by `bankAccountIDs` to find transfers associated with a specific bank account. - Filter by `nextRunDateMin`/`nextRunDateMax` to see transfers running in the next N days. - Filter by `ledgerIDs` to find transfers that involve a specific ledger. ##### Business Rules - Portfolio/access restrictions are applied automatically. - `amountMin` and `amountMax` filter on the transfer amount as a decimal. - `endDate` is nullable; a null value means the schedule runs indefinitely. ##### Related Endpoints - `GET /accounting/ledger-transfers/search` — Search posted ledger transfer transactions. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `ledgerIDs[]` (query, integer[]): Filter by an array of ledgerIDs - `bankAccountIDs[]` (query, integer[]): Filter by an array of bankAccountIDs - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `endDateMin` (query, string, date): Filter by minimum end date (inclusive) - `endDateMax` (query, string, date): Filter by maximum end date (inclusive) - `nextRunDateMin` (query, string, date): Filter by minimum next run date (inclusive) - `nextRunDateMax` (query, string, date): Filter by maximum next run date (inclusive) - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved recurring ledger transfers. - `application/json`: object[] - Each item: - `recurringLedgerTransfer` (object, required) - `recurringLedgerTransferID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring ledger transfer. - `amount` (string | null, decimal, required): Transfer amount as a decimal string. - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): ID of the bank account associated with this transfer. - `description` (string | null, required): Description or memo for the transfer. - `endDate` (string | null, date): Date the schedule ends, or null if it runs indefinitely. - `frequency` (string, required, pattern `^-?[0-9]+$`): Interval multiplier for the schedule frequency. - `nextRunDate` (string, date, required): Date this transfer will next be posted. - `reference` (string | null): Optional reference code for the transfer. - `scheduleFrequencyID` (string, required, pattern `^-?[0-9]+$`): Frequency unit for the recurring schedule. * `1` - Daily * `2` - Weekly * `3` - Monthly * `4` - Yearly - `ledgerNames` (string | null, required): Comma-separated names of the ledgers involved in this transfer. Example: ```json [ { "recurringLedgerTransfer": { "recurringLedgerTransferID": "2", "amount": "1.00", "bankAccountID": "46", "description": "test", "endDate": null, "frequency": "1", "nextRunDate": "2026-04-25", "reference": null, "scheduleFrequencyID": "1", "ledgerNames": "Aaron Ziggo, Day Off Investments LLC" } }, { "recurringLedgerTransfer": { "recurringLedgerTransferID": "1", "amount": "100.00", "bankAccountID": "31", "description": "Ledger Transfer", "endDate": null, "frequency": "2", "nextRunDate": "2026-06-11", "reference": "Ledger Transfer", "scheduleFrequencyID": "3", "ledgerNames": "Amanda LLC, Amanda LLC Trust" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Recurring Journal Entries `GET /accounting/recurring-journal-entries/search` Operation ID: `searchRecurringJournalEntries` Paginated search for recurring journal entry schedules. Each result contains the recurring journal entry record alongside the full ledger object it is associated with. ##### Use Cases - List all recurring journal entries to display in a scheduled accounting UI. - Filter by `ledgerIDs` to find recurring entries associated with a specific ledger. - Filter by `nextRunDateMin`/`nextRunDateMax` to see entries posting in the next N days. - Filter by `endDateMin`/`endDateMax` to find schedules expiring in a given window. ##### Business Rules - Portfolio/access restrictions are applied automatically. - `amountMin` and `amountMax` filter on the entry amount as a decimal. - `endDate` is nullable; a null value means the schedule runs indefinitely. ##### Related Endpoints - `GET /accounting/journal-entries/search` — Search posted journal entry transactions. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `ledgerIDs[]` (query, integer[]): Filter by an array of ledgerIDs - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `endDateMin` (query, string, date): Filter by minimum end date (inclusive) - `endDateMax` (query, string, date): Filter by maximum end date (inclusive) - `nextRunDateMin` (query, string, date): Filter by minimum next run date (inclusive) - `nextRunDateMax` (query, string, date): Filter by maximum next run date (inclusive) - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page Responses: - `200`: Successfully retrieved recurring journal entries. - `application/json`: object[] - Each item: - `recurringJournalEntry` (object, required) - `recurringJournalEntryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring journal entry. - `ledgerID` (string, required, pattern `^-?[0-9]+$`): ID of the primary ledger for this journal entry. - `description` (string | null, required): Description or memo for the journal entry. - `amount` (string | null, decimal, required): Journal entry amount as a decimal string. - `endDate` (string | null, date): Date the schedule ends, or null if it runs indefinitely. - `nextRunDate` (string, date, required): Date this journal entry will next be posted. - `frequency` (string, required, pattern `^-?[0-9]+$`): Interval multiplier for the schedule frequency. - `scheduleFrequencyID` (string, required, pattern `^-?[0-9]+$`): Frequency unit for the recurring schedule. * `1` - Daily * `2` - Weekly * `3` - Monthly * `4` - Yearly - `ledger` (object, required) - `ledgerID` (string, required, read-only, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, required, pattern `^-?[0-9]+$`) - `objectID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `isActive` (string, required, one of "0", "1") - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json [ { "recurringJournalEntry": { "recurringJournalEntryID": "4", "ledgerID": "384", "description": "Monthly fee", "amount": "12.00", "endDate": null, "nextRunDate": "2026-04-25", "frequency": "1", "scheduleFrequencyID": "1" }, "ledger": { "ledgerID": "384", "ledgerTypeID": "2", "objectID": "139", "name": "123 PM", "isActive": "1", "dateTimeCreated": "2023-09-29 23:46:23", "dateTimeModified": "2026-04-24 17:51:58" } }, { "recurringJournalEntry": { "recurringJournalEntryID": "3", "ledgerID": "2", "description": "JE for Rent", "amount": "100.00", "endDate": null, "nextRunDate": "2026-05-11", "frequency": "1", "scheduleFrequencyID": "3" }, "ledger": { "ledgerID": "2", "ledgerTypeID": "2", "objectID": "1", "name": "Amanda LLC", "isActive": "1", "dateTimeCreated": "2023-09-29 23:46:23", "dateTimeModified": "2026-03-26 13:49:41" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Transaction Entries #### Search Transaction Entries `GET /accounting/transactions/entries/search` Operation ID: `searchTransactionEntries` Returns a paginated, searchable list of individual transaction entries (debit/credit lines) with associated transaction, ledger, property, portfolio, and unit context. Transaction entries represent the individual accounting lines within a double-entry transaction. ##### Use Cases - Search entries by ledger to build a ledger statement or account register. - Filter by `isCash` or `isAccrual` for cash vs. accrual basis reporting. - Filter by `isSuppressed` to show or exclude management-fee suppressed entries. - Pull entries modified after a given timestamp for sync or reconciliation workflows. ##### Business Rules - Results are restricted to the authenticated user's portfolio. - Both `propertyIDs` (comma-separated) and `propertyID` (single integer) are accepted; `propertyIDs` takes precedence. - Similarly, `ledgerIDs` takes precedence over `ledgerID`. - The `ledger`, `primaryLedger`, `property`, `portfolio`, and `unit` fields are joined from related tables and may be null if the entry has no associated property or unit. - Each entry references both its own `ledger` (the account being debited/credited) and the `primaryLedger` (the bank account of the parent transaction). ##### Related Endpoints - `GET /accounting/transactions/search` - Search parent transactions. Parameters: - `search` (query, string): Filter by term in description, name, amount, or address - `isVoided` (query, boolean): Filter by isVoided - `isSuppressed` (query, boolean): Filter by isSuppressed - `isCash` (query, boolean): Filter by isCash - `isAccrual` (query, boolean): Filter by isAccrual - `amountMin` (query, number, double): Filter by minumum amount - `amountMax` (query, number, double): Filter by maximum amount - `datePostedMin` (query, string, date): Filter by minumum datePosted - `datePostedMax` (query, string, date): Filter by maximum datePosted - `dateTimeModifiedMin` (query, string): Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied: `2024-01-01T10:00:00-05:00` and `2024-01-01T10:00:00Z` both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a `+` offset as `%2B`: an unencoded `+` reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `transactionTypeIDs[]` (query, integer[]): Filter by an array of transactionTypeIDs - `propertyIDs[]` (query, integer[]): Filter by an array of propertyIDs - `ledgerIDs[]` (query, integer[]): Filter by an array of ledgerIDs - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 15): Number of items per page Responses: - `200`: Successfully retrieved matching transaction entries. - `application/json`: object[] - Each item: - `transactionEntry` (`transaction_entry`, required) - `transaction` (`transaction`, required) - `ledger` (object | null) - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (`ledger_types`) - `name` (string) - `primaryLedger` (object | null) - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (`ledger_types`) - `name` (string) - `property` (object | null) - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `isMultiUnit` (string, one of "0", "1") - `portfolio` (object | null) - `portfolioID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `unit` (object | null) - `unitID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) Example: ```json [ { "transactionEntry": { "transactionEntryID": "14201", "transactionID": 9901, "ledgerID": 401, "accountID": "22", "portfolioID": 50, "amount": "1500.00", "isVoided": "0", "isSuppressed": "0", "isCash": "1", "isAccrual": "0", "datePosted": "2024-10-01", "dateTimeCreated": "2024-10-01 08:00:00", "dateTimeModified": "2024-10-01 08:00:00" }, "transaction": { "transactionID": "9901", "transactionTypeID": "4", "primaryLedgerID": "401", "billID": null, "payoutID": null, "payoutReturnID": null, "amount": "1500.00", "description": "Rent payment - Unit 101", "reference": null, "isVoided": "0", "datePosted": "2024-10-01", "dateTimeCreated": "2024-10-01 08:00:00", "dateTimeModified": "2024-10-01 08:00:00" }, "ledger": { "ledgerID": "401", "ledgerTypeID": "1", "name": "123 Main St Operating" }, "primaryLedger": { "ledgerID": "401", "ledgerTypeID": "1", "name": "123 Main St Operating" }, "property": { "propertyID": "100", "name": "123 Main St", "address": "123 Main St", "address2": null, "city": "Springfield", "stateID": "IL", "postalCode": "62701", "isMultiUnit": "1" }, "portfolio": { "portfolioID": "50", "name": "Smith Portfolio" }, "unit": { "unitID": "200", "name": "Unit 101", "address": "123 Main St", "address2": "Unit 101", "city": "Springfield", "stateID": "IL", "postalCode": "62701" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Diagnostics #### Unused Vendor Credits `GET /accounting/diagnostics/unused-vendor-credits` Operation ID: `listUnusedVendorCredits` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `transactionID` (string, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyAddress` (string) - `propertyAddress2` (string | null) - `propertyCity` (string) - `propertyStateID` (string) - `propertyPostalCode` (string) - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `contactID` (string | null, pattern `^-?[0-9]+$`) - `contactTypeID` (`contact_types`) - `contactName` (string) - `amount` (string, decimal) - `amountAllocated` (string | null, decimal) - `description` (string | null) - `isSuppressed` (string, one of "0", "1") - `datePosted` (string, date) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Suppressed Fee Balance Mismatch `GET /accounting/diagnostics/suppressed-fee-balance-mismatch` Operation ID: `listSuppressedFeeBalanceMismatches` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `propertyID` (string, pattern `^-?[0-9]+$`) - `propertyName` (string | null) - `propertyStreetName` (string) - `propertyStreetNumber` (string) - `propertyAddress` (string | null) - `propertyAddress2` (string | null) - `propertyCity` (string) - `propertyStateID` (string) - `propertyPostalCode` (string) - `accountID` (string, pattern `^-?[0-9]+$`) - `balance` (number, double) - `managerLedgerID` (integer) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Negative Bank Accounts `GET /accounting/diagnostics/negative-bank-accounts` Operation ID: `listNegativeBankAccounts` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `ledgerTypeID` (`ledger_types`) - `ledgerObjectID` (integer) - `accountID` (string, pattern `^-?[0-9]+$`) - `accountName` (string) - `accountNumber` (string) - `balance` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Reserve Not Met By Ledger `GET /accounting/diagnostics/reserve-not-met` Operation ID: `listReserveNotMetLedgers` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `ledgerTypeID` (`ledger_types`) - `ledgerObjectID` (integer) - `operatingBalance` (number, double) - `reserveAmount` (string, decimal) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Escrow Mismatch By Ledger `GET /accounting/diagnostics/escrow-mismatch` Operation ID: `listEscrowMismatches` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `ledgerTypeID` (`ledger_types`) - `ledgerObjectID` (integer) - `depositBalance` (number, double) - `escrowBalance` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Prepayment Mismatch By Ledger `GET /accounting/diagnostics/prepayment-mismatch` Operation ID: `listPrepaymentMismatches` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `ledgerTypeID` (`ledger_types`) - `ledgerObjectID` (integer) - `operatingBalance` (number, double) - `prepaymentBalance` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Unused Prepayments `GET /accounting/diagnostics/unused-prepayments` Operation ID: `listUnusedPrepayments` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `leaseID` (string, pattern `^-?[0-9]+$`) - `tenants` (string[] | null) - `unitID` (string, pattern `^-?[0-9]+$`) - `unitAddress` (string) - `unitAddress2` (string) - `unitCity` (string) - `unitStateID` (string) - `unitPostalCode` (string) - `unitName` (string) - `propertyID` (string, pattern `^-?[0-9]+$`) - `propertyAddress` (string) - `propertyAddress2` (string) - `propertyCity` (string) - `propertyStateID` (string) - `propertyPostalCode` (string) - `propertyName` (string) - `prepaymentBalance` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Bank Account Reconcialiation Lapse `GET /accounting/diagnostics/bank-account-reconciliation-lapse` Operation ID: `listBankAccountReconciliationLapses` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `accountID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `number` (string) - `lastReconciliationDate` (string, date) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Vendor Insurance Lapse `GET /accounting/diagnostics/vendor-insurance-lapse` Operation ID: `listVendorInsuranceLapses` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `contactID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `contactTypeID` (`contact_types`) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceExpiresDate` (string | null, date) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Credit Debit Mismatch `GET /accounting/diagnostics/credit-debit-mismatch` Operation ID: `listCreditDebitMismatches` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `transactionID` (string, pattern `^-?[0-9]+$`) - `transactionTypeID` (string, pattern `^-?[0-9]+$`) - `primaryLedgerID` (string | null, pattern `^-?[0-9]+$`) - `primaryLedgerName` (string) - `portfolioID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`) - `propertyName` (string) - `propertyAddress` (string) - `propertyAddress2` (string) - `propertyCity` (string) - `propertyStateID` (string) - `propertyPostalCode` (string) - `unitAddress` (string) - `unitAddress2` (string) - `unitCity` (string) - `unitStateID` (string) - `unitPostalCode` (string) - `unitName` (string) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `datePosted` (string, date) - `cashCredits` (number, double) - `cashDebits` (number, double) - `accrualCredits` (number, double) - `accrualDebits` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Manager Ledger Balances `GET /accounting/diagnostics/manager-ledger-balance` Operation ID: `listManagerLedgerBalances` Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerName` (string) - `ledgerTypeID` (`ledger_types`) - `objectID` (string, pattern `^-?[0-9]+$`) - `reserveAmount` (string, decimal) - `additionalReserveAmount` (string, decimal) - `overdraftOverrideAmount` (string | null, decimal) - `cashBalance` (number, double) - `escrowBalance` (number, double) - `prepaymentBalance` (number, double) - `depositBalance` (number, double) - `nonHeldDepositBalance` (number, double) - `accountsReceivableBalance` (number, double) - `accountsPayableBalance` (number, double) - `creditBalance` (number, double) - `currentCreditBalance` (number, double) - `currentAccountsPayableBalance` (number, double) - `liabilityBalance` (number, double) - `nonHeldLiabilityBalance` (number, double) - `undepositedReceiptsBalance` (number, double) - `undepositedEscrowReceiptsBalance` (number, double) - `workOrderEstimateBalance` (number, double) - `operatingBalance` (number, double) - `availableFunds` (number, double) - `401`: see shared response `error_401` - `429`: see shared response `error_429` ## Contacts ### Owners #### List Owners `GET /owners` Operation ID: `listOwners` Returns a page of owners, sorted by name. Each item holds the full contact row under `contact`, and a `token`. Use `GET /owners/search` for more filters and computed columns. ##### Use Cases - Page through every active (or inactive) owner on the account - Look up owners by name or code ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets only the owners who hold a share of a portfolio in those groups, plus owners who hold no portfolio at all (a filtered 200, never a 403). - `isActive` defaults to `1`: only active owners. `0` returns only inactive ones; any value other than `1`, `true`, `yes`, `0`, `false` or `no` (such as `all`) returns both. - `search` is a substring match on `name` and `code`. The text is HTML-encoded before it is matched, so text holding `'`, `"`, `&`, `<` or `>` (`O'Brien`, `Smith & Sons`) finds nothing here; `GET /owners/search` matches it as typed. - The page size defaults to 15 and is capped at 5000. - Sorted by `name` alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through `GET /owners/search`, which breaks ties on `contactID`. ##### Related Endpoints - `GET /owners/search` - filtered search with computed insurance and tax columns - `GET /owners/{contactID}` - one owner, with includes - `POST /owners` - create an owner Parameters: - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 15, minimum 1): Items per page, from 1 (default 15). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name` and `code`. HTML-encoded before matching, so text holding `'`, `"`, `&`, `<` or `>` finds nothing. - `isActive` (query, string, default "1"): `1` (the default) returns active contacts, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. Responses: - `200`: A page of owners - `application/json`: `contact_list_item`[] Example: ```json [ { "contact": { "contactID": "2686", "contactTypeID": "1", "vendorTypeID": null, "code": "C-6af8ddd922c15", "name": "Jane Doe", "firstName": "Jane", "middleName": null, "lastName": "Doe", "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "MI", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "162", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "146", "dateTimeCreated": "2026-11-14 22:16:57", "dateTimeModified": "2026-11-14 22:16:57", "dateTimeDeactivated": null, "contactType": "Owner" }, "token": "1794694617" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Owner `POST /owners` Operation ID: `createOwner` Creates a new owner contact and returns the full owner detail (same shape as `GET /owners/{contactID}`). ##### Use Cases - Onboard a new property owner into the system - Create an owner with initial payout settings, emails, phones, and addresses in a single request ##### Business Rules - Requires `Contacts.UpdateOwner` permission. - `name` is required. - `payoutTypeID`, `achAccountTypeID`, `achIsCorporateAccount`, `holdPayments`, `preventConsolidatedPayments`, and `payeeName` may only be set at creation time via this endpoint; use the ACH details endpoint to modify payout settings after creation. - Tax fields (`taxPayerName`, `taxFormTypeID`, `taxIdentifier`) require the `Contacts.ManageTaxInfo` permission. - Bank account fields (`routingNumber`, `accountNumber`) are stored encrypted; only the last 4 digits of `accountNumber` are returned in responses. - After creation the endpoint forwards to the view action — the response is the full owner detail. ##### Related Endpoints - `GET /owners/{contactID}` — retrieve the created owner - `POST /owners/{contactID}` — update owner fields after creation - `POST /owners/{contactID}/ach-details` (undocumented) — update payout/ACH settings Request body, required: - `application/json`: object - `name` (string, required): Full display name of the owner - `code` (string | null): Optional short code for the owner - `websiteUrl` (string | null, uri): Owner website URL - `birthDate` (string | null, date) - `payoutTypeID` (`payout_types_request`) - `achAccountTypeID` (one of several shapes) - One of: - Option 1: `bank_account_types_request` - Option 2: null - `achIsCorporateAccount` (string | integer, pattern `^-?[0-9]+$`): 1 if ACH account is corporate, 0 otherwise - `holdPayments` (string | integer, pattern `^-?[0-9]+$`): 1 to hold all payments to this owner - `preventConsolidatedPayments` (string | integer, pattern `^-?[0-9]+$`): 1 to prevent consolidated payouts - `payeeName` (string | null): Override name for checks and ACH - `isBillApprovalExempt` (string | integer, one of "0", "1", 0, 1): 1 to exempt owner from bill approval workflow (requires UpdateBillApprovalExemption permission) - `taxPayerName` (string | null): Name on tax documents (requires ManageTaxInfo permission) - `taxFormTypeID` (string | integer | null, pattern `^-?[0-9]+$`): 1099 form type ID (requires ManageTaxInfo permission) - `taxIdentifier` (string | null): SSN/EIN stored encrypted (requires ManageTaxInfo permission) - `routingNumber` (string | null): ACH routing number — stored encrypted, not returned in responses - `accountNumber` (string | null): ACH account number — stored encrypted, only last 4 digits returned - `emails` (object[]): Email records to attach to the owner - `email` (string, email) - `phones` (object[]): Phone records to attach to the owner - `phone` (string) - `addresses` (object[]): Address records to attach to the owner Example: ```json { "name": "New User" } ``` Responses: - `200`: Owner successfully created — returns full owner detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5258", "contactTypeID": "1", "vendorTypeID": null, "code": null, "name": "New User", "firstName": "New", "middleName": null, "lastName": "User", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "isActive": "1", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "dateTimeCreated": "2026-04-24 17:49:23", "dateTimeModified": "2026-04-24 17:49:23", "dateTimeDeactivated": null, "contactType": "Owner", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Search Owners `GET /owners/search` Operation ID: `searchOwners` Returns a page of owners with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under `contact`. With `search`, each row also carries `search.rank`. ##### Use Cases - Find owners by name, code, email, phone or address (the row doesn't carry `code`: read it from `GET /owners/{contactID}`) - Sync owners changed since a point in time with `dateTimeModifiedMin` - Review tax-identifier data quality with `hasTaxIdentifier`, `isTaxIdentifierValid` and `hasDuplicateTaxIdentifier` ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets only the owners who hold a share of a portfolio in those groups, plus owners who hold no portfolio at all (a filtered 200, never a 403). - `isActive` filters only when sent: without it the search returns active and inactive owners. - `search` is a substring match on `name`, `code`, `email`, `phone` and `address`; spaces in the text match any run of characters. Each row then carries a `search.rank`. - The page size defaults to 25, with no upper limit today; a `pageSize` of `0` or less is served at 15. - Sorted by `orderBy` (default `contact.name`), then by `contactID`. An `orderBy` column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in `contactID` order. - Boolean filters read `1`, `true` and `yes` as yes and `0`, `false` and `no` as no; any other value is ignored. - List filters take each value as a separate `name[]=`. ##### Related Endpoints - `GET /owners` - the plain list, with the full contact row - `GET /owners/{contactID}` - one owner, with includes Parameters: - `page` (query, integer, default 1): Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit today. `0`, a negative value or a value that isn't a number is served at 15. - `search` (query, string): Substring match on `name`, `code`, `email`, `phone` and `address`. Spaces in the text match any run of characters. - `payoutTypeID` (query, `payout_types_request`): Only contacts paid this way. A value that isn't a number is ignored. - `holdPayments` (query, string): Only contacts whose payouts are on hold (`1`) or not (`0`). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isActive` (query, string): Only active (`1`) or inactive (`0`) contacts. Without it, both. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `hasTaxIdentifier` (query, string): Only contacts with (`1`) or without (`0`) a stored tax identifier. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isTaxIdentifierValid` (query, string): Only contacts whose stored tax identifier passed (`1`) or failed (`0`) validation; a contact with no identifier counts as `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `taxIdentifierTypeIDs[]` (query, `tax_identifier_types_request`[]): Only contacts whose stored tax identifier is of these types. Send each value as a separate `taxIdentifierTypeIDs[]=`. - `hasDuplicateTaxIdentifier` (query, string): Only contacts whose tax identifier another contact also stores (`1`), or that no other contact shares (`0`, including contacts with none). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `dateTimeModifiedMin` (query, string): Only contacts last modified on or after this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send `20240101` as `2024-01-01`. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only contacts last modified on or before this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound. - `isInsuranceRequiredForPayment` (query, string): Only contacts that must (`1`) or needn't (`0`) have current insurance to be paid. The API stores null here for owners, so `1` returns none and `0` only a few older rows that store `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `orderBy` (query, string, default "contact.name"): Sort columns, comma-separated, each optionally followed by `|desc` (or `|asc`, the default): `contact.name|desc`. Default `contact.name`; `contactID` breaks ties. Sortable: `contact.contactID`, `contact.isActive`, `contact.contactTypeID`, `contact.vendorTypeID`, `contact.name`, `contact.email`, `contact.phone`, `contact.defaultBillChargeAccountID`, `contact.payeeName`, `contact.taxPayerName`, `contact.taxFormTypeID`, `contact.payoutTypeID`, `contact.achAccountNumberTruncated`, `contact.achAccountTypeID`, `contact.holdPayments`, `contact.liabilityInsuranceName`, `contact.workersCompInsurancePolicyNumber`, `contact.workersCompInsuranceExpiresDate`, `contact.discountPercent`, `contact.discountGraceDays`, `contact.isInsuranceRequiredForPayment`, `contact.isTaxIdentifierValid`, `contact.taxIdentifierTypeID`, `contact.taxIdentifierCountryID`, `contact.hasTaxIdentifier`, `contact.hasDuplicateTaxIdentifier`, `contact.propertyCount`, `contact.daysUntilInsuranceExpires`, `contact.daysUntilLiabilityInsuranceExpires`, `contact.daysUntilWorkersCompInsuranceExpires`, and `search.rank` when `search` is sent. Any other column is dropped without an error; with none left, rows come back in `contactID` order. A `-` prefix isn't read as descending: it makes the column unknown. Responses: - `200`: A page of matching owners - `application/json`: `contact_search_item`[] Example: ```json [ { "contact": { "contactID": "2763", "contactTypeID": "1", "vendorTypeID": null, "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "CO", "postalCode": "12345", "countryID": "US", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "payoutTypeID": "1", "achDetailsCiphertextID": "167", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "holdPayments": "1", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "isBillingSalesTaxEnabled": "0", "daysUntilLiabilityInsuranceExpires": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "daysUntilWorkersCompInsuranceExpires": null, "insuranceExpiresDate": null, "daysUntilInsuranceExpires": null, "discountPercent": null, "discountGraceDays": null, "isActive": "1", "invoiceAutofillTemplateID": "151", "dateTimeCreated": "2026-11-14 22:17:12", "dateTimeModified": "2026-11-14 22:17:12", "dateTimeDeactivated": null, "isInsuranceRequiredForPayment": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "identificationCountryID": "US", "hasTaxIdentifier": "1", "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null, "hasDuplicateTaxIdentifier": "0", "propertyCount": "0" }, "search": { "rank": "10" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Owner `GET /owners/{contactID}` Operation ID: `getOwner` Returns one owner: the full contact row under `contact`, with the tax-identifier flags, and the related records the `includes` parameter names, each under its own key. ##### Use Cases - Show an owner's full record - Load the owner's emails, phones and addresses in the same request ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups (a manager user or API key that is a member of one or more portfolio groups) can read an owner only when the owner holds a share of a portfolio in those groups, or holds no portfolio at all; any other owner is refused with a 403. - A well-formed ID with no contact, or the ID of a contact of another type, answers 400 `{"error": "Owner {contactID} not found"}`. An ID that isn't a whole number of digits answers the stock 404. - The tax identifier itself is never returned: `contact.hasTaxIdentifier` says whether one is stored. - `includes` names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored. ##### Available Includes (7) - `emails` - the contact's email addresses, each under `email` - `phones` - the contact's phone numbers, each under `phone` - `addresses` - the contact's addresses, each under `address` - `portfolios` - the portfolios the owner holds a share of, each as `owner` (the share) and `portfolio`. A user restricted to portfolio groups gets only the portfolios they may access - `portalAccounts` - the owner portal accounts linked to the contact - `portalInvitations` - the pending, unexpired invitations to the owner portal, newest first - `taxAdjustments` - the contact's 1099 tax adjustments ##### Related Endpoints - `GET /owners` - list owners - `GET /owners/search` - search owners - `POST /owners/{contactID}` - update the owner Parameters: - `contactID` (path, integer, required): The owner's contact ID. A well-formed ID that isn't an owner answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. - `includes` (query, string): Comma-separated related records to add: `emails`, `phones`, `addresses`, `portfolios`, `portalAccounts`, `portalInvitations`, `taxAdjustments`. Responses: - `200`: The owner, with the includes requested - `application/json`: object - `contact` (`contact_detail`, required) - `emails` (`contact_email_row`[]): The contact's email addresses, each under `email`. Requires the `emails` include. - `phones` (`contact_phone_row`[]): The contact's phone numbers, each under `phone`. Requires the `phones` include. - `addresses` (`contact_address_row`[]): The contact's addresses, each under `address`. Requires the `addresses` include. - `portfolios` (`owner_portfolio_row`[]): The portfolios the owner holds a share of, each as `owner` (the share) and `portfolio`. A user restricted to portfolio groups gets only the portfolios they may access. Requires the `portfolios` include. - `portalAccounts` (`contact_portal_account`[]): The owner portal accounts linked to the contact. Requires the `portalAccounts` include. - `portalInvitations` (`contact_portal_invitation`[]): The pending, unexpired invitations to the owner portal, newest first. Requires the `portalInvitations` include. - `taxAdjustments` (`contact_tax_adjustment`[]): The contact's 1099 tax adjustments. Requires the `taxAdjustments` include. Example: ```json { "contact": { "contactID": "2958", "contactTypeID": "1", "vendorTypeID": null, "code": "C-6af8ddfc7f21f", "name": "Jane Doe", "firstName": "Jane", "middleName": null, "lastName": "Doe", "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NH", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "172", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "156", "dateTimeCreated": "2026-11-14 22:17:32", "dateTimeModified": "2026-11-14 22:17:32", "dateTimeDeactivated": null, "contactType": "Owner", "hasTaxIdentifier": 1, "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null }, "emails": [ { "email": { "contactEmailID": "105", "contactID": "2958", "isPrimary": "1", "email": "jane.doe@example.com", "sendEmailNotifications": "1", "sendPaymentNotifications": "1", "sendWorkOrderNotifications": "1" } } ], "phones": [ { "phone": { "contactPhoneID": "105", "contactID": "2958", "isPrimary": "1", "phone": "555-0100", "phoneTypeID": "1", "description": "Office", "isActive": "1" } } ], "addresses": [ { "address": { "contactAddressID": "105", "contactID": "2958", "isPrimary": "1", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NC", "postalCode": "12345" } } ], "portfolios": [ { "owner": { "portfolioOwnerID": "61", "portfolioID": "732", "contactID": "2958", "percentOwned": "100.0000", "percentDistributed": "100.0000", "overrideContactPayoutSettings": "0", "payeeName": null, "payoutTypeID": "2", "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0" }, "portfolio": { "portfolioID": "732", "code": "HQ183", "name": "Daniel, Rodriguez and Wunsch Portfolio", "contacts": null, "postingSettingID": "734", "assignedToUserID": null, "minimumDistributionAmount": null, "maximumDistributionAmount": null, "reserveAmount": "0.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": null, "fiscalYearEndMonth": "12", "statementSettingID": "733", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2026-11-14 22:17:32", "dateTimeModified": "2026-11-14 22:17:32", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null, "payOwnersNotes": null } } ], "portalAccounts": [ { "userPortalAccountID": "106", "userID": "1923", "accountID": "1", "portalTypeID": "2", "portalID": "2958", "email": "jane.doe@example.com", "isActive": "1", "firstName": "Jane", "lastName": "Doe", "phone": "555-0100", "timeZone": "UTC" } ], "portalInvitations": [ { "userPortalInvitationID": "104", "accountID": "1", "portalInvitationStatusID": "1", "portalTypeID": "2", "portalID": "2958", "email": "jane.doe@example.com", "roleID": "1", "portfolioGroupIDs": "[1, 2]", "dateTimeCreated": "2026-11-14 22:17:32", "dateTimeExpires": "2026-12-14 22:17:32", "nextReminderDateTime": "2026-11-16 22:17:32" } ], "taxAdjustments": [ { "taxAdjustmentID": "104", "contactID": "2958", "amount": "125.50", "description": "Prior-year adjustment", "datePosted": "2025-12-31" } ] } ``` - `400`: No owner has this ID: no contact, or a contact of another type. - `application/json`: object - `error` (string, required): `Owner {contactID} not found` Example: ```json { "error": "Owner 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The owner is outside the user's portfolio restrictions. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Owner `POST /owners/{contactID}` Operation ID: `updateOwner` Updates editable fields on an existing owner contact and returns the full owner detail (same shape as `GET /owners/{contactID}`). ##### Use Cases - Update an owner's display name, code, website, or birth date - Toggle bill approval exemption for an owner (requires `UpdateBillApprovalExemption` permission) ##### Business Rules - Requires `Update Owner Details` permission. - Returns `400` if the contact is not found or is not an owner. - Access is restricted to contacts within the authenticated account's scope. - Only the following fields are accepted: `name`, `code`, `websiteUrl`, `birthDate`, and `isBillApprovalExempt` (permission-gated). - After update the endpoint forwards to the view action — pass `includes` query params to include related data in the response. ##### Related Endpoints - `GET /owners/{contactID}` — retrieve current owner detail Parameters: - `contactID` (path, integer, required): The unique owner contact ID - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portfolios`, `portalAccounts`, `portalInvitations`, `taxAdjustments` Request body, required: - `application/json`: object - `name` (string): Full display name of the owner - `code` (string | null): Optional short code - `websiteUrl` (string | null, uri): Owner website URL - `birthDate` (string | null, date) - `isBillApprovalExempt` (string | integer, one of "0", "1", 0, 1): 1 to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) Example: ```json { "name": "Chris Campos", "isBillApprovalExempt": "0", "birthDate": null, "code": null } ``` Responses: - `200`: Owner successfully updated — returns full owner detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "3513", "contactTypeID": "1", "vendorTypeID": null, "code": null, "name": "Chris Campos", "firstName": "Chris", "middleName": null, "lastName": "Campos", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "isActive": "1", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "dateTimeCreated": "2025-02-28 18:17:58", "dateTimeModified": "2026-04-24 17:47:53", "dateTimeDeactivated": null, "contactType": "Owner", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Delete Owner `DELETE /owners/{contactID}` Operation ID: `deleteOwner` Permanently deletes an owner contact. Returns the deleted contact as a flat object (not wrapped in a `contact` key). ##### Use Cases - Remove an owner who was created in error - Clean up test or duplicate owner records ##### Business Rules - Requires `Update Owner Details` permission. - Returns `400` if the contact is not found or is not an owner. - Access is restricted to contacts within the authenticated account's scope. - Deletion may fail if the owner has associated financial records or active portfolio memberships — the service layer will return errors in that case. - The response is the contact's last known state as a flat object (no `contact` wrapper). ##### Related Endpoints - `POST /owners/{contactID}/deactivate` — soft-deactivate instead of permanently deleting - `GET /owners/{contactID}` — verify owner state before deletion Parameters: - `contactID` (path, integer, required): The unique owner contact ID to delete Responses: - `200`: Owner successfully deleted — returns the deleted contact record (flat) - `application/json`: `contact` Example: ```json { "contactID": "5258", "contactTypeID": "1", "vendorTypeID": null, "code": null, "name": "New User", "firstName": "New", "middleName": null, "lastName": "User", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "isActive": "1", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "dateTimeCreated": "2026-04-24 17:49:23", "dateTimeModified": "2026-04-24 17:49:23", "dateTimeDeactivated": null, "contactType": "Owner" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Owner 5258 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Activate Owner `POST /owners/{contactID}/activate` Operation ID: `activateOwner` Sets an owner's `isActive` flag to `1`, re-activating them after a previous deactivation. Returns the updated owner detail (same shape as `GET /owners/{contactID}`). ##### Use Cases - Re-activate an owner who was previously deactivated but has returned as an active client - Restore owner portal access and distribution eligibility ##### Business Rules - Requires `Contacts.UpdateOwner` permission. - Returns `400` if the contact is not found or is not an owner. - Access is restricted to contacts within the authenticated account's scope via `verifyAccessToContact`. - Sets `isActive = 1` and clears `dateTimeDeactivated` on the contact record. - The response is the full owner detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /owners/{contactID}` — retrieve owner details - `POST /owners/{contactID}/deactivate` — deactivate an active owner - `POST /owners/{contactID}` — update owner fields Parameters: - `contactID` (path, integer, required): The unique owner contact ID to activate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portfolios`, `portalAccounts`, `portalInvitations`, `taxAdjustments` Responses: - `200`: Owner successfully activated — returns updated owner detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `firstName` (string | null) - `lastName` (string | null) - `isActive` (string, required, one of "0", "1"): Will be `"1"` after activation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Cleared to null after re-activation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "3513", "contactTypeID": "1", "vendorTypeID": null, "code": null, "name": "Chris Campos", "firstName": "Chris", "middleName": null, "lastName": "Campos", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2025-02-28 18:17:58", "dateTimeModified": "2026-04-24 16:05:00", "dateTimeDeactivated": null, "contactType": "Owner", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Owner 3513 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Deactivate Owner `POST /owners/{contactID}/deactivate` Operation ID: `deactivateOwner` Sets an owner's `isActive` flag to `0`, marking them as inactive. Returns the updated owner detail (same shape as `GET /owners/{contactID}`). ##### Use Cases - Mark an owner as inactive when they no longer have an active relationship with the property management company - Prevent future distributions or portal access without deleting the record ##### Business Rules - Requires `Contacts.UpdateOwner` permission. - Returns `400` if the contact is not found or is not an owner. - Access is restricted to contacts within the authenticated account's scope via `verifyAccessToContact`. - Sets `isActive = 0` and updates `dateTimeModified` and `dateTimeDeactivated` on the contact record. - The response is the full owner detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /owners/{contactID}` — retrieve owner details - `POST /owners/{contactID}/activate` — re-activate a deactivated owner - `POST /owners/{contactID}` — update owner fields Parameters: - `contactID` (path, integer, required): The unique owner contact ID to deactivate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portfolios`, `portalAccounts`, `portalInvitations`, `taxAdjustments` Responses: - `200`: Owner successfully deactivated — returns updated owner detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `firstName` (string | null) - `lastName` (string | null) - `isActive` (string, required, one of "0", "1"): Will be `"0"` after deactivation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): Set to the timestamp of deactivation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "3513", "contactTypeID": "1", "vendorTypeID": null, "code": null, "name": "Chris Campos", "firstName": "Chris", "middleName": null, "lastName": "Campos", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "0", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2025-02-28 18:17:58", "dateTimeModified": "2026-04-24 15:50:53", "dateTimeDeactivated": "2026-04-24 15:50:53", "contactType": "Owner", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Owner 3513 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` ### Tenants #### List Tenants `GET /tenants` Operation ID: `listTenants` Returns a page of tenants, sorted by name. Each item holds the full contact row under `contact`, and a `token`. Use `GET /tenants/search` for more filters and computed columns. ##### Use Cases - Page through every active (or inactive) tenant on the account - Look up tenants by name or code ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets only the tenants on a lease at a property in those groups' portfolios, plus tenants on no lease at all (a filtered 200, never a 403). - `isActive` defaults to `1`: only active tenants. `0` returns only inactive ones; any value other than `1`, `true`, `yes`, `0`, `false` or `no` (such as `all`) returns both. - `search` is a substring match on `name` and `code`. The text is HTML-encoded before it is matched, so text holding `'`, `"`, `&`, `<` or `>` (`O'Brien`, `Smith & Sons`) finds nothing here; `GET /tenants/search` matches it as typed. - The page size defaults to 15 and is capped at 5000. - Sorted by `name` alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through `GET /tenants/search`, which breaks ties on `contactID`. ##### Related Endpoints - `GET /tenants/search` - filtered search with computed insurance and tax columns - `GET /tenants/{contactID}` - one tenant, with includes - `POST /tenants` - create a tenant Parameters: - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 15, minimum 1): Items per page, from 1 (default 15). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name` and `code`. HTML-encoded before matching, so text holding `'`, `"`, `&`, `<` or `>` finds nothing. - `isActive` (query, string, default "1"): `1` (the default) returns active contacts, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. Responses: - `200`: A page of tenants - `application/json`: `contact_list_item`[] Example: ```json [ { "contact": { "contactID": "2687", "contactTypeID": "2", "vendorTypeID": null, "code": "C-6af8ddd9e2729", "name": "Jane Doe", "firstName": "Jane", "middleName": null, "lastName": "Doe", "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "OR", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "163", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "147", "dateTimeCreated": "2026-11-14 22:16:57", "dateTimeModified": "2026-11-14 22:16:57", "dateTimeDeactivated": null, "contactType": "Tenant" }, "token": "1794694618" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Tenant `POST /tenants` Operation ID: `createTenant` Creates a new tenant contact and returns the full tenant detail (same shape as `GET /tenants/{contactID}`). ##### Use Cases - Onboard a new tenant into the system before adding them to a lease - Create a tenant with contact details (emails, phones, addresses) in a single request ##### Business Rules - Requires `Contacts.UpdateTenant` permission. - `name` is required. - Accepted fields are restricted to `code`, `name`, `websiteUrl`, `birthDate`, `identificationTypeID`, `identificationNumber`, `identificationCountryID`, `identificationIssuingLocation`, and `identificationExpirationDate`. Any other fields in the request body are silently ignored. - Tax fields (`taxPayerName`, `taxFormTypeID`, `taxIdentifier`) require the `Contacts.ManageTaxInfo` permission. - After creation the endpoint forwards to the view action — the response is the full tenant detail. ##### Related Endpoints - `GET /tenants/{contactID}` — retrieve the created tenant - `POST /tenants/{contactID}` — update tenant fields after creation Request body, required: - `application/json`: object - `name` (string, required): Full display name of the tenant - `code` (string | null): Optional short code for the tenant - `birthDate` (string | null, date) - `identificationTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Government ID type identifier - `identificationNumber` (string | null): Government ID number - `identificationCountryID` (string | null): Country that issued the government ID - `identificationIssuingLocation` (string | null): State or location that issued the government ID - `identificationExpirationDate` (string | null, date): Expiration date of the government ID - `emails` (object[]): Email records to attach to the tenant - `email` (string, email) - `phones` (object[]): Phone records to attach to the tenant - `phone` (string) - `addresses` (object[]): Address records to attach to the tenant Example: ```json { "name": "Aaron Boone" } ``` Responses: - `200`: Tenant successfully created — returns full tenant detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5261", "contactTypeID": "2", "vendorTypeID": null, "code": null, "name": "TestAPI docs", "firstName": "TestAPI", "middleName": null, "lastName": "docs", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 18:44:58", "dateTimeModified": "2026-04-24 18:44:58", "dateTimeDeactivated": null, "contactType": "Tenant", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Search Tenants `GET /tenants/search` Operation ID: `searchTenants` Returns a page of tenants with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under `contact`. With `search`, each row also carries `search.rank`. ##### Use Cases - Find tenants by name, code, email, phone or address (the row doesn't carry `code`: read it from `GET /tenants/{contactID}`) - Sync tenants changed since a point in time with `dateTimeModifiedMin` - Review tax-identifier data quality with `hasTaxIdentifier`, `isTaxIdentifierValid` and `hasDuplicateTaxIdentifier` ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets only the tenants on a lease at a property in those groups' portfolios, plus tenants on no lease at all (a filtered 200, never a 403). - `isActive` filters only when sent: without it the search returns active and inactive tenants. - `search` is a substring match on `name`, `code`, `email`, `phone` and `address`; spaces in the text match any run of characters. Each row then carries a `search.rank`. - The page size defaults to 25, with no upper limit today; a `pageSize` of `0` or less is served at 15. - Sorted by `orderBy` (default `contact.name`), then by `contactID`. An `orderBy` column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in `contactID` order. - Boolean filters read `1`, `true` and `yes` as yes and `0`, `false` and `no` as no; any other value is ignored. - List filters take each value as a separate `name[]=`. ##### Related Endpoints - `GET /tenants` - the plain list, with the full contact row - `GET /tenants/{contactID}` - one tenant, with includes Parameters: - `page` (query, integer, default 1): Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit today. `0`, a negative value or a value that isn't a number is served at 15. - `search` (query, string): Substring match on `name`, `code`, `email`, `phone` and `address`. Spaces in the text match any run of characters. - `payoutTypeID` (query, `payout_types_request`): Only contacts paid this way. A value that isn't a number is ignored. - `holdPayments` (query, string): Only contacts whose payouts are on hold (`1`) or not (`0`). Every tenant stores `0`, so `1` returns none. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isActive` (query, string): Only active (`1`) or inactive (`0`) contacts. Without it, both. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `hasTaxIdentifier` (query, string): Only contacts with (`1`) or without (`0`) a stored tax identifier. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isTaxIdentifierValid` (query, string): Only contacts whose stored tax identifier passed (`1`) or failed (`0`) validation; a contact with no identifier counts as `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `taxIdentifierTypeIDs[]` (query, `tax_identifier_types_request`[]): Only contacts whose stored tax identifier is of these types. Send each value as a separate `taxIdentifierTypeIDs[]=`. - `hasDuplicateTaxIdentifier` (query, string): Only contacts whose tax identifier another contact also stores (`1`), or that no other contact shares (`0`, including contacts with none). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `dateTimeModifiedMin` (query, string): Only contacts last modified on or after this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send `20240101` as `2024-01-01`. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only contacts last modified on or before this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound. - `isInsuranceRequiredForPayment` (query, string): Only contacts that must (`1`) or needn't (`0`) have current insurance to be paid. The API stores null here for tenants, so `1` returns none and `0` only a few older rows that store `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `orderBy` (query, string, default "contact.name"): Sort columns, comma-separated, each optionally followed by `|desc` (or `|asc`, the default): `contact.name|desc`. Default `contact.name`; `contactID` breaks ties. Sortable: `contact.contactID`, `contact.isActive`, `contact.contactTypeID`, `contact.vendorTypeID`, `contact.name`, `contact.email`, `contact.phone`, `contact.defaultBillChargeAccountID`, `contact.payeeName`, `contact.taxPayerName`, `contact.taxFormTypeID`, `contact.payoutTypeID`, `contact.achAccountNumberTruncated`, `contact.achAccountTypeID`, `contact.holdPayments`, `contact.liabilityInsuranceName`, `contact.workersCompInsurancePolicyNumber`, `contact.workersCompInsuranceExpiresDate`, `contact.discountPercent`, `contact.discountGraceDays`, `contact.isInsuranceRequiredForPayment`, `contact.isTaxIdentifierValid`, `contact.taxIdentifierTypeID`, `contact.taxIdentifierCountryID`, `contact.hasTaxIdentifier`, `contact.hasDuplicateTaxIdentifier`, `contact.propertyCount`, `contact.daysUntilInsuranceExpires`, `contact.daysUntilLiabilityInsuranceExpires`, `contact.daysUntilWorkersCompInsuranceExpires`, and `search.rank` when `search` is sent. Any other column is dropped without an error; with none left, rows come back in `contactID` order. A `-` prefix isn't read as descending: it makes the column unknown. Responses: - `200`: A page of matching tenants - `application/json`: `contact_search_item`[] Example: ```json [ { "contact": { "contactID": "2764", "contactTypeID": "2", "vendorTypeID": null, "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NY", "postalCode": "12345", "countryID": "US", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "payoutTypeID": "1", "achDetailsCiphertextID": "168", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "isBillingSalesTaxEnabled": "0", "daysUntilLiabilityInsuranceExpires": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "daysUntilWorkersCompInsuranceExpires": null, "insuranceExpiresDate": null, "daysUntilInsuranceExpires": null, "discountPercent": null, "discountGraceDays": null, "isActive": "1", "invoiceAutofillTemplateID": "152", "dateTimeCreated": "2026-11-14 22:17:12", "dateTimeModified": "2026-11-14 22:17:12", "dateTimeDeactivated": null, "isInsuranceRequiredForPayment": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "identificationCountryID": "US", "hasTaxIdentifier": "1", "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "1", "taxIdentifierCountryID": "US", "hasDuplicateTaxIdentifier": "0", "propertyCount": "0" }, "search": { "rank": "10" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Tenant `GET /tenants/{contactID}` Operation ID: `getTenant` Returns one tenant: the full contact row under `contact`, with the tax-identifier flags, and the related records the `includes` parameter names, each under its own key. ##### Use Cases - Show a tenant's full record - Load the tenant's emails, phones and addresses in the same request ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups (a manager user or API key that is a member of one or more portfolio groups) can read a tenant only when the tenant is on a lease at a property in those groups' portfolios, or on no lease at all; any other tenant is refused with a 403. - A well-formed ID with no contact, or the ID of a contact of another type, answers 400 `{"error": "Tenant {contactID} not found"}`. An ID that isn't a whole number of digits answers the stock 404. - The tax identifier itself is never returned: `contact.hasTaxIdentifier` says whether one is stored. - `includes` names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored. ##### Available Includes (6) - `emails` - the contact's email addresses, each under `email` - `phones` - the contact's phone numbers, each under `phone` - `addresses` - the contact's addresses, each under `address` - `leases` - the leases the tenant is on, each with `leaseTenant`, `contact`, `lease`, `property` and `unit`. Documented for a user with no portfolio-group restriction; a restricted user reads a tenant's leases through `GET /leases/search`. - `portalAccounts` - the resident portal accounts linked to the contact - `portalInvitations` - the pending, unexpired invitations to the resident portal, newest first ##### Related Endpoints - `GET /tenants` - list tenants - `GET /tenants/search` - search tenants - `POST /tenants/{contactID}` - update the tenant Parameters: - `contactID` (path, integer, required): The tenant's contact ID. A well-formed ID that isn't a tenant answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. - `includes` (query, string): Comma-separated related records to add: `emails`, `phones`, `addresses`, `leases`, `portalAccounts`, `portalInvitations`. Responses: - `200`: The tenant, with the includes requested - `application/json`: object - `contact` (`contact_detail`, required) - `emails` (`contact_email_row`[]): The contact's email addresses, each under `email`. Requires the `emails` include. - `phones` (`contact_phone_row`[]): The contact's phone numbers, each under `phone`. Requires the `phones` include. - `addresses` (`contact_address_row`[]): The contact's addresses, each under `address`. Requires the `addresses` include. - `leases` (`tenant_lease_row`[]): The leases the tenant is on, each with `leaseTenant`, `contact`, `lease`, `property` and `unit`. Requires the `leases` include. Documented for a user with no portfolio-group restriction; a restricted user reads a tenant's leases through `GET /leases/search`. - `portalAccounts` (`contact_portal_account`[]): The resident portal accounts linked to the contact. Requires the `portalAccounts` include. - `portalInvitations` (`contact_portal_invitation`[]): The pending, unexpired invitations to the resident portal, newest first. Requires the `portalInvitations` include. Example: ```json { "contact": { "contactID": "2959", "contactTypeID": "2", "vendorTypeID": null, "code": "C-6af8ddfd2cfac", "name": "Jane Doe", "firstName": "Jane", "middleName": null, "lastName": "Doe", "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "MA", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "173", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "157", "dateTimeCreated": "2026-11-14 22:17:33", "dateTimeModified": "2026-11-14 22:17:33", "dateTimeDeactivated": null, "contactType": "Tenant", "hasTaxIdentifier": 1, "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "1", "taxIdentifierCountryID": "US" }, "emails": [ { "email": { "contactEmailID": "106", "contactID": "2959", "isPrimary": "1", "email": "jane.doe@example.com", "sendEmailNotifications": "1", "sendPaymentNotifications": "1", "sendWorkOrderNotifications": "1" } } ], "phones": [ { "phone": { "contactPhoneID": "106", "contactID": "2959", "isPrimary": "1", "phone": "555-0100", "phoneTypeID": "1", "description": "Office", "isActive": "1" } } ], "addresses": [ { "address": { "contactAddressID": "106", "contactID": "2959", "isPrimary": "1", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NC", "postalCode": "12345" } } ], "leases": [ { "leaseTenant": { "leaseTenantID": "276", "leaseID": "361", "contactID": "2959", "isPrimary": "1", "isActive": "1", "moveInDate": "2026-11-14", "moveOutDate": null }, "contact": { "contactID": "2959", "contactTypeID": "2", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100" }, "lease": { "leaseID": "361", "propertyID": "590", "unitID": "463", "startDate": "2026-12-13", "endDate": "2027-12-13", "primaryLeaseStatusID": "1", "leaseStatusID": "1" }, "property": { "propertyID": "590", "isMultiUnit": "0", "propertyTypeID": "1", "name": "803 Dibbert Mall", "address": "123 Main St", "address2": null, "city": "Springfield", "stateID": "MO", "postalCode": "12345", "countryID": "US" }, "unit": { "unitID": "463", "name": "Unit 452", "address": "123 Main St", "address2": null, "city": "Springfield", "stateID": "AR", "postalCode": "12345", "addressValidationStatusID": "1" } } ], "portalAccounts": [ { "userPortalAccountID": "107", "userID": "1925", "accountID": "1", "portalTypeID": "3", "portalID": "2959", "email": "jane.doe@example.com", "isActive": "1", "firstName": "Jane", "lastName": "Doe", "phone": "555-0100", "timeZone": "UTC" } ], "portalInvitations": [ { "userPortalInvitationID": "105", "accountID": "1", "portalInvitationStatusID": "1", "portalTypeID": "3", "portalID": "2959", "email": "jane.doe@example.com", "roleID": "1", "portfolioGroupIDs": "[1, 2]", "dateTimeCreated": "2026-11-14 22:17:33", "dateTimeExpires": "2026-12-14 22:17:33", "nextReminderDateTime": "2026-11-16 22:17:33" } ] } ``` - `400`: No tenant has this ID: no contact, or a contact of another type. - `application/json`: object - `error` (string, required): `Tenant {contactID} not found` Example: ```json { "error": "Tenant 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The tenant is outside the user's portfolio restrictions. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Tenant `POST /tenants/{contactID}` Operation ID: `updateTenant` Updates editable fields on an existing tenant contact and returns the full tenant detail (same shape as `GET /tenants/{contactID}`). ##### Use Cases - Update a tenant's display name, code, birth date, or government identification details - Correct a name spelling or code after initial creation ##### Business Rules - Requires `Update Tenant Details` permission. - Returns `400` if the contact is not found or is not a tenant. - Access is restricted to contacts within the authenticated account's scope. - Only the following fields are accepted: `code`, `name`, `birthDate`, `identificationTypeID`, `identificationNumber`, `identificationCountryID`, `identificationIssuingLocation`, `identificationExpirationDate`. All other fields in the request body are silently ignored. - After update the endpoint forwards to the view action — pass `includes` query params to include related data in the response. ##### Related Endpoints - `GET /tenants/{contactID}` — retrieve current tenant detail - `POST /tenants/{contactID}/activate` — activate an inactive tenant - `POST /tenants/{contactID}/deactivate` — deactivate an active tenant Parameters: - `contactID` (path, integer, required): The unique tenant contact ID - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `leases`, `portalAccounts`, `portalInvitations` Request body, required: - `application/json`: object - `name` (string): Full display name of the tenant - `code` (string | null): Optional short code - `birthDate` (string | null, date) - `identificationTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Government ID type identifier - `identificationNumber` (string | null): Government ID number - `identificationCountryID` (string | null): Country that issued the government ID - `identificationIssuingLocation` (string | null): State or location that issued the government ID - `identificationExpirationDate` (string | null, date): Expiration date of the government ID Example: ```json { "name": "Aaron Boone" } ``` Responses: - `200`: Tenant successfully updated — returns full tenant detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "4976", "contactTypeID": "2", "vendorTypeID": null, "code": null, "name": "testing api", "firstName": "testing", "middleName": null, "lastName": "apii", "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-02-03 16:47:21", "dateTimeModified": "2026-04-24 19:00:00", "dateTimeDeactivated": null, "contactType": "Tenant", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Delete Tenant `DELETE /tenants/{contactID}` Operation ID: `deleteTenant` Permanently deletes a tenant contact. Returns the deleted contact as a flat object (not wrapped in a `contact` key). ##### Use Cases - Remove a tenant who was created in error - Clean up test or duplicate tenant records ##### Business Rules - Requires `Contacts.UpdateTenant` permission. - Returns `400` if the contact is not found or is not a tenant. - Access is restricted to contacts within the authenticated account's scope. - Deletion may fail if the tenant has associated financial records or active lease memberships — the service layer will return errors in that case. - The response is the contact's last known state as a flat object (no `contact` wrapper). ##### Related Endpoints - `POST /tenants/{contactID}/deactivate` — soft-deactivate instead of permanently deleting - `GET /tenants/{contactID}` — verify tenant state before deletion Parameters: - `contactID` (path, integer, required): The unique tenant contact ID to delete Responses: - `200`: Tenant successfully deleted — returns the deleted contact record (flat) - `application/json`: `contact` Example: ```json { "contactID": "2793", "contactTypeID": "2", "vendorTypeID": null, "code": null, "name": "Aaron Boone", "firstName": "Aaron", "middleName": null, "lastName": "Boone", "suffix": null, "email": "tenant@example.com", "phone": "+12395370474", "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": "1981-10-22", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "isActive": "1", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "dateTimeCreated": "2024-10-31 17:32:50", "dateTimeModified": "2025-04-25 21:06:37", "dateTimeDeactivated": null, "contactType": "Tenant" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Tenant 2793 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Activate Tenant `POST /tenants/{contactID}/activate` Operation ID: `activateTenant` Sets a tenant's `isActive` flag to `1`, re-activating them after a previous deactivation. Returns the updated tenant detail (same shape as `GET /tenants/{contactID}`). ##### Use Cases - Re-activate a tenant who was previously deactivated but has renewed a lease - Restore tenant portal access after reinstatement ##### Business Rules - Requires `Update Tenant Details` permission. - Returns `400` if the contact is not found or is not a tenant. - Sets `isActive = 1` ##### Related Endpoints - `GET /tenants/{contactID}` — retrieve tenant details - `POST /tenants/{contactID}/deactivate` — deactivate an active tenant - `POST /tenants/{contactID}` — update tenant fields Parameters: - `contactID` (path, integer, required): The unique tenant contact ID to activate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `leases`, `portalAccounts`, `portalInvitations` Responses: - `200`: Tenant successfully activated — returns updated tenant detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `firstName` (string | null) - `lastName` (string | null) - `isActive` (string, required, one of "0", "1"): Will be `"1"` after activation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Cleared to null after re-activation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2793", "contactTypeID": "2", "vendorTypeID": null, "code": null, "name": "Aaron Boone", "firstName": "Aaron", "middleName": null, "lastName": "Boone", "suffix": null, "email": "tenant@example.com", "phone": "+12395370474", "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": "1981-10-22", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": "907", "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-10-31 17:32:50", "dateTimeModified": "2026-04-24 18:00:00", "dateTimeDeactivated": null, "contactType": "Tenant", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Tenant 2793 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Deactivate Tenant `POST /tenants/{contactID}/deactivate` Operation ID: `deactivateTenant` Sets a tenant's `isActive` flag to `0`, marking them as inactive. Returns the updated tenant detail (same shape as `GET /tenants/{contactID}`). ##### Use Cases - Mark a tenant as inactive after they have vacated and closed out their lease - Prevent portal access without permanently deleting the contact record ##### Business Rules - Requires `Update Tenant Details` permission. - Returns `400` if the contact is not found or is not a tenant. - Sets `isActive = 0` and updates `dateTimeModified` and `dateTimeDeactivated` on the contact record. - The response is the full tenant detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /tenants/{contactID}` — retrieve tenant details - `POST /tenants/{contactID}/activate` — re-activate a deactivated tenant - `POST /tenants/{contactID}` — update tenant fields Parameters: - `contactID` (path, integer, required): The unique tenant contact ID to deactivate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `leases`, `portalAccounts`, `portalInvitations` Responses: - `200`: Tenant successfully deactivated — returns updated tenant detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `firstName` (string | null) - `lastName` (string | null) - `isActive` (string, required, one of "0", "1"): Will be `"0"` after deactivation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): Set to the timestamp of deactivation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2793", "contactTypeID": "2", "vendorTypeID": null, "code": null, "name": "Aaron Boone", "firstName": "Aaron", "middleName": null, "lastName": "Boone", "suffix": null, "email": "tenant@example.com", "phone": "+12395370474", "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": "1981-10-22", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "0", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": "907", "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-10-31 17:32:50", "dateTimeModified": "2026-04-24 18:15:00", "dateTimeDeactivated": "2026-04-24 18:15:00", "contactType": "Tenant", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Tenant 2793 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` ### Vendors #### List Vendors `GET /vendors` Operation ID: `listVendors` Returns a page of vendors, sorted by name. Each item holds the full contact row under `contact`, and a `token`. Use `GET /vendors/search` for more filters and computed columns. ##### Use Cases - Page through every active (or inactive) vendor on the account - Look up vendors by name or code - Load a known set of contacts by ID with `contactIDs[]` ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every vendor. - `isActive` defaults to `1`: only active vendors. `0` returns only inactive ones; any value other than `1`, `true`, `yes`, `0`, `false` or `no` (such as `all`) returns both. - `search` is a substring match on `name` and `code`. The text is HTML-encoded before it is matched, so text holding `'`, `"`, `&`, `<` or `>` (`O'Brien`, `Smith & Sons`) finds nothing here; `GET /vendors/search` matches it as typed. - The page size defaults to 250 and is capped at 5000. - Sorted by `name` alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through `GET /vendors/search`, which breaks ties on `contactID`. - `includeManager` adds manager contacts and `includeMaintenanceTechnician` adds maintenance technicians to the list. - `contactIDs[]` (or `vendorContactIDs[]`) returns those contacts when they are vendors, maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply. ##### Related Endpoints - `GET /vendors/search` - filtered search with computed insurance and tax columns - `GET /vendors/{contactID}` - one vendor, with includes - `POST /vendors` - create a vendor Parameters: - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 250, minimum 1): Items per page, from 1 (default 250). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name` and `code`. HTML-encoded before matching, so text holding `'`, `"`, `&`, `<` or `>` finds nothing. - `isActive` (query, string, default "1"): `1` (the default) returns active contacts, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. - `includeManager` (query, string): Also list manager contacts. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `includeMaintenanceTechnician` (query, string): Also list maintenance technicians. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTypeID` (query, integer): Only contacts of this vendor type, from `GET /contacts/vendor-types` (undocumented). A value that isn't a number is ignored. - `contactIDs[]` (query, integer[]): Only these contacts. Send each ID as a separate `contactIDs[]=`; a single `contactIDs=` value holding an ID is read as a list of one. Widens the types listed to vendors, maintenance technicians and managers. `vendorContactIDs[]` is read when `contactIDs[]` isn't sent. - `vendorContactIDs[]` (query, integer[]): The older name of `contactIDs[]`, read only when `contactIDs[]` isn't sent. Responses: - `200`: A page of vendors - `application/json`: `contact_list_item`[] Example: ```json [ { "contact": { "contactID": "2688", "contactTypeID": "3", "vendorTypeID": "402", "code": "C-6af8ddda885b4", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "ME", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "164", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "discountPercent": "2.5000", "discountAmount": null, "discountAmountMin": "1.00", "discountAmountMax": "50.00", "discountGraceDays": "10", "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": "Rivera Holdings", "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "1", "isQuickbooksExportEnabled": "1", "quickbooksCustomerName": "Rivera, Jordan", "invoiceAutofillTemplateID": "148", "dateTimeCreated": "2026-11-14 22:16:58", "dateTimeModified": "2026-11-14 22:16:58", "dateTimeDeactivated": null, "contactType": "Vendor" }, "token": "1794694618" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Vendor `POST /vendors` Operation ID: `createVendor` Creates a new vendor contact and returns the full vendor detail (same shape as `GET /vendors/{contactID}`). ##### Use Cases - Onboard a new vendor into the system with name, contact info, and payout settings - Create a vendor with initial emails, phones, and addresses in a single request ##### Business Rules - Requires `Update Vendor Details` permission. - `name` is the only required field. - After creation the endpoint forwards to the view action — the response is the full vendor detail. ##### Related Endpoints - `GET /vendors/{contactID}` — retrieve the created vendor - `POST /vendors/{contactID}` — update vendor fields after creation Request body, required: - `application/json`: object - `name` (string, required): Full display name of the vendor - `vendorTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor trade category type ID - `code` (string | null): Optional short code or reference - `defaultBillChargeAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Default chart of accounts ID for bills - `websiteUrl` (string | null, uri): Vendor website URL - `payeeName` (string | null): Override name for checks and ACH - `payoutTypeID` (`payout_types_request`) - `achAccountTypeID` (one of several shapes) - One of: - Option 1: `bank_account_types_request` - Option 2: null - `achIsCorporateAccount` (string | integer, pattern `^-?[0-9]+$`): "1" if ACH account is corporate, "0" otherwise - `holdPayments` (string | integer, pattern `^-?[0-9]+$`): "1" to hold all payments to this vendor - `preventConsolidatedPayments` (string | integer, pattern `^-?[0-9]+$`): "1" to prevent consolidated payouts - `maxLineItemsOnPayment` (string | integer | null, pattern `^-?[0-9]+$`): Maximum number of line items allowed per payment run - `taxPayerName` (string | null): Name on 1099 tax documents (requires ManageTaxInfo permission) - `taxIdentifier` (string | null): SSN/EIN stored encrypted (requires ManageTaxInfo permission) - `taxFormTypeID` (string | integer | null, pattern `^-?[0-9]+$`): 1099 form type ID (requires ManageTaxInfo permission) - `discountPercent` (string | number | null, decimal): Discount percentage applied to bills from this vendor - `discountGraceDays` (string | integer | null, pattern `^-?[0-9]+$`): Grace days before discount expires - `routingNumber` (string | null): ACH routing number — stored encrypted, not returned in responses - `accountNumber` (string | null): ACH account number — stored encrypted, only last 4 digits returned - `emails` (object[]): Email records to attach to the vendor - `email` (string | null, email) - `phones` (object[]): Phone records to attach to the vendor - `phone` (string | null) - `phoneTypeID` (string | integer | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `addresses` (object[]): Address records to attach to the vendor - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `attachments` (integer[]): File IDs to attach to the vendor record Example: ```json { "name": "New Vendor" } ``` Responses: - `200`: Vendor successfully created — returns full vendor detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5263", "contactTypeID": "3", "vendorTypeID": null, "code": null, "name": "New Vendor", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "New Vendor", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 19:26:47", "dateTimeModified": "2026-04-24 19:26:47", "dateTimeDeactivated": null, "contactType": "Vendor", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Search Vendors `GET /vendors/search` Operation ID: `searchVendors` Returns a page of vendors with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under `contact`. With `search`, each row also carries `search.rank`. ##### Use Cases - Find vendors by name, code, email, phone or address (the row doesn't carry `code`: read it from `GET /vendors/{contactID}`) - Sync vendors changed since a point in time with `dateTimeModifiedMin` - Review tax-identifier data quality with `hasTaxIdentifier`, `isTaxIdentifierValid` and `hasDuplicateTaxIdentifier` ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every vendor. - `isActive` filters only when sent: without it the search returns active and inactive vendors. - `search` is a substring match on `name`, `code`, `email`, `phone` and `address`; spaces in the text match any run of characters. Each row then carries a `search.rank`. - The page size defaults to 25, with no upper limit today; a `pageSize` of `0` or less is served at 15. - Sorted by `orderBy` (default `contact.name`), then by `contactID`. An `orderBy` column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in `contactID` order. - Boolean filters read `1`, `true` and `yes` as yes and `0`, `false` and `no` as no; any other value is ignored. - List filters take each value as a separate `name[]=`. - `includeManager=1` adds manager contacts and `includeMaintenanceTechnician=1` adds maintenance technicians. Only `1`, `true` or `yes` turns them on. - `isLiabilityInsuranceExpired`, `isWorkersCompInsuranceExpired` and `isInsuranceExpired` take only a yes value; `0`, `false` and `no` aren't supported. ##### Related Endpoints - `GET /vendors` - the plain list, with the full contact row - `GET /vendors/{contactID}` - one vendor, with includes Parameters: - `page` (query, integer, default 1): Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit today. `0`, a negative value or a value that isn't a number is served at 15. - `search` (query, string): Substring match on `name`, `code`, `email`, `phone` and `address`. Spaces in the text match any run of characters. - `includeManager` (query, string): Also return manager contacts. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `includeMaintenanceTechnician` (query, string): Also return maintenance technicians. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTypeIDs[]` (query, integer[]): Only contacts of these vendor types, from `GET /contacts/vendor-types` (undocumented). Send each value as a separate `vendorTypeIDs[]=`. - `payoutTypeID` (query, `payout_types_request`): Only contacts paid this way. A value that isn't a number is ignored. - `holdPayments` (query, string): Only contacts whose payouts are on hold (`1`) or not (`0`). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isActive` (query, string): Only active (`1`) or inactive (`0`) contacts. Without it, both. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `hasTaxIdentifier` (query, string): Only contacts with (`1`) or without (`0`) a stored tax identifier. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isTaxIdentifierValid` (query, string): Only contacts whose stored tax identifier passed (`1`) or failed (`0`) validation; a contact with no identifier counts as `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `taxIdentifierTypeIDs[]` (query, `tax_identifier_types_request`[]): Only contacts whose stored tax identifier is of these types. Send each value as a separate `taxIdentifierTypeIDs[]=`. - `hasDuplicateTaxIdentifier` (query, string): Only contacts whose tax identifier another contact also stores (`1`), or that no other contact shares (`0`, including contacts with none). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `dateTimeModifiedMin` (query, string): Only contacts last modified on or after this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send `20240101` as `2024-01-01`. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only contacts last modified on or before this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound. - `isInsuranceRequiredForPayment` (query, string): Only contacts that must (`1`) or needn't (`0`) have current insurance to be paid. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTradeIDs[]` (query, integer[]): Only contacts assigned to at least one of these trades, from `GET /maintenance/vendor-trades`. Send each value as a separate `vendorTradeIDs[]=`. - `propertyIDs[]` (query, integer[]): Only contacts linked as the association of at least one of these properties (`POST /properties/associations` (undocumented) links a contact of any type, though normally only associations are linked, so this usually returns no vendors). Send each value as a separate `propertyIDs[]=`. - `isLiabilityInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose liability insurance has expired. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilLiabilityInsuranceExpiresMin` (query, integer): Only contacts whose liability insurance expires at least this many days from today. `0` is ignored. - `daysUntilLiabilityInsuranceExpiresMax` (query, integer): Only contacts whose liability insurance expires at most this many days from today (negative for already expired). `0` is ignored. - `isWorkersCompInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose workers' comp insurance has expired. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilWorkersCompInsuranceExpiresMin` (query, integer): Only contacts whose workers' comp insurance expires at least this many days from today. `0` is ignored. - `daysUntilWorkersCompInsuranceExpiresMax` (query, integer): Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). `0` is ignored. - `isInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose insurance (the earlier of the two dates) has expired. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilInsuranceExpiresMin` (query, integer): Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. `0` is ignored. - `daysUntilInsuranceExpiresMax` (query, integer): Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). `0` is ignored. - `tagIDs[]` (query, integer[]): Only contacts with at least one of these tags, from `GET /tags` (undocumented), attached to the contact as a vendor tag. Send each value as a separate `tagIDs[]=`. - `orderBy` (query, string, default "contact.name"): Sort columns, comma-separated, each optionally followed by `|desc` (or `|asc`, the default): `contact.name|desc`. Default `contact.name`; `contactID` breaks ties. Sortable: `contact.contactID`, `contact.isActive`, `contact.contactTypeID`, `contact.vendorTypeID`, `contact.name`, `contact.email`, `contact.phone`, `contact.defaultBillChargeAccountID`, `contact.payeeName`, `contact.taxPayerName`, `contact.taxFormTypeID`, `contact.payoutTypeID`, `contact.achAccountNumberTruncated`, `contact.achAccountTypeID`, `contact.holdPayments`, `contact.liabilityInsuranceName`, `contact.workersCompInsurancePolicyNumber`, `contact.workersCompInsuranceExpiresDate`, `contact.discountPercent`, `contact.discountGraceDays`, `contact.isInsuranceRequiredForPayment`, `contact.isTaxIdentifierValid`, `contact.taxIdentifierTypeID`, `contact.taxIdentifierCountryID`, `contact.hasTaxIdentifier`, `contact.hasDuplicateTaxIdentifier`, `contact.propertyCount`, `contact.daysUntilInsuranceExpires`, `contact.daysUntilLiabilityInsuranceExpires`, `contact.daysUntilWorkersCompInsuranceExpires`, and `search.rank` when `search` is sent. Any other column is dropped without an error; with none left, rows come back in `contactID` order. A `-` prefix isn't read as descending: it makes the column unknown. Responses: - `200`: A page of matching vendors - `application/json`: `contact_search_item`[] Example: ```json [ { "contact": { "contactID": "2766", "contactTypeID": "3", "vendorTypeID": "410", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "OK", "postalCode": "12345", "countryID": "US", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "payoutTypeID": "1", "achDetailsCiphertextID": "169", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "isBillingSalesTaxEnabled": "1", "daysUntilLiabilityInsuranceExpires": "1324", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "daysUntilWorkersCompInsuranceExpires": "1355", "insuranceExpiresDate": "2030-06-30", "daysUntilInsuranceExpires": "1324", "discountPercent": "2.5000", "discountGraceDays": "10", "isActive": "1", "invoiceAutofillTemplateID": "153", "dateTimeCreated": "2026-11-14 22:17:13", "dateTimeModified": "2026-11-14 22:17:13", "dateTimeDeactivated": null, "isInsuranceRequiredForPayment": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "identificationCountryID": "US", "hasTaxIdentifier": "1", "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null, "hasDuplicateTaxIdentifier": "0", "propertyCount": "0" }, "search": { "rank": "10" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Vendor `GET /vendors/{contactID}` Operation ID: `getVendor` Returns one vendor: the full contact row under `contact`, with the tax-identifier flags, and the related records the `includes` parameter names, each under its own key. ##### Use Cases - Show a vendor's full record - Load the vendor's emails, phones and addresses in the same request ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every vendor. - A well-formed ID with no contact, or the ID of a contact of another type, answers 400 `{"error": "Vendor {contactID} not found"}`. An ID that isn't a whole number of digits answers the stock 404. - The tax identifier itself is never returned: `contact.hasTaxIdentifier` says whether one is stored. - `includes` names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored. ##### Available Includes (10) - `emails` - the contact's email addresses, each under `email` - `phones` - the contact's phone numbers, each under `phone` - `addresses` - the contact's addresses, each under `address` - `portalAccounts` - the vendor portal accounts linked to the contact - `portalInvitations` - the pending, unexpired invitations to the vendor portal, newest first - `vendorTrades` - the trades assigned to the contact, each as `contactVendorTrade` and `vendorTrade` - `taxAdjustments` - the contact's 1099 tax adjustments - `contactPersons` - the people on file at the contact - `reviewStats` - one row counting the contact's completed maintenance reviews by rating - `invoiceAutofillTemplate` - the invoice autofill template the contact uses, or null when it has none ##### Related Endpoints - `GET /vendors` - list vendors - `GET /vendors/search` - search vendors - `POST /vendors/{contactID}` - update the vendor Parameters: - `contactID` (path, integer, required): The vendor's contact ID. A well-formed ID that isn't a vendor answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. - `includes` (query, string): Comma-separated related records to add: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate`. Responses: - `200`: The vendor, with the includes requested - `application/json`: object - `contact` (`contact_detail`, required) - `emails` (`contact_email_row`[]): The contact's email addresses, each under `email`. Requires the `emails` include. - `phones` (`contact_phone_row`[]): The contact's phone numbers, each under `phone`. Requires the `phones` include. - `addresses` (`contact_address_row`[]): The contact's addresses, each under `address`. Requires the `addresses` include. - `portalAccounts` (`contact_portal_account`[]): The vendor portal accounts linked to the contact. Requires the `portalAccounts` include. - `portalInvitations` (`contact_portal_invitation`[]): The pending, unexpired invitations to the vendor portal, newest first. Requires the `portalInvitations` include. - `vendorTrades` (`vendor_trade_row`[]): The trades assigned to the contact, each as `contactVendorTrade` and `vendorTrade`. Requires the `vendorTrades` include. - `taxAdjustments` (`contact_tax_adjustment`[]): The contact's 1099 tax adjustments. Requires the `taxAdjustments` include. - `contactPersons` (`contact_person`[]): The people on file at the contact. Requires the `contactPersons` include. - `reviewStats` (`vendor_review_stats`[]): One row counting the contact's completed maintenance reviews by rating. Requires the `reviewStats` include. - `invoiceAutofillTemplate` (one of several shapes): The invoice autofill template the contact uses, or null when it has none. Requires the `invoiceAutofillTemplate` include. - One of: - Option 1: `contact_invoice_autofill_template` - Option 2: null Example: ```json { "contact": { "contactID": "2961", "contactTypeID": "3", "vendorTypeID": "447", "code": "C-6af8ddfdd5c93", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "SC", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "174", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "discountPercent": "2.5000", "discountAmount": null, "discountAmountMin": "1.00", "discountAmountMax": "50.00", "discountGraceDays": "10", "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": "Rivera Holdings", "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "1", "isQuickbooksExportEnabled": "1", "quickbooksCustomerName": "Rivera, Jordan", "invoiceAutofillTemplateID": "158", "dateTimeCreated": "2026-11-14 22:17:33", "dateTimeModified": "2026-11-14 22:17:33", "dateTimeDeactivated": null, "contactType": "Vendor", "hasTaxIdentifier": 1, "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null }, "emails": [ { "email": { "contactEmailID": "107", "contactID": "2961", "isPrimary": "1", "email": "jane.doe@example.com", "sendEmailNotifications": "1", "sendPaymentNotifications": "1", "sendWorkOrderNotifications": "1" } } ], "phones": [ { "phone": { "contactPhoneID": "107", "contactID": "2961", "isPrimary": "1", "phone": "555-0100", "phoneTypeID": "1", "description": "Office", "isActive": "1" } } ], "addresses": [ { "address": { "contactAddressID": "107", "contactID": "2961", "isPrimary": "1", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NC", "postalCode": "12345" } } ], "portalAccounts": [ { "userPortalAccountID": "108", "userID": "1927", "accountID": "1", "portalTypeID": "4", "portalID": "2961", "email": "jane.doe@example.com", "isActive": "1", "firstName": "Jane", "lastName": "Doe", "phone": "555-0100", "timeZone": "UTC" } ], "portalInvitations": [ { "userPortalInvitationID": "106", "accountID": "1", "portalInvitationStatusID": "1", "portalTypeID": "4", "portalID": "2961", "email": "jane.doe@example.com", "roleID": "1", "portfolioGroupIDs": "[1, 2]", "dateTimeCreated": "2026-11-14 22:17:33", "dateTimeExpires": "2026-12-14 22:17:33", "nextReminderDateTime": "2026-11-16 22:17:33" } ], "vendorTrades": [ { "contactVendorTrade": { "contactVendorTradeID": "146", "vendorTradeID": "178", "contactID": "2961" }, "vendorTrade": { "vendorTradeID": "178", "name": "provident deleniti dolorum", "isVisibleTenantPortal": "1" } } ], "taxAdjustments": [ { "taxAdjustmentID": "106", "contactID": "2961", "amount": "125.50", "description": "Prior-year adjustment", "datePosted": "2025-12-31" } ], "contactPersons": [ { "contactPersonID": "98", "contactID": "2961", "name": "Jane Doe", "title": "Office Manager", "email": "jane.doe@example.com", "phone": "555-0100" } ], "reviewStats": [ { "totalRatingCount": "0", "averageRating": "0.0000", "oneStarRatingCount": "0", "oneStarRatingPercent": "0.0000", "twoStarRatingCount": "0", "twoStarRatingPercent": "0.0000", "threeStarRatingCount": "0", "threeStarRatingPercent": "0.0000", "fourStarRatingCount": "0", "fourStarRatingPercent": "0.0000", "fiveStarRatingCount": "0", "fiveStarRatingPercent": "0.0000" } ], "invoiceAutofillTemplate": { "invoiceAutofillTemplateID": "158", "name": "Contract Template 6af8ddfdd490c", "isDefault": "1", "billDescription": "Repairs", "paymentMemo": "Invoice payment", "chargeDescription": "Repair charge" } } ``` - `400`: No vendor has this ID: no contact, or a contact of another type. - `application/json`: object - `error` (string, required): `Vendor {contactID} not found` Example: ```json { "error": "Vendor 999999999 not found" } ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Vendor `POST /vendors/{contactID}` Operation ID: `updateVendor` Updates editable fields on an existing vendor contact and returns the full vendor detail (same shape as `GET /vendors/{contactID}`). ##### Use Cases - Update a vendor's display name, code, website, or discount settings - Toggle bill approval exemption, sales tax, or QuickBooks export for a vendor - Update insurance information for payment eligibility ##### Business Rules - Requires `Update Vendor Details` permission. - Returns `400` if the contact is not found or is not a vendor. - `isBillApprovalExempt` requires the `Update Bill Approval Exemption` permission to take effect. - After update the endpoint forwards to the view action — pass `includes` query params to include related data in the response. ##### Related Endpoints - `GET /vendors/{contactID}` — retrieve current vendor detail Parameters: - `contactID` (path, integer, required): The unique vendor contact ID - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Request body, required: - `application/json`: object - `name` (string): Full display name of the vendor - `vendorTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor trade category type ID - `code` (string | null): Optional short code or reference - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Default chart of accounts ID for bills - `websiteUrl` (string | null, uri): Vendor website URL - `ownerPortalNameOverride` (string | null): Override display name shown in the owner portal - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | number | null, decimal): Discount percentage applied to bills - `discountAmount` (string | number | null, decimal): Flat discount amount applied to bills - `discountAmountMin` (string | number | null, decimal) - `discountAmountMax` (string | number | null, decimal) - `discountGraceDays` (string | integer | null, pattern `^-?[0-9]+$`): Grace days before discount expires - `isInsuranceRequiredForPayment` (string | integer | null, one of "0", "1", 0, 1, null): "1" if valid insurance is required before releasing payment - `isBillingSalesTaxEnabled` (string | integer, one of "0", "1", 0, 1): "1" to enable sales tax on invoices billed from this vendor - `isQuickbooksExportEnabled` (string | integer, one of "0", "1", 0, 1): "1" to enable QuickBooks export for this vendor - `quickbooksCustomerName` (string | null) - `invoiceAutofillTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the invoice autofill template to link - `isBillApprovalExempt` (string | integer, one of "0", "1", 0, 1): "1" to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) Example: ```json { "name": "New Vendor Name", "code": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "birthDate": null, "websiteUrl": null, "defaultBillChargeAccountID": null, "vendorTypeID": null, "discountGraceDays": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "isBillingSalesTaxEnabled": "0", "invoiceAutofillTemplateID": null } ``` Responses: - `200`: Vendor successfully updated — returns full vendor detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5263", "contactTypeID": "3", "vendorTypeID": null, "code": null, "name": "New Vendor Name", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "New Vendor", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 19:26:47", "dateTimeModified": "2026-04-24 19:28:28", "dateTimeDeactivated": null, "contactType": "Vendor", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Delete Vendor `DELETE /vendors/{contactID}` Operation ID: `deleteVendor` Permanently deletes a vendor contact. Returns the deleted contact as a flat object. ##### Use Cases - Remove a vendor who was created in error - Clean up test or duplicate vendor records ##### Business Rules - Requires `Update Vendor Details` permission. - Returns `400` if the contact is not found or is not a vendor. - Deletion may fail if the vendor has associated financial records (bills, invoices, payouts) — the service layer returns errors in that case. ##### Related Endpoints - `POST /vendors/{contactID}/deactivate` — soft-deactivate instead of permanently deleting - `GET /vendors/{contactID}` — verify vendor state before deletion Parameters: - `contactID` (path, integer, required): The unique vendor contact ID to delete Responses: - `200`: Vendor successfully deleted — returns the deleted contact record (flat) - `application/json`: `contact` Example: ```json { "contactID": "5263", "contactTypeID": "3", "vendorTypeID": null, "code": null, "name": "New Vendor Name", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "New Vendor", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 19:26:47", "dateTimeModified": "2026-04-24 19:28:28", "dateTimeDeactivated": null, "contactType": "Vendor" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Vendor 5263 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Activate Vendor `POST /vendors/{contactID}/activate` Operation ID: `activateVendor` Sets a vendor's `isActive` flag to `1`, re-activating them after a previous deactivation. Returns the updated vendor detail (same shape as `GET /vendors/{contactID}`). ##### Use Cases - Re-activate a vendor who was previously deactivated but is returning as an active supplier - Restore a vendor to eligibility for bill payments and work order assignments ##### Business Rules - Requires `Update Vendor Details` permission. - Returns `400` if the contact is not found or is not a vendor. - Sets `isActive = 1` and clears `dateTimeDeactivated` on the contact record. - The response is the full vendor detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /vendors/{contactID}` — retrieve vendor details - `POST /vendors/{contactID}/deactivate` — deactivate an active vendor - `POST /vendors/{contactID}` — update vendor fields Parameters: - `contactID` (path, integer, required): The unique vendor contact ID to activate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Responses: - `200`: Vendor successfully activated — returns updated vendor detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"1"` after activation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Cleared to null after re-activation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2888", "contactTypeID": "3", "vendorTypeID": null, "code": "help", "name": "Acme Plumbing", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-11-12 21:41:35", "dateTimeModified": "2026-04-24 19:25:39", "dateTimeDeactivated": null, "contactType": "Vendor", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Vendor 2888 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Deactivate Vendor `POST /vendors/{contactID}/deactivate` Operation ID: `deactivateVendor` Sets a vendor's `isActive` flag to `0`, soft-deactivating them. Returns the updated vendor detail (same shape as `GET /vendors/{contactID}`). ##### Use Cases - Deactivate a vendor who is no longer used to prevent new bill assignments - Soft-delete a vendor while preserving historical financial records ##### Business Rules - Requires `Update Vendor Details` permission. - Returns `400` if the contact is not found or is not a vendor. - Historical records (bills, invoices, payments) are preserved after deactivation. - The response is the full vendor detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /vendors/{contactID}` — retrieve vendor details - `POST /vendors/{contactID}/activate` — re-activate a deactivated vendor - `DELETE /vendors/{contactID}` — permanently delete a vendor Parameters: - `contactID` (path, integer, required): The unique vendor contact ID to deactivate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Responses: - `200`: Vendor successfully deactivated — returns updated vendor detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"0"` after deactivation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Set to the deactivation timestamp. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2888", "contactTypeID": "3", "vendorTypeID": null, "code": "help", "name": "Acme Plumbing", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "0", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-11-12 21:41:35", "dateTimeModified": "2026-04-24 19:25:39", "dateTimeDeactivated": "2026-04-24 19:25:39", "contactType": "Vendor", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Vendor 2888 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` ### Associations #### List Associations `GET /associations` Operation ID: `listAssociations` Returns a page of associations, sorted by name. Each item holds the full contact row under `contact`, and a `token`. Use `GET /associations/search` for more filters and computed columns. ##### Use Cases - Page through every active (or inactive) association on the account - Look up associations by name or code ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every association. - `isActive` defaults to `1`: only active associations. `0` returns only inactive ones; any value other than `1`, `true`, `yes`, `0`, `false` or `no` (such as `all`) returns both. - `search` is a substring match on `name` and `code`. The text is HTML-encoded before it is matched, so text holding `'`, `"`, `&`, `<` or `>` (`O'Brien`, `Smith & Sons`) finds nothing here; `GET /associations/search` matches it as typed. - The page size defaults to 15 and is capped at 5000. - Sorted by `name` alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through `GET /associations/search`, which breaks ties on `contactID`. - `includeManager` adds manager contacts to the list. - `associationContactIDs[]` limits the list to those contacts (associations, or managers with `includeManager`); the other filters, the `isActive` default included, still apply. ##### Related Endpoints - `GET /associations/search` - filtered search with computed insurance and tax columns - `GET /associations/{contactID}` - one association, with includes - `POST /associations` - create an association Parameters: - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 15, minimum 1): Items per page, from 1 (default 15). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name` and `code`. HTML-encoded before matching, so text holding `'`, `"`, `&`, `<` or `>` finds nothing. - `isActive` (query, string, default "1"): `1` (the default) returns active contacts, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. - `includeManager` (query, string): Also list manager contacts. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `associationContactIDs[]` (query, integer[]): Only these contacts. Send each ID as a separate `associationContactIDs[]=`. Responses: - `200`: A page of associations - `application/json`: `contact_list_item`[] Example: ```json [ { "contact": { "contactID": "2689", "contactTypeID": "5", "vendorTypeID": null, "code": "C-6af8dddb1def7", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "MA", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "165", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "discountPercent": "2.5000", "discountAmount": null, "discountAmountMin": "1.00", "discountAmountMax": "50.00", "discountGraceDays": "10", "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": "Rivera Holdings", "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "1", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "149", "dateTimeCreated": "2026-11-14 22:16:59", "dateTimeModified": "2026-11-14 22:16:59", "dateTimeDeactivated": null, "contactType": "Association" }, "token": "1794694619" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Association `POST /associations` Operation ID: `createAssociation` Creates a new association contact and returns the full association detail (same shape as `GET /associations/{contactID}`). ##### Use Cases - Onboard a new homeowner association (HOA) or condo association into the system - Create an association with initial contact info (emails, phones, addresses) in a single request - Set up an association with ACH payout details for dues collection ##### Business Rules - Requires `Update Association Details` permission. - `name` is the only required field. - Tax info fields (`taxPayerName`, `taxIdentifier`, `taxFormTypeID`) require the `ManageTaxInfo` permission. - ACH bank details (`routingNumber`, `accountNumber`) are stored encrypted; only the last 4 digits of the account number are returned. ##### Related Endpoints - `GET /associations/{contactID}` — retrieve a created association - `POST /associations/{contactID}` — update association fields after creation Request body, required: - `application/json`: object - `name` (string, required): Full display name of the association - `defaultBillChargeAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Default chart of accounts ID for bills charged to this association - `websiteUrl` (string | null, uri): Association website URL - `taxPayerName` (string | null): Name on 1099 tax documents (requires ManageTaxInfo permission) - `taxIdentifier` (string | null): SSN/EIN stored encrypted (requires ManageTaxInfo permission) - `taxFormTypeID` (string | integer | null, pattern `^-?[0-9]+$`): 1099 form type ID (requires ManageTaxInfo permission) - `payoutTypeID` (`payout_types_request`) - `achAccountTypeID` (one of several shapes) - One of: - Option 1: `bank_account_types_request` - Option 2: null - `achIsCorporateAccount` (string | integer, pattern `^-?[0-9]+$`): "1" if ACH account is corporate, "0" otherwise - `holdPayments` (string | integer, pattern `^-?[0-9]+$`): "1" to hold all payments to this association - `preventConsolidatedPayments` (string | integer, pattern `^-?[0-9]+$`): "1" to prevent consolidated payouts - `maxLineItemsOnPayment` (string | integer | null, pattern `^-?[0-9]+$`): Maximum number of line items allowed per payment run - `payeeName` (string | null): Override name for checks and ACH - `otherPayoutTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Alternative payout type reference - `code` (string | null): Optional short code or reference for the association - `discountPercent` (string | number | null, decimal): Discount percentage applied to bills from this association - `discountGraceDays` (string | integer | null, pattern `^-?[0-9]+$`): Grace days before discount expires - `routingNumber` (string | null): ACH routing number — stored encrypted, not returned in responses - `accountNumber` (string | null): ACH account number — stored encrypted, only last 4 digits returned - `emails` (object[]): Email records to attach to the association - `email` (string | null, email) - `phones` (object[]): Phone records to attach to the association - `phone` (string | null) - `phoneTypeID` (string | integer | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `addresses` (object[]): Address records to attach to the association - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `attachments` (integer[]): File IDs to attach to the association record Example: ```json { "name": "New Association" } ``` Responses: - `200`: Association successfully created — returns full association detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "2305", "contactTypeID": "5", "vendorTypeID": null, "code": null, "name": "New Association", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 19:26:47", "dateTimeModified": "2026-04-24 19:26:47", "dateTimeDeactivated": null, "contactType": "Association", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Search Associations `GET /associations/search` Operation ID: `searchAssociations` Returns a page of associations with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under `contact`. With `search`, each row also carries `search.rank`. ##### Use Cases - Find associations by name, code, email, phone or address (the row doesn't carry `code`: read it from `GET /associations/{contactID}`) - Sync associations changed since a point in time with `dateTimeModifiedMin` - Review tax-identifier data quality with `hasTaxIdentifier`, `isTaxIdentifierValid` and `hasDuplicateTaxIdentifier` ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every association. - `isActive` filters only when sent: without it the search returns active and inactive associations. - `search` is a substring match on `name`, `code`, `email`, `phone` and `address`; spaces in the text match any run of characters. Each row then carries a `search.rank`. - The page size defaults to 25, with no upper limit today; a `pageSize` of `0` or less is served at 15. - Sorted by `orderBy` (default `contact.name`), then by `contactID`. An `orderBy` column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in `contactID` order. - Boolean filters read `1`, `true` and `yes` as yes and `0`, `false` and `no` as no; any other value is ignored. - List filters take each value as a separate `name[]=`. ##### Related Endpoints - `GET /associations` - the plain list, with the full contact row - `GET /associations/{contactID}` - one association, with includes Parameters: - `page` (query, integer, default 1): Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit today. `0`, a negative value or a value that isn't a number is served at 15. - `search` (query, string): Substring match on `name`, `code`, `email`, `phone` and `address`. Spaces in the text match any run of characters. - `payoutTypeID` (query, `payout_types_request`): Only contacts paid this way. A value that isn't a number is ignored. - `holdPayments` (query, string): Only contacts whose payouts are on hold (`1`) or not (`0`). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isActive` (query, string): Only active (`1`) or inactive (`0`) contacts. Without it, both. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `hasTaxIdentifier` (query, string): Only contacts with (`1`) or without (`0`) a stored tax identifier. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isTaxIdentifierValid` (query, string): Only contacts whose stored tax identifier passed (`1`) or failed (`0`) validation; a contact with no identifier counts as `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `taxIdentifierTypeIDs[]` (query, `tax_identifier_types_request`[]): Only contacts whose stored tax identifier is of these types. Send each value as a separate `taxIdentifierTypeIDs[]=`. - `hasDuplicateTaxIdentifier` (query, string): Only contacts whose tax identifier another contact also stores (`1`), or that no other contact shares (`0`, including contacts with none). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `dateTimeModifiedMin` (query, string): Only contacts last modified on or after this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send `20240101` as `2024-01-01`. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only contacts last modified on or before this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound. - `propertyIDs[]` (query, integer[]): Only contacts linked as the association of at least one of these properties (`POST /properties/associations` (undocumented) links a contact of any type, though normally only associations are linked). Send each value as a separate `propertyIDs[]=`. - `orderBy` (query, string, default "contact.name"): Sort columns, comma-separated, each optionally followed by `|desc` (or `|asc`, the default): `contact.name|desc`. Default `contact.name`; `contactID` breaks ties. Sortable: `contact.contactID`, `contact.isActive`, `contact.contactTypeID`, `contact.vendorTypeID`, `contact.name`, `contact.email`, `contact.phone`, `contact.defaultBillChargeAccountID`, `contact.payeeName`, `contact.taxPayerName`, `contact.taxFormTypeID`, `contact.payoutTypeID`, `contact.achAccountNumberTruncated`, `contact.achAccountTypeID`, `contact.holdPayments`, `contact.liabilityInsuranceName`, `contact.workersCompInsurancePolicyNumber`, `contact.workersCompInsuranceExpiresDate`, `contact.discountPercent`, `contact.discountGraceDays`, `contact.isInsuranceRequiredForPayment`, `contact.isTaxIdentifierValid`, `contact.taxIdentifierTypeID`, `contact.taxIdentifierCountryID`, `contact.hasTaxIdentifier`, `contact.hasDuplicateTaxIdentifier`, `contact.propertyCount`, `contact.daysUntilInsuranceExpires`, `contact.daysUntilLiabilityInsuranceExpires`, `contact.daysUntilWorkersCompInsuranceExpires`, and `search.rank` when `search` is sent. Any other column is dropped without an error; with none left, rows come back in `contactID` order. A `-` prefix isn't read as descending: it makes the column unknown. Responses: - `200`: A page of matching associations - `application/json`: `contact_search_item`[] Example: ```json [ { "contact": { "contactID": "2767", "contactTypeID": "5", "vendorTypeID": null, "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "CA", "postalCode": "12345", "countryID": "US", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "payoutTypeID": "1", "achDetailsCiphertextID": "170", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "isBillingSalesTaxEnabled": "1", "daysUntilLiabilityInsuranceExpires": "1324", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "daysUntilWorkersCompInsuranceExpires": "1355", "insuranceExpiresDate": "2030-06-30", "daysUntilInsuranceExpires": "1324", "discountPercent": "2.5000", "discountGraceDays": "10", "isActive": "1", "invoiceAutofillTemplateID": "154", "dateTimeCreated": "2026-11-14 22:17:14", "dateTimeModified": "2026-11-14 22:17:14", "dateTimeDeactivated": null, "isInsuranceRequiredForPayment": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "identificationCountryID": "US", "hasTaxIdentifier": "1", "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null, "hasDuplicateTaxIdentifier": "0", "propertyCount": "1" }, "search": { "rank": "10" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Association `GET /associations/{contactID}` Operation ID: `getAssociation` Returns one association: the full contact row under `contact`, with the tax-identifier flags, and the related records the `includes` parameter names, each under its own key. ##### Use Cases - Show an association's full record - Load the association's emails, phones and addresses in the same request ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every association. - A well-formed ID with no contact, or the ID of a contact of another type, answers 400 `{"error": "Association {contactID} not found"}`. An ID that isn't a whole number of digits answers the stock 404. - The tax identifier itself is never returned: `contact.hasTaxIdentifier` says whether one is stored. - `includes` names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored. ##### Available Includes (6) - `emails` - the contact's email addresses, each under `email` - `phones` - the contact's phone numbers, each under `phone` - `addresses` - the contact's addresses, each under `address` - `properties` - the properties linked to the association, each as `propertyAssociation` and `property`. A user restricted to portfolio groups gets only the properties in those groups' portfolios - `contactPersons` - the people on file at the contact - `invoiceAutofillTemplate` - the invoice autofill template the contact uses, or null when it has none ##### Related Endpoints - `GET /associations` - list associations - `GET /associations/search` - search associations - `POST /associations/{contactID}` - update the association Parameters: - `contactID` (path, integer, required): The association's contact ID. A well-formed ID that isn't an association answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. - `includes` (query, string): Comma-separated related records to add: `emails`, `phones`, `addresses`, `properties`, `contactPersons`, `invoiceAutofillTemplate`. Responses: - `200`: The association, with the includes requested - `application/json`: object - `contact` (`contact_detail`, required) - `emails` (`contact_email_row`[]): The contact's email addresses, each under `email`. Requires the `emails` include. - `phones` (`contact_phone_row`[]): The contact's phone numbers, each under `phone`. Requires the `phones` include. - `addresses` (`contact_address_row`[]): The contact's addresses, each under `address`. Requires the `addresses` include. - `properties` (`association_property_row`[]): The properties linked to the association, each as `propertyAssociation` and `property`. A user restricted to portfolio groups gets only the properties in those groups' portfolios. Requires the `properties` include. - `contactPersons` (`contact_person`[]): The people on file at the contact. Requires the `contactPersons` include. - `invoiceAutofillTemplate` (one of several shapes): The invoice autofill template the contact uses, or null when it has none. Requires the `invoiceAutofillTemplate` include. - One of: - Option 1: `contact_invoice_autofill_template` - Option 2: null Example: ```json { "contact": { "contactID": "2962", "contactTypeID": "5", "vendorTypeID": null, "code": "C-6af8ddfe73400", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "SC", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": "1", "payeeName": "Jane Doe", "taxPayerName": "Jane Doe", "taxFormTypeID": "1", "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": "1", "achDetailsCiphertextID": "175", "achAccountNumberTruncated": "6789", "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "1", "liabilityInsuranceName": "Acme Insurance", "liabilityInsurancePolicyNumber": "L-1001", "liabilityInsuranceExpiresDate": "2030-06-30", "workersCompInsuranceName": "Acme Workers Comp", "workersCompInsurancePolicyNumber": "W-2002", "workersCompInsuranceExpiresDate": "2030-07-31", "discountPercent": "2.5000", "discountAmount": null, "discountAmountMin": "1.00", "discountAmountMax": "50.00", "discountGraceDays": "10", "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://example.com", "applicantID": null, "ownerPortalNameOverride": "Rivera Holdings", "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "1", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": "159", "dateTimeCreated": "2026-11-14 22:17:34", "dateTimeModified": "2026-11-14 22:17:34", "dateTimeDeactivated": null, "contactType": "Association", "hasTaxIdentifier": 1, "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null }, "emails": [ { "email": { "contactEmailID": "108", "contactID": "2962", "isPrimary": "1", "email": "jane.doe@example.com", "sendEmailNotifications": "1", "sendPaymentNotifications": "1", "sendWorkOrderNotifications": "1" } } ], "phones": [ { "phone": { "contactPhoneID": "108", "contactID": "2962", "isPrimary": "1", "phone": "555-0100", "phoneTypeID": "1", "description": "Office", "isActive": "1" } } ], "addresses": [ { "address": { "contactAddressID": "108", "contactID": "2962", "isPrimary": "1", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NC", "postalCode": "12345" } } ], "properties": [ { "propertyAssociation": { "propertyAssociationID": "65", "propertyID": "591", "associationContactID": "2962" }, "property": { "propertyID": "591", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "734", "managementFeeSettingID": "593", "name": "224 Shanahan Tunnel", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": null, "stateID": "MN", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": null, "legalDescription": null, "maintenanceLimitAmount": null, "yearBuilt": null, "dateInsuranceExpires": null, "dateWarrantyExpires": null, "maintenanceNotes": null, "applicationTemplateID": null, "reserveAmount": "0.00", "markupPercent": null, "markupAmount": null, "markupAmountMin": null, "markupAmountMax": null, "dateContractBegins": null, "dateContractEnds": null, "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": null, "insuranceAgent": null, "insurancePolicyNumber": null, "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": null, "leaseReturnChargeAmount": null, "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-14 22:17:34", "dateTimeModified": "2026-11-14 22:17:34", "dateTimeDeactivated": null, "deactivationReasonID": "99", "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } } ], "contactPersons": [ { "contactPersonID": "99", "contactID": "2962", "name": "Jane Doe", "title": "Office Manager", "email": "jane.doe@example.com", "phone": "555-0100" } ], "invoiceAutofillTemplate": { "invoiceAutofillTemplateID": "159", "name": "Contract Template 6af8ddfe71bb8", "isDefault": "1", "billDescription": "Repairs", "paymentMemo": "Invoice payment", "chargeDescription": "Repair charge" } } ``` - `400`: No association has this ID: no contact, or a contact of another type. - `application/json`: object - `error` (string, required): `Association {contactID} not found` Example: ```json { "error": "Association 999999999 not found" } ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Association `POST /associations/{contactID}` Operation ID: `updateAssociation` Updates editable fields on an existing association contact and returns the full association detail (same shape as `GET /associations/{contactID}`). ##### Use Cases - Update an association's display name, website, or discount settings - Toggle bill approval exemption or sales tax for an association - Update insurance information for payment eligibility ##### Business Rules - Requires `Update Association Details` permission. - Returns `400` if the contact is not found or is not an association. - `isBillApprovalExempt` requires the `Update Bill Approval Exemption` permission to take effect. - Only changed fields need to be included in the request body. - After update the endpoint forwards to the view action — pass `includes` query params to include related data in the response. ##### Related Endpoints - `GET /associations/{contactID}` — retrieve current association detail Parameters: - `contactID` (path, integer, required): The unique association contact ID - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `properties`, `contactPersons`, `invoiceAutofillTemplate` Request body, required: - `application/json`: object - `name` (string): Full display name of the association - `code` (string | null): Optional short code or reference - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Default chart of accounts ID for bills - `websiteUrl` (string | null, uri): Association website URL - `ownerPortalNameOverride` (string | null): Override display name shown in the owner portal - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | number | null, decimal): Discount percentage applied to bills - `discountGraceDays` (string | integer | null, pattern `^-?[0-9]+$`): Grace days before discount expires - `isBillingSalesTaxEnabled` (string | integer, one of "0", "1", 0, 1): "1" to enable sales tax on invoices billed from this association - `invoiceAutofillTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the invoice autofill template to link - `isBillApprovalExempt` (string | integer, one of "0", "1", 0, 1): "1" to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) Example: ```json { "name": "Sunset Heights HOA Updated", "code": null, "websiteUrl": "https://sunsetheightshoa.com", "defaultBillChargeAccountID": null, "discountPercent": null, "discountGraceDays": null, "isBillingSalesTaxEnabled": "0", "invoiceAutofillTemplateID": null } ``` Responses: - `200`: Association successfully updated — returns full association detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "2305", "contactTypeID": "5", "vendorTypeID": null, "code": null, "name": "Sunset Heights HOA Updated", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": "https://sunsetheightshoa.com", "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-01-04 15:45:47", "dateTimeModified": "2026-04-24 19:28:00", "dateTimeDeactivated": null, "contactType": "Association", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Delete Association `DELETE /associations/{contactID}` Operation ID: `deleteAssociation` Permanently deletes an association contact. Returns the deleted contact as a flat object. ##### Use Cases - Remove an association that was created in error - Clean up test or duplicate association records ##### Business Rules - Requires `Update Association Details` permission. - Returns `400` if the contact is not found or is not an association. - Returns `400` if `contactID` is not provided in the path. - Deletion may fail if the association has associated financial records. ##### Related Endpoints - `POST /associations/{contactID}/deactivate` — soft-deactivate instead of permanently deleting - `GET /associations/{contactID}` — verify association state before deletion Parameters: - `contactID` (path, integer, required): The unique association contact ID to delete Responses: - `200`: Association successfully deleted — returns the deleted contact record (flat) - `application/json`: `contact` Example: ```json { "contactID": "2305", "contactTypeID": "5", "vendorTypeID": null, "code": null, "name": "New Association", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-01-04 15:45:47", "dateTimeModified": "2024-01-04 15:45:47", "dateTimeDeactivated": null, "contactType": "Association" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Association 2305 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Activate Association `POST /associations/{contactID}/activate` Operation ID: `activateAssociation` Sets an association's `isActive` flag to `1`, re-activating it after a previous deactivation. Returns the updated association detail (same shape as `GET /associations/{contactID}`). ##### Use Cases - Re-activate an association that was previously deactivated but is now active again - Restore an association to eligibility for bill payments and property linkage ##### Business Rules - Requires `Update Association Details` permission. - Returns `400` if the contact is not found or is not an association. - Sets `isActive = 1` - The response is the full association detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /associations/{contactID}` — retrieve association details - `POST /associations/{contactID}/deactivate` — deactivate an active association - `POST /associations/{contactID}` — update association fields Parameters: - `contactID` (path, integer, required): The unique association contact ID to activate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `properties`, `contactPersons`, `invoiceAutofillTemplate` Responses: - `200`: Association successfully activated — returns updated association detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"1"` after activation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Cleared to null after re-activation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2305", "contactTypeID": "5", "vendorTypeID": null, "code": null, "name": "Sunset Heights HOA", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-01-04 15:45:47", "dateTimeModified": "2026-04-24 19:25:39", "dateTimeDeactivated": null, "contactType": "Association", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Association 2305 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` #### Deactivate Association `POST /associations/{contactID}/deactivate` Operation ID: `deactivateAssociation` Sets an association's `isActive` flag to `0`, soft-deactivating it. Returns the updated association detail (same shape as `GET /associations/{contactID}`). ##### Use Cases - Deactivate an association that is no longer active to prevent new bill assignments - Soft-delete an association while preserving historical financial records ##### Business Rules - Requires `Update Association Details` permission. - Returns `400` if the contact is not found or is not an association. - Historical records (bills, invoices, payments) are preserved after deactivation. - The response is the full association detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /associations/{contactID}` — retrieve association details - `POST /associations/{contactID}/activate` — re-activate a deactivated association - `DELETE /associations/{contactID}` — permanently delete an association Parameters: - `contactID` (path, integer, required): The unique association contact ID to deactivate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `properties`, `contactPersons`, `invoiceAutofillTemplate` Responses: - `200`: Association successfully deactivated — returns updated association detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"0"` after deactivation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Set to the deactivation timestamp. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "2305", "contactTypeID": "5", "vendorTypeID": null, "code": null, "name": "Sunset Heights HOA", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "0", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2024-01-04 15:45:47", "dateTimeModified": "2026-04-24 19:25:39", "dateTimeDeactivated": "2026-04-24 19:25:39", "contactType": "Association", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Association 2305 not found" } ``` - `401`: Unauthorized — missing or invalid credentials - `application/json`: object - `error` (string) Example: ```json { "error": "Unauthorized" } ``` - `403`: Forbidden — insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Forbidden" } ``` - `429`: see shared response `error_429` ### Maintenance Technicians #### List Maintenance Technicians `GET /maintenance-technicians` Operation ID: `listMaintenanceTechnicians` Returns a page of maintenance technicians, sorted by name. Each item holds the full contact row under `contact`, and a `token`. Use `GET /maintenance-technicians/search` for more filters and computed columns. ##### Use Cases - Page through every active (or inactive) maintenance technician on the account - Look up maintenance technicians by name or code - Load a known set of contacts by ID with `contactIDs[]` ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every maintenance technician. - `isActive` defaults to `1`: only active maintenance technicians. `0` returns only inactive ones; any value other than `1`, `true`, `yes`, `0`, `false` or `no` (such as `all`) returns both. - `search` is a substring match on `name` and `code`. The text is HTML-encoded before it is matched, so text holding `'`, `"`, `&`, `<` or `>` (`O'Brien`, `Smith & Sons`) finds nothing here; `GET /maintenance-technicians/search` matches it as typed. - The page size defaults to 250 and is capped at 5000. - Sorted by `name` alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through `GET /maintenance-technicians/search`, which breaks ties on `contactID`. - `includeManager` adds manager contacts to the list. `includeMaintenanceTechnician` changes nothing here: the list already holds maintenance technicians. - `contactIDs[]` (or `vendorContactIDs[]`) returns those contacts when they are maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply. ##### Related Endpoints - `GET /maintenance-technicians/search` - filtered search with computed insurance and tax columns - `GET /maintenance-technicians/{contactID}` - one maintenance technician, with includes - `POST /maintenance-technicians` - create a maintenance technician Parameters: - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 250, minimum 1): Items per page, from 1 (default 250). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name` and `code`. HTML-encoded before matching, so text holding `'`, `"`, `&`, `<` or `>` finds nothing. - `isActive` (query, string, default "1"): `1` (the default) returns active contacts, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. - `includeManager` (query, string): Also list manager contacts. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `includeMaintenanceTechnician` (query, string): Changes nothing here: the list already holds maintenance technicians. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTypeID` (query, integer): Only contacts of this vendor type, from `GET /contacts/vendor-types` (undocumented). A value that isn't a number is ignored. - `contactIDs[]` (query, integer[]): Only these contacts. Send each ID as a separate `contactIDs[]=`; a single `contactIDs=` value holding an ID is read as a list of one. Widens the types listed to maintenance technicians and managers. `vendorContactIDs[]` is read when `contactIDs[]` isn't sent. - `vendorContactIDs[]` (query, integer[]): The older name of `contactIDs[]`, read only when `contactIDs[]` isn't sent. Responses: - `200`: A page of maintenance technicians - `application/json`: `contact_list_item`[] Example: ```json [ { "contact": { "contactID": "2690", "contactTypeID": "8", "vendorTypeID": "404", "code": "C-6af8dddba2c6a", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "IL", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-11-14 22:16:59", "dateTimeModified": "2026-11-14 22:16:59", "dateTimeDeactivated": null, "contactType": "Internal Technician" }, "token": "1794694619" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Maintenance Technician `POST /maintenance-technicians` Operation ID: `createMaintenanceTechnician` Creates a new maintenance technician contact and returns the full technician detail (same shape as `GET /maintenance-technicians/{contactID}`). ##### Use Cases - Onboard a new in-house technician with a name and optional contact details - Create a technician with initial emails, phones, and addresses in a single request ##### Business Rules - Requires `Update Internal Technician Details` permission. - `name` is the only required field. - `taxPayerName`, `taxFormTypeID`, and `taxIdentifier` are only applied when the caller has the `ManageTaxInfo` permission. - After creation the endpoint forwards to the view action — the response is the full technician detail. ##### Related Endpoints - `GET /maintenance-technicians/{contactID}` — retrieve the created technician - `POST /maintenance-technicians/{contactID}` — update technician fields after creation Request body, required: - `application/json`: object - `name` (string, required): Full display name of the technician - `code` (string | null): Optional short code or reference - `birthDate` (string | null, date): Date of birth - `maxLineItemsOnPayment` (string | integer | null, pattern `^-?[0-9]+$`): Maximum number of bill line items allowed per payment run - `taxPayerName` (string | null): Name on 1099 tax documents (requires ManageTaxInfo permission) - `taxIdentifier` (string | null): SSN/EIN stored encrypted (requires ManageTaxInfo permission) - `taxFormTypeID` (string | integer | null, pattern `^-?[0-9]+$`): 1099 form type ID (requires ManageTaxInfo permission) - `emails` (object[]): Email records to attach to the technician - `email` (string | null, email) - `phones` (object[]): Phone records to attach to the technician - `phone` (string | null) - `phoneTypeID` (string | integer | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `addresses` (object[]): Address records to attach to the technician - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `attachments` (integer[]): File IDs to attach to the technician record Example: ```json { "name": "New Tech Name" } ``` Responses: - `200`: Maintenance technician successfully created — returns full technician detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5267", "contactTypeID": "8", "vendorTypeID": null, "code": null, "name": "new tech name", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "new tech name", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 22:15:55", "dateTimeModified": "2026-04-24 22:15:55", "dateTimeDeactivated": null, "contactType": "Internal Technician", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Maintenance Technicians `GET /maintenance-technicians/search` Operation ID: `searchMaintenanceTechnicians` Returns a page of maintenance technicians with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under `contact`. With `search`, each row also carries `search.rank`. ##### Use Cases - Find maintenance technicians by name, code, email, phone or address (the row doesn't carry `code`: read it from `GET /maintenance-technicians/{contactID}`) - Sync maintenance technicians changed since a point in time with `dateTimeModifiedMin` - Review tax-identifier data quality with `hasTaxIdentifier`, `isTaxIdentifierValid` and `hasDuplicateTaxIdentifier` ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every maintenance technician. - `isActive` filters only when sent: without it the search returns active and inactive maintenance technicians. - `search` is a substring match on `name`, `code`, `email`, `phone` and `address`; spaces in the text match any run of characters. Each row then carries a `search.rank`. - The page size defaults to 25, with no upper limit today; a `pageSize` of `0` or less is served at 15. - Sorted by `orderBy` (default `contact.name`), then by `contactID`. An `orderBy` column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in `contactID` order. - Boolean filters read `1`, `true` and `yes` as yes and `0`, `false` and `no` as no; any other value is ignored. - List filters take each value as a separate `name[]=`. - `includeManager=1` adds manager contacts. Only `1`, `true` or `yes` turns it on. - `isLiabilityInsuranceExpired`, `isWorkersCompInsuranceExpired` and `isInsuranceExpired` take only a yes value; `0`, `false` and `no` aren't supported. Maintenance technicians store no insurance dates, so the other insurance filters return none. ##### Related Endpoints - `GET /maintenance-technicians` - the plain list, with the full contact row - `GET /maintenance-technicians/{contactID}` - one maintenance technician, with includes Parameters: - `page` (query, integer, default 1): Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25). There is no upper limit today. `0`, a negative value or a value that isn't a number is served at 15. - `search` (query, string): Substring match on `name`, `code`, `email`, `phone` and `address`. Spaces in the text match any run of characters. - `includeManager` (query, string): Also return manager contacts. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `includeMaintenanceTechnician` (query, string): Changes nothing here: the search already returns maintenance technicians. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTypeIDs[]` (query, integer[]): Only contacts of these vendor types, from `GET /contacts/vendor-types` (undocumented). Send each value as a separate `vendorTypeIDs[]=`. - `payoutTypeID` (query, `payout_types_request`): Only contacts paid this way. A value that isn't a number is ignored. - `holdPayments` (query, string): Only contacts whose payouts are on hold (`1`) or not (`0`). Every maintenance technician stores `0`, so `1` returns none. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isActive` (query, string): Only active (`1`) or inactive (`0`) contacts. Without it, both. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `hasTaxIdentifier` (query, string): Only contacts with (`1`) or without (`0`) a stored tax identifier. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `isTaxIdentifierValid` (query, string): Only contacts whose stored tax identifier passed (`1`) or failed (`0`) validation; a contact with no identifier counts as `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `taxIdentifierTypeIDs[]` (query, `tax_identifier_types_request`[]): Only contacts whose stored tax identifier is of these types. Send each value as a separate `taxIdentifierTypeIDs[]=`. - `hasDuplicateTaxIdentifier` (query, string): Only contacts whose tax identifier another contact also stores (`1`), or that no other contact shares (`0`, including contacts with none). `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `dateTimeModifiedMin` (query, string): Only contacts last modified on or after this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send `20240101` as `2024-01-01`. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync. - `dateTimeModifiedMax` (query, string): Only contacts last modified on or before this date and time, in UTC. Send it as `2024-01-01T10:00:00Z` or `2024-01-01 10:00:00`, with no offset other than `Z`. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound. - `isInsuranceRequiredForPayment` (query, string): Only contacts that must (`1`) or needn't (`0`) have current insurance to be paid. The API stores null here for maintenance technicians, so `1` returns none and `0` only a few older rows that store `0`. `1`, `true` and `yes` mean yes; `0`, `false` and `no` mean no; any other value is ignored. - `vendorTradeIDs[]` (query, integer[]): Only contacts assigned to at least one of these trades, from `GET /maintenance/vendor-trades`. Send each value as a separate `vendorTradeIDs[]=`. - `propertyIDs[]` (query, integer[]): Only contacts linked as the association of at least one of these properties (`POST /properties/associations` (undocumented) links a contact of any type, though normally only associations are linked, so this usually returns no maintenance technicians). Send each value as a separate `propertyIDs[]=`. - `isLiabilityInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose liability insurance has expired. Maintenance technicians store no insurance dates, so this returns none. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilLiabilityInsuranceExpiresMin` (query, integer): Only contacts whose liability insurance expires at least this many days from today. `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `daysUntilLiabilityInsuranceExpiresMax` (query, integer): Only contacts whose liability insurance expires at most this many days from today (negative for already expired). `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `isWorkersCompInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose workers' comp insurance has expired. Maintenance technicians store no insurance dates, so this returns none. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilWorkersCompInsuranceExpiresMin` (query, integer): Only contacts whose workers' comp insurance expires at least this many days from today. `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `daysUntilWorkersCompInsuranceExpiresMax` (query, integer): Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `isInsuranceExpired` (query, string): `1` (or `true`, `yes`) returns only contacts whose insurance (the earlier of the two dates) has expired. Maintenance technicians store no insurance dates, so this returns none. `0`, `false` and `no` aren't supported. Any other value is ignored. - `daysUntilInsuranceExpiresMin` (query, integer): Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `daysUntilInsuranceExpiresMax` (query, integer): Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). `0` is ignored. Maintenance technicians store no insurance dates, so this returns none. - `tagIDs[]` (query, integer[]): Only contacts with at least one of these tags, from `GET /tags` (undocumented), attached to the contact as a vendor tag. Send each value as a separate `tagIDs[]=`. - `orderBy` (query, string, default "contact.name"): Sort columns, comma-separated, each optionally followed by `|desc` (or `|asc`, the default): `contact.name|desc`. Default `contact.name`; `contactID` breaks ties. Sortable: `contact.contactID`, `contact.isActive`, `contact.contactTypeID`, `contact.vendorTypeID`, `contact.name`, `contact.email`, `contact.phone`, `contact.defaultBillChargeAccountID`, `contact.payeeName`, `contact.taxPayerName`, `contact.taxFormTypeID`, `contact.payoutTypeID`, `contact.achAccountNumberTruncated`, `contact.achAccountTypeID`, `contact.holdPayments`, `contact.liabilityInsuranceName`, `contact.workersCompInsurancePolicyNumber`, `contact.workersCompInsuranceExpiresDate`, `contact.discountPercent`, `contact.discountGraceDays`, `contact.isInsuranceRequiredForPayment`, `contact.isTaxIdentifierValid`, `contact.taxIdentifierTypeID`, `contact.taxIdentifierCountryID`, `contact.hasTaxIdentifier`, `contact.hasDuplicateTaxIdentifier`, `contact.propertyCount`, `contact.daysUntilInsuranceExpires`, `contact.daysUntilLiabilityInsuranceExpires`, `contact.daysUntilWorkersCompInsuranceExpires`, and `search.rank` when `search` is sent. Any other column is dropped without an error; with none left, rows come back in `contactID` order. A `-` prefix isn't read as descending: it makes the column unknown. Responses: - `200`: A page of matching maintenance technicians - `application/json`: `contact_search_item`[] Example: ```json [ { "contact": { "contactID": "2768", "contactTypeID": "8", "vendorTypeID": "412", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "555-0100", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "OR", "postalCode": "12345", "countryID": "US", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "payoutTypeID": "1", "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "isBillingSalesTaxEnabled": "0", "daysUntilLiabilityInsuranceExpires": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "daysUntilWorkersCompInsuranceExpires": null, "insuranceExpiresDate": null, "daysUntilInsuranceExpires": null, "discountPercent": null, "discountGraceDays": null, "isActive": "1", "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-11-14 22:17:14", "dateTimeModified": "2026-11-14 22:17:14", "dateTimeDeactivated": null, "isInsuranceRequiredForPayment": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "identificationCountryID": "US", "hasTaxIdentifier": "1", "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null, "hasDuplicateTaxIdentifier": "0", "propertyCount": "0" }, "search": { "rank": "10" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Maintenance Technician `GET /maintenance-technicians/{contactID}` Operation ID: `getMaintenanceTechnician` Returns one maintenance technician: the full contact row under `contact`, with the tax-identifier flags, and the related records the `includes` parameter names, each under its own key. ##### Use Cases - Show a maintenance technician's full record - Load the maintenance technician's emails, phones and addresses in the same request ##### Business Rules - Requires only authentication; no permission is checked. - Portfolio restrictions don't apply: a restricted user gets every maintenance technician. - A well-formed ID with no contact, or the ID of a contact of another type, answers 400 `{"error": "Internal Technician {contactID} not found"}`. An ID that isn't a whole number of digits answers the stock 404. - The tax identifier itself is never returned: `contact.hasTaxIdentifier` says whether one is stored. - `includes` names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored. ##### Available Includes (10) - `emails` - the contact's email addresses, each under `email` - `phones` - the contact's phone numbers, each under `phone` - `addresses` - the contact's addresses, each under `address` - `portalAccounts` - the maintenance portal accounts linked to the contact - `portalInvitations` - the pending, unexpired invitations to the maintenance portal, newest first - `vendorTrades` - the trades assigned to the contact, each as `contactVendorTrade` and `vendorTrade` - `taxAdjustments` - the contact's 1099 tax adjustments - `contactPersons` - the people on file at the contact - `reviewStats` - one row counting the contact's completed maintenance reviews by rating - `invoiceAutofillTemplate` - the invoice autofill template the contact uses, or null when it has none ##### Related Endpoints - `GET /maintenance-technicians` - list maintenance technicians - `GET /maintenance-technicians/search` - search maintenance technicians - `POST /maintenance-technicians/{contactID}` - update the maintenance technician Parameters: - `contactID` (path, integer, required): The maintenance technician's contact ID. A well-formed ID that isn't a maintenance technician answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. - `includes` (query, string): Comma-separated related records to add: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate`. Responses: - `200`: The maintenance technician, with the includes requested - `application/json`: object - `contact` (`contact_detail`, required) - `emails` (`contact_email_row`[]): The contact's email addresses, each under `email`. Requires the `emails` include. - `phones` (`contact_phone_row`[]): The contact's phone numbers, each under `phone`. Requires the `phones` include. - `addresses` (`contact_address_row`[]): The contact's addresses, each under `address`. Requires the `addresses` include. - `portalAccounts` (`contact_portal_account`[]): The maintenance portal accounts linked to the contact. Requires the `portalAccounts` include. - `portalInvitations` (`contact_portal_invitation`[]): The pending, unexpired invitations to the maintenance portal, newest first. Requires the `portalInvitations` include. - `vendorTrades` (`vendor_trade_row`[]): The trades assigned to the contact, each as `contactVendorTrade` and `vendorTrade`. Requires the `vendorTrades` include. - `taxAdjustments` (`contact_tax_adjustment`[]): The contact's 1099 tax adjustments. Requires the `taxAdjustments` include. - `contactPersons` (`contact_person`[]): The people on file at the contact. Requires the `contactPersons` include. - `reviewStats` (`vendor_review_stats`[]): One row counting the contact's completed maintenance reviews by rating. Requires the `reviewStats` include. - `invoiceAutofillTemplate` (one of several shapes): The invoice autofill template the contact uses, or null when it has none. Requires the `invoiceAutofillTemplate` include. - One of: - Option 1: `contact_invoice_autofill_template` - Option 2: null Example: ```json { "contact": { "contactID": "2963", "contactTypeID": "8", "vendorTypeID": "449", "code": "C-6af8ddff177f4", "name": "Jane Doe", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": "jane.doe@example.com", "phone": "555-0100", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "birthDate": "1990-01-01", "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": null, "taxFormTypeID": null, "identificationTypeID": "1", "identificationNumber": "X0000000", "identificationCountryID": "US", "identificationIssuingLocation": "NC", "identificationExpirationDate": "2030-01-31", "payoutTypeID": "1", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": "12", "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-11-14 22:17:35", "dateTimeModified": "2026-11-14 22:17:35", "dateTimeDeactivated": null, "contactType": "Internal Technician", "hasTaxIdentifier": 1, "isTaxIdentifierValid": "1", "taxIdentifierTypeID": "99", "taxIdentifierCountryID": null }, "emails": [ { "email": { "contactEmailID": "109", "contactID": "2963", "isPrimary": "1", "email": "jane.doe@example.com", "sendEmailNotifications": "1", "sendPaymentNotifications": "1", "sendWorkOrderNotifications": "1" } } ], "phones": [ { "phone": { "contactPhoneID": "109", "contactID": "2963", "isPrimary": "1", "phone": "555-0100", "phoneTypeID": "1", "description": "Office", "isActive": "1" } } ], "addresses": [ { "address": { "contactAddressID": "109", "contactID": "2963", "isPrimary": "1", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "NC", "postalCode": "12345" } } ], "portalAccounts": [ { "userPortalAccountID": "110", "userID": "1931", "accountID": "1", "portalTypeID": "9", "portalID": "2963", "email": "jane.doe@example.com", "isActive": "1", "firstName": "Jane", "lastName": "Doe", "phone": "555-0100", "timeZone": "UTC" } ], "portalInvitations": [ { "userPortalInvitationID": "108", "accountID": "1", "portalInvitationStatusID": "1", "portalTypeID": "9", "portalID": "2963", "email": "jane.doe@example.com", "roleID": "1", "portfolioGroupIDs": "[1, 2]", "dateTimeCreated": "2026-11-14 22:17:35", "dateTimeExpires": "2026-12-14 22:17:35", "nextReminderDateTime": "2026-11-16 22:17:35" } ], "vendorTrades": [ { "contactVendorTrade": { "contactVendorTradeID": "148", "vendorTradeID": "180", "contactID": "2963" }, "vendorTrade": { "vendorTradeID": "180", "name": "maxime dolorum ea", "isVisibleTenantPortal": "1" } } ], "taxAdjustments": [ { "taxAdjustmentID": "108", "contactID": "2963", "amount": "125.50", "description": "Prior-year adjustment", "datePosted": "2025-12-31" } ], "contactPersons": [ { "contactPersonID": "100", "contactID": "2963", "name": "Jane Doe", "title": "Office Manager", "email": "jane.doe@example.com", "phone": "555-0100" } ], "reviewStats": [ { "totalRatingCount": "0", "averageRating": "0.0000", "oneStarRatingCount": "0", "oneStarRatingPercent": "0.0000", "twoStarRatingCount": "0", "twoStarRatingPercent": "0.0000", "threeStarRatingCount": "0", "threeStarRatingPercent": "0.0000", "fourStarRatingCount": "0", "fourStarRatingPercent": "0.0000", "fiveStarRatingCount": "0", "fiveStarRatingPercent": "0.0000" } ], "invoiceAutofillTemplate": null } ``` - `400`: No maintenance technician has this ID: no contact, or a contact of another type. - `application/json`: object - `error` (string, required): `Internal Technician {contactID} not found` Example: ```json { "error": "Internal Technician 999999999 not found" } ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Maintenance Technician `POST /maintenance-technicians/{contactID}` Operation ID: `updateMaintenanceTechnician` Updates editable fields on an existing maintenance technician contact and returns the full technician detail (same shape as `GET /maintenance-technicians/{contactID}`). ##### Use Cases - Update a technician's display name, code, birth date ##### Business Rules - Requires `Update Internal Technician Details` permission. - Returns `400` if the contact is not found or is not a maintenance technician. - Only the fields `name`, `code`, and `birthDate` are writable via this endpoint. All other fields in the request body are silently ignored. - After update the endpoint forwards to the view action — pass `includes` query params to include related data in the response. ##### Related Endpoints - `GET /maintenance-technicians/{contactID}` — retrieve current technician detail Parameters: - `contactID` (path, integer, required): The unique maintenance technician contact ID - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Request body, required: - `application/json`: object - `name` (string): Full display name of the technician - `code` (string | null): Optional short code or reference - `birthDate` (string | null, date): Date of birth Example: ```json { "name": "new tech names", "code": null, "birthDate": null } ``` Responses: - `200`: Maintenance technician successfully updated — returns full technician detail - `application/json`: object - `contact` (`contact`, required) Example: ```json { "contact": { "contactID": "5267", "contactTypeID": "8", "vendorTypeID": null, "code": null, "name": "new tech names", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "new tech name", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 22:15:55", "dateTimeModified": "2026-04-24 22:20:10", "dateTimeDeactivated": null, "contactType": "Internal Technician", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Maintenance Technician `DELETE /maintenance-technicians/{contactID}` Operation ID: `deleteMaintenanceTechnician` Permanently deletes a maintenance technician contact. Returns the deleted contact as a flat object. ##### Use Cases - Remove a technician who was created in error - Clean up test or duplicate technician records ##### Business Rules - Requires `Update Maintenance Technician` permission. - Returns `400` if the contact is not found or is not a maintenance technician. - Deletion may fail if the technician has associated financial records — the service layer returns errors in that case. ##### Related Endpoints - `POST /maintenance-technicians/{contactID}/deactivate` — soft-deactivate instead of permanently deleting - `GET /maintenance-technicians/{contactID}` — verify technician state before deletion Parameters: - `contactID` (path, integer, required): The unique maintenance technician contact ID to delete Responses: - `200`: Maintenance technician successfully deleted — returns the deleted contact record (flat) - `application/json`: `contact` Example: ```json { "contactID": "5267", "contactTypeID": "8", "vendorTypeID": null, "code": null, "name": "new tech names", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "new tech name", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 22:15:55", "dateTimeModified": "2026-04-24 22:20:10", "dateTimeDeactivated": null, "contactType": "Internal Technician" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Internal Technician 5267 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Activate Maintenance Technician `POST /maintenance-technicians/{contactID}/activate` Operation ID: `activateMaintenanceTechnician` Sets a maintenance technician's `isActive` flag to `1`, re-activating them after a previous deactivation. Returns the updated technician detail (same shape as `GET /maintenance-technicians/{contactID}`). ##### Use Cases - Re-activate a technician who was previously deactivated but is returning to service - Restore a technician to eligibility for work order assignments ##### Business Rules - Requires `Update Internal Technician Details` permission. - Returns `400` if the contact is not found or is not a maintenance technician. - Sets `isActive = 1` - The response is the full technician detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /maintenance-technicians/{contactID}` — retrieve technician details - `POST /maintenance-technicians/{contactID}/deactivate` — deactivate an active technician - `POST /maintenance-technicians/{contactID}` — update technician fields Parameters: - `contactID` (path, integer, required): The unique maintenance technician contact ID to activate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Responses: - `200`: Maintenance technician successfully activated — returns updated technician detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`): Contact type (8 = Internal Technician) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"1"` after activation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Cleared to null after re-activation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "5267", "contactTypeID": "8", "vendorTypeID": null, "code": null, "name": "new tech names", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "new tech name", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "1", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 22:15:55", "dateTimeModified": "2026-04-24 22:25:00", "dateTimeDeactivated": null, "contactType": "Internal Technician", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Internal Technician 5267 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Deactivate Maintenance Technician `POST /maintenance-technicians/{contactID}/deactivate` Operation ID: `deactivateMaintenanceTechnician` Sets a maintenance technician's `isActive` flag to `0`, soft-deactivating them. Returns the updated technician detail (same shape as `GET /maintenance-technicians/{contactID}`). ##### Use Cases - Deactivate a technician who is no longer available to prevent new work order assignments - Soft-delete a technician while preserving historical records ##### Business Rules - Requires `Update Internal Technician Details` permission. - Returns `400` if the contact is not found or is not a maintenance technician. - Historical records (work orders, bills) are preserved after deactivation. - The response is the full technician detail (forwarded to the view action). Pass `includes` query params to include related data. ##### Related Endpoints - `GET /maintenance-technicians/{contactID}` — retrieve technician details - `POST /maintenance-technicians/{contactID}/activate` — re-activate a deactivated technician - `DELETE /maintenance-technicians/{contactID}` — permanently delete a technician Parameters: - `contactID` (path, integer, required): The unique maintenance technician contact ID to deactivate - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `emails`, `phones`, `addresses`, `portalAccounts`, `portalInvitations`, `vendorTrades`, `taxAdjustments`, `contactPersons`, `reviewStats`, `invoiceAutofillTemplate` Responses: - `200`: Maintenance technician successfully deactivated — returns updated technician detail - `application/json`: object - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, required, pattern `^-?[0-9]+$`): Contact type (8 = Internal Technician) - `name` (string, required) - `isActive` (string, required, one of "0", "1"): Will be `"0"` after deactivation - `payoutTypeID` (string, pattern `^-?[0-9]+$`) - `achIsCorporateAccount` (string, pattern `^-?[0-9]+$`) - `holdPayments` (string, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, pattern `^-?[0-9]+$`) - `isFromImport` (string, read-only, one of "0", "1") - `isBillApprovalExempt` (string, one of "0", "1") - `isBillingSalesTaxEnabled` (string, one of "0", "1") - `isQuickbooksExportEnabled` (string, one of "0", "1") - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Set to the deactivation timestamp. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, read-only) - `hasTaxIdentifier` (integer, required, read-only, one of 0, 1) Example: ```json { "contact": { "contactID": "5267", "contactTypeID": "8", "vendorTypeID": null, "code": null, "name": "new tech names", "firstName": null, "middleName": null, "lastName": null, "suffix": null, "email": null, "phone": null, "countryID": null, "address": null, "address2": null, "city": null, "stateID": null, "postalCode": null, "birthDate": null, "defaultBillChargeAccountID": null, "payeeName": null, "taxPayerName": "new tech name", "taxFormTypeID": "1", "identificationTypeID": null, "identificationNumber": null, "identificationCountryID": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "payoutTypeID": "2", "otherPayoutTypeID": null, "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": "2", "achIsCorporateAccount": "0", "holdPayments": "0", "liabilityInsuranceName": null, "liabilityInsurancePolicyNumber": null, "liabilityInsuranceExpiresDate": null, "workersCompInsuranceName": null, "workersCompInsurancePolicyNumber": null, "workersCompInsuranceExpiresDate": null, "discountPercent": null, "discountAmount": null, "discountAmountMin": null, "discountAmountMax": null, "discountGraceDays": null, "isActive": "0", "isInsuranceRequiredForPayment": null, "maxLineItemsOnPayment": null, "preventConsolidatedPayments": "0", "isFromImport": "0", "importSourceKey": null, "websiteUrl": null, "applicantID": null, "ownerPortalNameOverride": null, "isBillApprovalExempt": "0", "isBillingSalesTaxEnabled": "0", "isQuickbooksExportEnabled": "0", "quickbooksCustomerName": null, "invoiceAutofillTemplateID": null, "dateTimeCreated": "2026-04-24 22:15:55", "dateTimeModified": "2026-04-24 22:30:00", "dateTimeDeactivated": "2026-04-24 22:30:00", "contactType": "Internal Technician", "hasTaxIdentifier": 0 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Internal Technician 5267 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ## Files ### Files #### List Files `GET /files` Operation ID: `listFiles` Lists the account's attachable files, newest first, one page at a time. Each item wraps the file under `file`, beside a `token` the list adds. ##### Use Cases - Pick an existing file to attach to a record, instead of uploading it again - Find a file by part of its title ##### Business Rules - Requires only authentication; no permission is checked. - Use a key with no portfolio-group limit. - Lists only files with `isAttachable` `1`; to include the others, use `GET /files/search`. - `search` matches any part of the title, in any case. Its `&`, `<`, `>`, `'` and `"` are HTML-escaped first, so a search holding one of them matches no title that has it. Without `search`, the list isn't filtered by title. - Sorted by `dateTimeCreated`, newest first, with no tie-breaker: files created in the same second can repeat or be skipped across pages. ##### Related Endpoints - `GET /files/search` - search the account's files, with filters - `GET /files/{fileID}` - one file, with its attachments - `POST /files` - upload a file Parameters: - `search` (query, string): Part of the file's title, matched anywhere in it and in any case. - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 50, minimum 1): Items per page, from 1 (default 50). Values above 5000 are served at 5000. Responses: - `200`: One page of attachable files - `application/json`: object[] - Each item: - `file` (`file`, required) - `token` (string, required, pattern `^[0-9]+$`): The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the file. Example: ```json [ { "file": { "fileID": "39", "fileSourceID": "1", "isAttachable": "1", "title": "Front door photo", "fileName": "4765caf4-541f-39a5-a3a8-dccdb4c6bba0.jpg", "fileType": "jpg", "fileSize": "286", "userID": "2", "isImage": "1", "isPublic": "0", "previewFileName": "preview-6af7cb0a183c5.jpg", "dateTimeCreated": "2026-11-14 02:44:26" }, "token": "1794624266" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Upload `POST /files` Operation ID: `uploadFile` Uploading a file in Rentvine is generally a 2-step process. 1. Upload the file to store within Rentvine 2. Attach the file to an object, e.g. Unit, Lease, etc. To upload the file and attach it to an object in one step, provide the `objectID` and `objectTypeID` as query parameters. E.g. if you uploaded the file using the path `/files?objectTypeID=7&objectID=123`, the file would be uploaded and attached to the Unit ([object type id](https://docs.rentvine.com/#tag/Object-Types) for Unit is 7) with `unitID` of 123. Parameters: - `objectID` (query, integer): The primary key of the object - `objectTypeID` (query, integer): The id of the [Object Type](https://docs.rentvine.com/#tag/Object-Types) - `includes` (query, string, one of "attachment"): * `attachment` - Includes the attachment object in the response Request body: - `multipart/form-data`: object - `file` (string, binary) Responses: - `200`: Successful response - `application/json`: object - `file` (`file`, required) - `attachment` (`attachment`): Included if `attachment` provided in includes query parameter - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Search Files `GET /files/search` Operation ID: `searchFiles` Searches the account's files, attachable or not, with filters on type, size, source and uploader, one page at a time, sorted by title. Each item wraps the file under `file`. ##### Use Cases - Find the PDFs or images uploaded by one user - Find large files, or files Rentvine created (letters, statements), by `fileSourceIDs[]` ##### Business Rules - Requires only authentication; no permission is checked. - Use a key with no portfolio-group limit. - Filters combine with AND. A filter left out doesn't filter; neither does an `isAttachable`, `fileSizeMin` or `fileSizeMax` value it can't read. A list filter given values that match nothing (`fileSourceIDs[]=abc`) returns no files. - A list filter (`fileTypes[]`, `fileSourceIDs[]`, `userIDs[]`) takes one `name[]=` per value, and matches any of them. - Sorted by `title`, then by `fileID`. - `attachedToObjectTypeIDs[]`, `dateTimeCreatedMin` and `dateTimeCreatedMax` fail with an empty 500 for any value they can use (any `attachedToObjectTypeIDs[]` value, any date): the SQL they add is malformed or names a column the table doesn't have. An empty value, or a date that can't be read, is dropped. Don't send them. ##### Related Endpoints - `GET /files` - the attachable files, newest first - `GET /files/{fileID}` - one file, with its attachments Parameters: - `search` (query, string): Part of the file's title, matched anywhere in it and in any case. - `isAttachable` (query, string): `true` lists only attachable files, `false` only the others; `1`/`0` and `yes`/`no` work too. Any other value doesn't filter. - `fileType` (query, string): One extension (`pdf`, `jpg`), matched in any case. - `fileTypes[]` (query, string[]): Extensions, any of which matches. Send one `fileTypes[]=` per value; a single comma-separated value is read as one extension. - `fileSizeMin` (query, integer): Smallest size in bytes, inclusive. A value that isn't a number doesn't filter. - `fileSizeMax` (query, integer): Largest size in bytes, inclusive. A value that isn't a number doesn't filter. - `fileSourceIDs[]` (query, integer[]): File sources, any of which matches. Send one `fileSourceIDs[]=` per value. * `1` - Upload * `2` - Inbound Message * `3` - Letter * `4` - Bulk Letter * `5` - Statement Batch * `6` - Created Invoice * `7` - RentSign * `8` - Move Out Statement - `userIDs[]` (query, integer[]): The users who uploaded or created the file (a file's `userID`), any of which matches. Send one `userIDs[]=` per value. - `attachedToObjectTypeIDs[]` (query, integer[]): Fails with an empty 500 for any value it can use (see Business Rules); don't send it. - `dateTimeCreatedMin` (query, string): Fails with an empty 500 for any value it can use (see Business Rules); don't send it. - `dateTimeCreatedMax` (query, string): Fails with an empty 500 for any value it can use (see Business Rules); don't send it. - `page` (query, integer, default 1): Page number (default 1). `0` or a negative value is read as 1. - `pageSize` (query, integer, default 25): Items per page (default 25), with no upper limit. `0` or a negative value is read as 15. Responses: - `200`: One page of matching files - `application/json`: object[] - Each item: - `file` (`file`, required) Example: ```json [ { "file": { "fileID": "50", "fileSourceID": "1", "isAttachable": "1", "title": "Front door photo", "fileName": "7457207c-64e9-36ce-9503-7ecd8ad326ff.jpg", "fileType": "jpg", "fileSize": "286", "userID": "2", "isImage": "1", "isPublic": "0", "previewFileName": "preview-6af7cb0c11111.jpg", "dateTimeCreated": "2026-11-14 02:44:28" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` - `500`: An `attachedToObjectTypeIDs[]`, `dateTimeCreatedMin` or `dateTimeCreatedMax` value was sent. No body. #### Get File `GET /files/{fileID}` Operation ID: `getFile` Returns one file's record under `file`, and with the `fileAttachments` include, every record the file is attached to. ##### Use Cases - Read a file's title, type and size before downloading it - Find every record a file is attached to before deleting it ##### Business Rules - Requires only authentication; no permission is checked. - With a key limited to some portfolio groups, don't send the `fileID` of a file attached only to records outside those portfolios. - A well-formed `fileID` with no file answers 400 `File {fileID} not found`; a `fileID` that isn't all digits (`abc`, `-1`) answers the stock 404. ##### Available Includes (1) - `fileAttachments` - every attachment of the file, an empty list when it has none ##### Related Endpoints - `POST /files/{fileID}` - rename the file or change whether it can be attached - `DELETE /files/{fileID}` - delete the file - `GET /files/{fileID}/download` (undocumented) - the file itself Parameters: - `fileID` (path, integer, required): The file, from `GET /files` or `GET /files/search`. - `includes` (query, string): Comma-separated includes. One is available, `fileAttachments`; any other name is ignored. Responses: - `200`: The file - `application/json`: `file_view` Example: ```json { "file": { "fileID": "60", "fileSourceID": "1", "isAttachable": "1", "title": "Front door photo", "fileName": "ac216f37-534d-37a6-a9cd-62a1c6267bb6.jpg", "fileType": "jpg", "fileSize": "286", "userID": "2", "isImage": "1", "isPublic": "0", "previewFileName": "preview-6af7cb0e68a8d.jpg", "dateTimeCreated": "2026-11-14 02:44:30" }, "fileAttachments": [ { "fileAttachmentID": "17", "fileID": "60", "objectTypeID": "7", "objectID": "17", "isSharedWithOwner": "0", "isSharedWithTenant": "0", "isSharedWithVendor": "0", "isSharedWithApplicant": "0", "pathID": "1", "portalTypeID": "1", "contactID": "18", "subObjectTypeID": "51", "relatedObjectTypeID": "6", "relatedObjectID": "19" } ] } ``` - `400`: No file has this `fileID`. - `application/json`: object - `error` (string, required): Why the request was refused. Example: ```json { "error": "File 999999999 not found" } ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update File `POST /files/{fileID}` Operation ID: `updateFile` Renames a file or changes whether it can be attached, and returns it in the `GET /files/{fileID}` shape (with `fileAttachments` when the request's query string asks for it). ##### Use Cases - Give an uploaded file a readable title - Hide a file from the attachable list (`GET /files`) without deleting it ##### Business Rules - Requires the **Update Files** permission (`Files` › `UpdateFile`), checked before anything else: a key without it gets the 403 whatever the body or ID. - With a key limited to some portfolio groups, don't send the `fileID` of a file attached only to records outside those portfolios. - Only `title` and `isAttachable` are read; any other key in the body is ignored. - An empty body, or `{}`, answers 400 `invalid input.`. - A well-formed `fileID` with no file answers 400 `File {fileID} not found`; a `fileID` that isn't all digits (`abc`, `-1`) answers the stock 404. - A `title` that is empty, only spaces or longer than 200 characters, or an `isAttachable` that isn't a boolean, answers 400 with the validation messages, keyed by field. ##### Side Effects - A new title is copied into the file list kept on each email and text message the file is attached to. ##### Related Endpoints - `GET /files/{fileID}` - the file Parameters: - `fileID` (path, integer, required): The file, from `GET /files` or `GET /files/search`. - `includes` (query, string): `fileAttachments` adds the file's attachments to the response, as on `GET /files/{fileID}`. Request body, required: - `application/json`: object - `title` (string, max length 200): The name of the file shown to users; not empty or only spaces. - `isAttachable` (boolean | string | integer, one of true, false, "true", "false", "1", "0", "yes", "no", 1, 0): Whether the file can be attached to records and is listed by `GET /files`. Example: ```json { "title": "Front door photo (cropped)", "isAttachable": false } ``` Responses: - `200`: The updated file - `application/json`: `file_view` Example: ```json { "file": { "fileID": "66", "fileSourceID": "1", "isAttachable": "0", "title": "Front door photo (cropped)", "fileName": "20b7eb60-5585-36ee-96f4-be3106c48c9f.jpg", "fileType": "jpg", "fileSize": "286", "userID": "2", "isImage": "1", "isPublic": "0", "previewFileName": "preview-6af7cb0fa8564.jpg", "dateTimeCreated": "2026-11-14 02:44:31" } } ``` - `400`: The body is empty, no file has this `fileID`, or a field failed validation. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - Validation messages: object Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete File `DELETE /files/{fileID}` Operation ID: `deleteFile` Deletes a file: its record, every attachment of it, and the stored file. Returns the deleted file under `file`. ##### Use Cases - Remove a file uploaded by mistake from every record it is attached to ##### Business Rules - Requires the **Update Files** permission (`Files` › `UpdateFile`), checked before anything else: a key without it gets the 403 whatever the body or ID. - With a key limited to some portfolio groups, don't send the `fileID` of a file attached only to records outside those portfolios. - A well-formed `fileID` with no file answers 400 `File {fileID} not found`; a `fileID` that isn't all digits (`abc`, `-1`) answers the stock 404. - The delete can't be undone. ##### Side Effects - Every attachment of the file is deleted, so it disappears from each record it was on, with whatever is linked to the attachment itself (its notes, activity and the like). On a record whose activity is tracked, the "File Added" entry keeps its title but loses its link to the file, and a "File Deleted" entry is added. - The key's user is added as a watcher of each record the file was on, where that record type has watchers. - The file list kept on each email and text message the file was attached to is updated. - A maintenance material that used the file as its image keeps no image (`imageFileID` becomes null). - Each work-order receipt scanned from the file is deleted. - The stored file and its preview are removed from storage. ##### Related Endpoints - `GET /files/{fileID}` - the file and its attachments, to check before deleting Parameters: - `fileID` (path, integer, required): The file, from `GET /files` or `GET /files/search`. Responses: - `200`: The deleted file - `application/json`: object - `file` (`file`, required) Example: ```json { "file": { "fileID": "86", "fileSourceID": "1", "isAttachable": "1", "title": "Front door photo", "fileName": "235016c0-7dac-39d1-9e1e-1d6f7a38b327.jpg", "fileType": "jpg", "fileSize": "286", "userID": "2", "isImage": "1", "isPublic": "0", "previewFileName": "preview-6af7cb277547d.jpg", "dateTimeCreated": "2026-11-14 02:44:55" } } ``` - `400`: No file has this `fileID`. - `application/json`: object - `error` (string, required): Why the request was refused. Example: ```json { "error": "File 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ## Leases ### Leases #### List Lease Statuses `GET /leases/statuses` Operation ID: `listLeaseStatuses` Returns all lease statuses defined for the account, ordered by `orderIndex`. Each result wraps a single `leaseStatus` object. System statuses (`isSystemStatus = 1`) are built-in and cannot be deleted; custom statuses are account-defined. ##### Use Cases - Displaying the full list of available statuses in lease status management settings ##### Business Rules - No special permission required — any authenticated user can read lease statuses - Results are ordered by `orderIndex` ascending - `primaryLeaseStatusID` groups each status under one of three top-level states: Pending (`1`), Active (`2`), or Closed (`3`) ##### Related Endpoints - `POST /leases/{leaseID}/status` - Update the status of a specific lease Responses: - `200`: Successfully retrieved lease statuses. - `application/json`: object[] - Each item: - `leaseStatus` (object, required) - `leaseStatusID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the lease status. - `primaryLeaseStatusID` (string, required, pattern `^-?[0-9]+$`): Top-level status group this status belongs to. * `1` - Pending * `2` - Active * `3` - Closed - `isSystemStatus` (string, required, one of "0", "1"): Whether this is a built-in system status (`1`) or a custom account-defined status (`0`). System statuses cannot be deleted. - `name` (string, required): Display name of the lease status. - `isPendingMoveInStatus` (string, required, one of "0", "1"): Whether this status indicates a tenant is pending move-in (`1` = yes, `0` = no). - `isPendingMoveOutStatus` (string, required, one of "0", "1"): Whether this status indicates a tenant has given notice or is pending move-out (`1` = yes, `0` = no). - `isCompletedMoveOutStatus` (string, required, one of "0", "1"): Whether this status indicates the tenant has fully moved out (`1` = yes, `0` = no). - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Display order index (ascending). Determines the sort order in dropdowns and lists. Example: ```json [ { "leaseStatus": { "leaseStatusID": "2", "primaryLeaseStatusID": "2", "isSystemStatus": "1", "name": "Active", "isPendingMoveInStatus": "0", "isPendingMoveOutStatus": "0", "isCompletedMoveOutStatus": "0", "orderIndex": "0" } }, { "leaseStatus": { "leaseStatusID": "1", "primaryLeaseStatusID": "1", "isSystemStatus": "1", "name": "Pending", "isPendingMoveInStatus": "1", "isPendingMoveOutStatus": "0", "isCompletedMoveOutStatus": "0", "orderIndex": "1" } }, { "leaseStatus": { "leaseStatusID": "5", "primaryLeaseStatusID": "2", "isSystemStatus": "0", "name": "Active - Evicting", "isPendingMoveInStatus": "0", "isPendingMoveOutStatus": "1", "isCompletedMoveOutStatus": "0", "orderIndex": "4" } }, { "leaseStatus": { "leaseStatusID": "6", "primaryLeaseStatusID": "3", "isSystemStatus": "1", "name": "Closed", "isPendingMoveInStatus": "0", "isPendingMoveOutStatus": "0", "isCompletedMoveOutStatus": "0", "orderIndex": "7" } }, { "leaseStatus": { "leaseStatusID": "7", "primaryLeaseStatusID": "3", "isSystemStatus": "0", "name": "Closed - Moved Out", "isPendingMoveInStatus": "0", "isPendingMoveOutStatus": "0", "isCompletedMoveOutStatus": "1", "orderIndex": "8" } } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Leases `GET /leases` Operation ID: `listLeases` Lists leases Responses: - `200`: Successful response - `application/json`: object[] - Each item: - `lease` (`lease`) - `unit` (`unit`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Lease `POST /leases` Operation ID: `createLease` Creates a new lease with all associated entities: tenants, recurring charges, move-in charges, occupants, pets, emergency contacts, and vehicles. ##### Use Cases - Converting an approved rental application into an active lease - Creating a lease directly without a prior application ##### Business Rules - Requires `Update Lease` permission in Roles - The unit specified in `unitID` must exist and be active - At least one entry in the `tenants` array is required - If `applicationID` is provided, the application must exist and be in a compatible state - If `chargeLeaseFee` is `true`, both `leaseFeeAmount` and `leaseFeeDatePosted` must be provided - On success the endpoint internally forwards to `GET /leases/{leaseID}` and returns the full lease detail ##### Related Endpoints - `GET /leases` - List leases - `GET /leases/{leaseID}` - Get lease detail (same shape as the response here) - `POST /leases/{leaseID}` - Update lease Request body, required: - `application/json`: object - `lease` (object, required) - `unitID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the unit this lease is for. - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): User assigned to manage this lease. - `applicationID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the application this lease was created from. - `code` (string | null): Optional lease code / reference number. - `moveInDate` (string, date, required): Tenant move-in date. - `startDate` (string, date, required): Lease start date. - `endDate` (string | null, date): Lease end date. Omit for month-to-month leases. - `tenantLiabilityInsuranceProviderID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the tenant liability insurance provider. - `tenantLiabilityInsuranceEffectiveDate` (string | null, date): Effective date of the tenant liability insurance policy. - `rentersInsuranceCompany` (string | null): Name of the renters insurance company. - `rentersInsurancePolicyNumber` (string | null): Renters insurance policy number. - `rentersInsuranceExpirationDate` (string | null, date): Renters insurance policy expiration date. - `rentersInsuranceFileID` (string | integer | null, pattern `^-?[0-9]+$`): File ID of the uploaded renters insurance document. - `lateFeeSettingID` (string | integer | null, required, pattern `^-?[0-9]+$`): ID of the late fee configuration to apply to this lease. - `leaseReturnChargeAmount` (string | number, decimal, required): Amount charged for returned payments (NSF fee). - `isTenantPastDueNoticeEnabled` (string | integer, one of "0", "1", 0, 1): Whether past-due notice emails are sent for this lease (0 or 1). - `leaseActivationOptionID` (string | integer | null, pattern `^-?[0-9]+$`): Activation option controlling when/how the lease becomes active. - `statementSettingID` (string | integer | null, pattern `^-?[0-9]+$`): Statement setting override for this lease. - `sendStatements` (string | integer | null, one of "0", "1", 0, 1, null): Whether to send statements to tenants (0 or 1). - `rvInsuranceEnabled` (boolean): Whether to enroll this lease in Rentvine's built-in tenant liability insurance program. - `tenantLiabilityInsuranceRentvinePackageID` (integer | null): Rentvine insurance package ID when enrolling in the built-in TLL program. - `application` (object): Optional application status update when converting an application to a lease. - `applicationStatusID` (string | integer, pattern `^-?[0-9]+$`): New status ID to set on the linked application. - `residentPackageID` (string | integer | null, pattern `^-?[0-9]+$`): REP package to enroll the lease in (`resident_packages`) — a **top-level** field, not part of the `lease` object. When set, the lease is enrolled on create: it opens the single bundled recurring charge and snapshots the package's services as member entitlements. Must reference an existing, active package with at least one active service (a missing id returns `400`). Omit/null to create the lease without a package. - `residentServices` (object[]): À la carte REP service entitlements to add alongside the lease (separate from a package), as a **top-level** field. Each is created with its own recurring charge. Each `residentServiceID` must reference an active catalog service (`resident_services`). - `residentServiceID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the catalog service to add to the lease. - `recurringCharges` (object[]): Recurring charges (rent, pet fees, parking, etc.) to attach to the lease at creation. - `accountID` (string | integer, required, pattern `^-?[0-9]+$`): GL account for this recurring charge. - `amount` (string | number, decimal, required): Charge amount as a decimal string. - `description` (string | null): Description shown on the tenant statement. - `dayDue` (string | integer, required, pattern `^-?[0-9]+$`): Day of month the charge is due (1–31). - `frequency` (string | integer, required, pattern `^-?[0-9]+$`): Charge frequency in months (1=monthly, 3=quarterly, 12=annual). - `startDate` (string, date, required): Date the recurring charge begins. - `endDate` (string | null, date): Date the recurring charge ends. Omit for open-ended. - `nextChargeDate` (string | null, date): Override the date of the first charge posting. - `isMoveInCharge` (string | integer, one of "0", "1", 0, 1): Whether this charge is prorated on move-in (0 or 1). - `recurringChargeTempID` (string | null): Client-side temporary ID used to correlate this recurring charge with a corresponding move-in charge. - `isForTLL` (integer): Whether this recurring charge is for Rentvine's tenant liability insurance program (0 or 1). - `escalations` (object[]): Scheduled future increases to this recurring charge. - `amount` (string | number, decimal) - `effectiveDate` (string, date) - `otherRecurringCharges` (object[]): Additional recurring charges (utility fees, etc.) using a simplified structure without escalations. - `accountID` (string | integer, pattern `^-?[0-9]+$`) - `amount` (string | number, decimal) - `description` (string | null) - `dayDue` (string | integer, pattern `^-?[0-9]+$`) - `frequency` (string | integer, pattern `^-?[0-9]+$`) - `startDate` (string, date) - `charges` (object[]): One-time move-in charges (security deposit, admin fee, etc.) posted when the lease is created. - `chargeAccountID` (string | integer, required, pattern `^-?[0-9]+$`): GL account for this charge. - `amount` (string | number, decimal, required): Charge amount. - `description` (string | null): Description shown on the tenant ledger. - `datePosted` (string | null, date): Date the charge is posted to the ledger. - `isMoveInCharge` (string | integer, one of "0", "1", 0, 1): Whether this is a move-in charge (0 or 1, default 1). - `isProrated` (string | integer, one of "0", "1", 0, 1): Whether the charge should be prorated. Accepts `true`/`false` or `1`/`0`. - `recurringChargeTempID` (string | null): Matches a `recurringChargeTempID` in `recurringCharges` to generate a prorated first-month charge. - `isForTLL` (integer): Whether this charge is for Rentvine's tenant liability insurance (0 or 1). - `tenants` (object[], required): Primary tenants on the lease. At least one is required. - `contactID` (string | integer, required, pattern `^-?[0-9]+$`): Contact ID of the tenant. Accepts integer or numeric string. - `cosignerTenants` (object[]): Co-signer tenants (guarantors) on the lease. - `contactID` (string | integer, required, pattern `^-?[0-9]+$`): Contact ID of the co-signer. Accepts integer or numeric string. - `applicants` (object[]): Applicants from the linked application to convert to tenants. Only processed when `lease.applicationID` is set. - `applicantID` (string | integer, pattern `^-?[0-9]+$`) - `cosignerApplicants` (object[]): Co-signer applicants from the linked application. Only processed when `lease.applicationID` is set. - `applicantID` (string | integer, pattern `^-?[0-9]+$`) - `occupants` (object[]): Non-tenant occupants (minors, roommates, etc.) listed on the lease. - `name` (string) - `dateOfBirth` (string | null, date) - `processPetsFromApplication` (boolean, default true): When `true` (default), pets are copied from the linked application. Set to `false` and provide the `pets` array to supply pet data directly. - `pets` (object[]): Pets on the lease. Only used when `processPetsFromApplication` is `false`. - `type` (string | null) - `name` (string | null) - `age` (string | integer | null, pattern `^-?[0-9]+$`) - `weight` (string | null) - `color` (string | null) - `gender` (string | null) - `hasShots` (string | integer | null, one of "0", "1", 0, 1, null) - `isTrained` (string | integer | null, one of "0", "1", 0, 1, null) - `isNeutered` (string | integer | null, one of "0", "1", 0, 1, null) - `isDeclawed` (string | integer | null, one of "0", "1", 0, 1, null) - `isEmotionalSupportAnimal` (string | integer | null, one of "0", "1", 0, 1, null) - `isServiceAnimal` (string | integer | null, one of "0", "1", 0, 1, null) - `petScreeningAnimalID` (string | integer | null, pattern `^-?[0-9]+$`) - `processEmergencyContactsFromApplication` (boolean, default true): When `true` (default), emergency contacts are copied from the linked application. Set to `false` and provide `emergencyContacts` directly. - `emergencyContacts` (object[]): Emergency contacts for the tenant. Only used when `processEmergencyContactsFromApplication` is `false`. - `name` (string) - `relationship` (string | null) - `email` (string | null, email) - `phone` (string | null) - `phone2` (string | null) - `fullAddress` (string | null) - `processVehiclesFromApplication` (boolean, default true): When `true` (default), vehicles are copied from the linked application. Set to `false` and provide the `vehicles` array directly. - `vehicles` (object[]): Vehicles registered to the lease. Only used when `processVehiclesFromApplication` is `false`. - `make` (string | null) - `model` (string | null) - `yearBuilt` (string | null) - `color` (string | null) - `plateNumber` (string | null) - `plateState` (string | null) - `sendPortalInvitations` (boolean, default false): When `true`, portal invitation emails are sent to all tenants on the lease at creation. - `deactivateListing` (boolean, default false): When `true`, the property listing is deactivated upon lease creation. - `chargeLeaseFee` (boolean, default false): When `true`, a management lease fee is charged at creation. Requires `leaseFeeAmount` and `leaseFeeDatePosted`. - `leaseFeeAmount` (string | number, decimal): Lease fee amount. Required when `chargeLeaseFee` is `true`. - `leaseFeeDatePosted` (string, date): Date to post the lease fee. Required when `chargeLeaseFee` is `true`. Example: ```json { "lease": { "unitID": "585", "startDate": "04/29/2026", "endDate": "2027-04-30", "moveInDate": "04/29/2026", "lateFeeSettingID": "87", "leaseReturnChargeAmount": "15.00", "assignedToUserID": "51", "rentersInsuranceCompany": null, "rentersInsurancePolicyNumber": null, "rentersInsuranceExpirationDate": null, "tenantLiabilityInsuranceEffectiveDate": "2026-04-29", "tenantLiabilityInsuranceProviderID": null, "tenantLiabilityInsuranceRentvinePackageID": null, "rvInsuranceEnabled": false, "leaseActivationOptionID": "1" }, "application": { "applicationStatusID": "6" }, "applicants": [], "tenants": [ { "contactID": "1352" } ], "cosignerTenants": [], "cosignerApplicants": [], "occupants": [], "processEmergencyContactsFromApplication": false, "emergencyContacts": [], "processPetsFromApplication": false, "pets": [], "processVehiclesFromApplication": false, "vehicles": [], "recurringCharges": [ { "recurringChargeTempID": "recurring-rc_1776731117586_scxwgmuph", "accountID": "9", "amount": "1500.00", "startDate": "04/29/2026", "description": "Rent", "escalations": [], "nextChargeDate": "2026-06-01", "dayDue": 1, "frequency": 1, "isMoveInCharge": 1, "isForTLL": 0 }, { "recurringChargeTempID": "recurring-rc_1776731117586_tn3v4xkmd", "accountID": "4", "amount": "100.00", "startDate": "04/29/2026", "description": "Open Credit", "escalations": [], "nextChargeDate": "2026-06-01", "dayDue": 1, "frequency": 1, "isMoveInCharge": 1, "isForTLL": 0 }, { "recurringChargeTempID": "recurring-rc_1776731117586_t6dq0uo2h", "accountID": "16", "amount": "100.00", "startDate": "04/29/2026", "description": "Pet Rent", "escalations": [], "nextChargeDate": "2026-06-01", "dayDue": 1, "frequency": 1, "isMoveInCharge": 1, "isForTLL": 0 }, { "recurringChargeTempID": "recurring-rc_1776731117586_u3cewsy1o", "accountID": "45", "amount": "30.00", "startDate": "04/29/2026", "description": "Resident Benefit Package", "escalations": [], "nextChargeDate": "2026-06-01", "dayDue": 1, "frequency": 1, "isMoveInCharge": 1, "isForTLL": 0 } ], "otherRecurringCharges": [ { "accountID": "117", "amount": "120.00", "startDate": "10/21/2026", "description": "Pet Rent", "dayDue": 21, "frequency": 1 } ], "charges": [ { "recurringChargeTempID": "security-deposit", "chargeAccountID": "2", "description": "Security Deposit", "datePosted": "2026-04-20", "isMoveInCharge": 1, "isProrated": "0", "amount": "1500.00", "isForTLL": 0 }, { "recurringChargeTempID": "default-movein-2", "chargeAccountID": "43", "description": "Move In Admin Fee", "datePosted": "04/29/2026", "isMoveInCharge": 1, "isProrated": "0", "amount": "150.00", "isForTLL": 0 }, { "recurringChargeTempID": "recurring-rc_1776731117586_t6dq0uo2h", "chargeAccountID": "16", "description": "Pet Rent", "datePosted": "2026-05-01", "isMoveInCharge": 0, "isProrated": "1", "amount": "6.67", "isForTLL": 0 }, { "recurringChargeTempID": "recurring-rc_1776731117586_u3cewsy1o", "chargeAccountID": "45", "description": "Resident Benefit Package", "datePosted": "2026-05-01", "isMoveInCharge": 0, "isProrated": "1", "amount": "2.00", "isForTLL": 0 } ], "sendPortalInvitations": false, "deactivateListing": false, "chargeLeaseFee": true, "leaseFeeAmount": "1500.00", "leaseFeeDatePosted": "04/29/2026" } ``` Responses: - `200`: Lease created successfully. Returns the full lease detail (same shape as `GET /leases/{leaseID}`). - `application/json`: object - `lease` (combined object, required) - All of: - Option 1: `lease` - Option 2: object - `rentAmount` (number, read-only): Sum of all active recurring charges on the lease. Returned as a number (not a string). Example: ```json { "lease": { "leaseID": "3002", "propertyID": "603", "unitID": "585", "primaryLeaseStatusID": "1", "leaseStatusID": "13", "moveOutStatusID": "1", "assignedToUserID": "51", "applicationID": null, "leaseDocumentTransactionID": null, "code": null, "tenants": [ "Valencia , Arthur" ], "moveInDate": "2026-04-29", "startDate": "2026-04-29", "endDate": "2027-04-30", "tenantLiabilityInsuranceProviderID": null, "tenantLiabilityInsuranceEffectiveDate": "2026-04-29", "rentersInsuranceCompany": null, "rentersInsurancePolicyNumber": null, "rentersInsuranceExpirationDate": null, "rentersInsuranceFileID": null, "leaseFeeTransactionID": null, "leaseFeeBillID": "15017", "dateTimeCreated": "2026-04-21 00:26:41", "dateTimeModified": "2026-04-21 00:26:41", "lateFeeSettingID": "87", "isPortalDisabled": "0", "isPortalPaymentDisabled": "0", "isCertifiedFundsRequired": "0", "isLateFeesActive": "1", "allowedPaymentAmountTypeID": null, "isAchDisabled": "0", "isCreditCardDisabled": "0", "isCashDisabled": "0", "closedDate": null, "closedDescription": null, "noticeDate": null, "expectedMoveOutDate": null, "moveOutDate": null, "depositRefundDueDate": null, "leaseReturnChargeAmount": "15.00", "moveOutReasonID": null, "moveOutUnitAvailabilityDate": null, "moveOutTenantRemarks": null, "moveOutLeaseTenantID": null, "isLeaseAgreementViolated": "0", "forwardingName": null, "forwardingCountryID": null, "forwardingAddress": null, "forwardingAddress2": null, "forwardingCity": null, "forwardingStateID": null, "forwardingPostalCode": null, "forwardingEmail": null, "forwardingPhone": null, "moveOutTenantReason": null, "tenantRefundPayoutTypeID": "1", "statementSettingID": null, "sendStatements": "1", "isFromImport": "0", "importSourceKey": null, "isTenantPastDueNoticeEnabled": "1", "rentvineInsuranceEnrollmentID": null, "rentvineInsuranceEnrollmentStatusID": null, "rentvineInsurancePackageID": null, "rentvineInsuranceRecurringChargeID": null, "rentvineInsuranceChargeID": null, "leaseActivationOptionID": "1", "increaseEligibilityDate": "2027-05-01", "isAutoClosed": "0", "isPublicStatementEnabled": "1", "isMarkedToVacate": "0", "rentAmount": 1600 } } ``` - `400`: Validation failed, contract errors, or unexpected exception. - `application/json` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### View `GET /leases/{leaseID}` Operation ID: `getLease` Returns a single lease. The response always contains `lease`; every other top-level key is **opt-in** via the `includes` query parameter, so the frontend fetches exactly the related data a page needs in one request. ##### Includes Pass a comma-separated list, e.g. `?includes=property,unit,tenants,residentPackage`. Each include adds the listed top-level key(s) to the response. Some includes are **nested** — they only resolve when their parent include is also requested (noted below). **Property & portfolio** - `property` → `property` - `portfolio` → `portfolio` *(requires `property`)* - `postingSetting` → `postingSetting`, `operatingAccount` *(requires `property`, `portfolio`)* - `portfolioOwners` → `portfolioOwners` *(requires `property`, `portfolio`)* - `chargesForPayment` → `chargesForPayment` *(requires `property`)* - `previousPropertyPortfolio` → `previousPropertyPortfolio` *(omitted when none)* **Unit** - `unit` → `unit` - `propertyManager` → `propertyManager` *(requires `unit`)* **Lease meta** - `leaseStatus` → `leaseStatus` - `tenants` → `tenants` - `occupants` → `occupants` - `vehicles` → `vehicles` - `emergencyContacts` → `emergencyContacts` - `moveOutContact` → `moveOutContact` *(null when none)* - `application` → `application` *(only when the lease has an application)* - `leaseDocumentTransaction` → `leaseDocumentTransaction` - `statementSetting` → `statementSetting` *(null when using the portfolio default)* - `tenantAddresses` → `tenantAddresses` **Pets** - `pets` → `pets`, plus `petScreeningEnabled`, `petscreeningData`, `noPetData` when the lease has an application **Billing & accounting** - `recurringCharges` → `recurringCharges` - `leaseRecurringPayments` → `leaseRecurringPayments` - `leaseRecurringCredits` → `leaseRecurringCredits` - `outstandingCharges` → `outstandingCharges` - `outstandingCredits` → `outstandingCredits` - `outstandingPayments` → `outstandingPayments` - `transactions` → `transactions` - `refundableTransactions` → `refundableTransactions` - `balances` → `balances` - `lateFeeSetting` → `lateFeeSetting` - `leaseFeeTransaction` → `leaseFeeTransaction` - `leaseFeeBill` → `leaseFeeBill` - `leaseFeeBillCharges` → `leaseFeeBillCharges` **Renewals** - `renewals` → `renewals` - `activeRenewal` → `activeRenewal` *(the most recent in-progress renewal, or null)* **Insurance** - `tenantLiabilityInsuranceProvider` → `tenantLiabilityInsuranceProvider` *(null when none)* - `tenantLiabilityInsurance` → `tenantLiabilityInsurance` - `rentersInsuranceFile` → `rentersInsuranceFile` *(null when none)* - `rentersInsuranceRequest` → `rentersInsuranceRequest` *(null when none)* - `tenantPolicyStatus` → `tenantPolicyStatus` *(system/provider policy status; null for non-system leases)* **Resident Experience Package (REP)** - `residentPackage` → `leaseResidentPackage`, `residentPackage` *(both null when the lease isn't enrolled)* - `residentServices` → `residentServices` Parameters: - `leaseID` (path, integer, required) - `includes` (query, string): Comma-separated related data to embed. See the **Includes** list above for every supported value and the response key(s) each adds. Unknown values are ignored. Responses: - `200`: Successful response. `lease` is always present; the remaining properties appear only when their include is requested. Include shapes are loosely typed here (the underlying models aren't yet modeled in this spec) — treat object/array as the contract and see the listed model for fields. - `application/json`: object - `lease` (`lease`, required) - `property` (`property`): The lease's property. Requires `property` include. - All of: - Option 1: `property` - `portfolio` (object): The property's portfolio. Requires `property,portfolio`. - `postingSetting` (object): The portfolio's posting setting. Requires `property,portfolio,postingSetting`. - `operatingAccount` (object): The posting setting's operating account. Added alongside `postingSetting`. - `portfolioOwners` (object[]): The portfolio's owners (each with their contact). Requires `property,portfolio,portfolioOwners`. - `chargesForPayment` (object[]): Unpaid charges available for payment, each wrapped as `{ transaction }`. Requires `property,chargesForPayment`. - `previousPropertyPortfolio` (object): The property's prior (non-current) portfolio. Present only when one exists. Requires `previousPropertyPortfolio`. - `unit` (`unit`): The lease's unit. Requires `unit` include. - All of: - Option 1: `unit` - `propertyManager` (object): The unit's property manager. Requires `unit,propertyManager`. - `leaseStatus` (`lease_status`): The lease's status record. Requires `leaseStatus` include. - All of: - Option 1: `lease_status` - `tenants` (`tenant`[]): The lease's tenants (each lease-tenant link joined to its contact). Requires `tenants` include. - `occupants` (object[] | null): The lease's occupants. Requires `occupants` include. - `vehicles` (object[] | null): The lease's vehicles. Requires `vehicles` include. - `emergencyContacts` (object[] | null): The lease's emergency contacts. Requires `emergencyContacts` include. - `moveOutContact` (object | null): The move-out contact, or null. Requires `moveOutContact` include. - `application` (object): The originating rental application. Present only when the lease has an application. Requires `application` include. - `leaseDocumentTransaction` (object): The lease's e-sign document transaction. Requires `leaseDocumentTransaction` include. - `statementSetting` (object | null): The lease's statement-setting override, or null when using the portfolio default. Requires `statementSetting` include. - `tenantAddresses` (object[]): The lease's tenant mailing addresses. Requires `tenantAddresses` include. - `pets` (object[] | null): The lease's pets. Requires `pets` include. - `petScreeningEnabled` (boolean): Whether pet screening is enabled for the lease's application. Added with `pets` when the lease has an application. - `petscreeningData` (object): Pet-screening profile data for the application's applicants. Added with `pets` when the lease has an application. - `noPetData` (object): No-pet acknowledgement data, when an applicant declared no pets. Added with `pets` when present. - `recurringCharges` (object[]): The lease's recurring charges. Requires `recurringCharges` include. - `leaseRecurringPayments` (object[]): The lease's recurring payments (with payment method). Requires `leaseRecurringPayments` include. - `leaseRecurringCredits` (object[]): The lease's recurring credits. Requires `leaseRecurringCredits` include. - `outstandingCharges` (object[]): Outstanding charge transactions. Requires `outstandingCharges` include. - `outstandingCredits` (object[]): Outstanding credit transactions. Requires `outstandingCredits` include. - `outstandingPayments` (object[]): Outstanding payment transactions. Requires `outstandingPayments` include. - `transactions` (object[]): The lease's non-voided transactions, newest first. Requires `transactions` include. - `refundableTransactions` (object[]): Transactions eligible for refund. Requires `refundableTransactions` include. - `balances` (object): The lease's account balances as of today (account timezone). Requires `balances` include. - `lateFeeSetting` (object | null): The lease's late-fee setting, or null. Requires `lateFeeSetting` include. - `leaseFeeTransaction` (object | null): The lease-fee transaction, or null. Requires `leaseFeeTransaction` include. - `leaseFeeBill` (object | null): The lease-fee bill, or null. Requires `leaseFeeBill` include. - `leaseFeeBillCharges` (object[]): The lease-fee bill's charge transactions (empty when no bill). Requires `leaseFeeBillCharges` include. - `renewals` (object[]): The lease's renewals, each with a resolved `leaseRenewalStatusName`. Requires `renewals` include. - `activeRenewal` (object | null): The most recent in-progress renewal, or null when none is active. Requires `activeRenewal` include. - `tenantLiabilityInsuranceProvider` (object | null): The lease's TLL provider, or null. Requires `tenantLiabilityInsuranceProvider` include. - `tenantLiabilityInsurance` (object): The lease's tenant liability insurance view. Requires `tenantLiabilityInsurance` include. - `rentersInsuranceFile` (object | null): The uploaded proof-of-insurance file (non-system policies), or null. Requires `rentersInsuranceFile` include. - `rentersInsuranceRequest` (object | null): A pending renters-insurance request, or null. Requires `rentersInsuranceRequest` include. - `tenantPolicyStatus` (object | null): System/provider policy status (`{ tenantPolicyStatusID }`), or null for non-system leases. Requires `tenantPolicyStatus` include. - `leaseResidentPackage` (`lease_resident_package`): The lease's one REP package enrollment (`lease_resident_packages`), or null when not enrolled. Requires `residentPackage` include. - All of: - Option 1: `lease_resident_package` - `residentPackage` (`package`): The catalog package (`resident_packages`) the enrollment points to, or null when not enrolled. Added alongside `leaseResidentPackage` via the `residentPackage` include. - All of: - Option 1: `package` - `residentServices` (object[]): The lease's REP service entitlements (`lease_resident_services`), each joined to its catalog service. Requires `residentServices` include. - `leaseResidentService` (`lease_resident_service`) - `residentService` (`service`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Update Lease `POST /leases/{leaseID}` Operation ID: `updateLease` Updates an existing lease's details. On success the endpoint internally forwards to `GET /leases/{leaseID}` and returns the full lease detail. ##### Use Cases - Modifying lease dates (start, end, move-in, move-out, notice, expected move-out) - Changing the assigned property manager (`assignedToUserID`) - Adjusting late fee settings, allowed tenant payment amount, and statement settings - Providing the lease with a `closedDate` and `closedDescription` within the lease details ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist; a `400` is returned if not found - Portfolio restrictions apply — users can only update leases within their accessible portfolios - `leaseStatusID` is **not** updated by this endpoint; use `POST /leases/{leaseID}/status` to change status ##### Related Endpoints - `GET /leases/{leaseID}` - Get full lease detail (same response shape as returned here) - `POST /leases/{leaseID}/status` - Update lease status only - `POST /leases` - Create a new lease Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the user assigned to manage this lease. - `leaseStatusID` (string | integer | null, pattern `^-?[0-9]+$`): Lease status ID. Sent by the frontend but not applied by this endpoint — use `POST /leases/{leaseID}/status` to change status. - `noticeDate` (string | null, date): Date the tenant gave notice to vacate. - `expectedMoveOutDate` (string | null, date): Expected date the tenant will move out. - `moveInDate` (string | null, date): Tenant move-in date. - `moveOutDate` (string | null, date): Actual move-out date. - `depositRefundDueDate` (string | null, date): Date by which the security deposit refund is due. - `closedDate` (string | null, date): Date the lease was closed. Set along with `closedDescription` to close a lease. - `closedDescription` (string | null): Reason or notes recorded when the lease is closed. - `startDate` (string, date): Lease start date. - `endDate` (string | null, date): Lease end date. Omit or set null for month-to-month leases. - `increaseEligibilityDate` (string | null, date): Date after which the lease is eligible for a rent increase. - `leaseReturnChargeAmount` (string | number, decimal): Amount charged for returned payments (NSF fee). - `lateFeeSettingID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the late fee configuration to apply to this lease. - `showOverriddenAllowedPaymentType` (boolean): Frontend flag controlling whether the allowed payment type override UI is shown. Sent in the payload but not persisted by this endpoint. - `allowedPaymentAmountTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Restricts the payment amount type tenants may submit. Null means no restriction. (1 means any amount, 2 means full amount only) - `isTenantPastDueNoticeEnabled` (string | integer, one of "0", "1", 0, 1): Whether past-due notice emails are sent for this lease (0 or 1). - `statementSettingID` (string | integer | null, pattern `^-?[0-9]+$`): Statement setting override for this lease. Null uses the portfolio default. - `sendStatements` (string | integer, one of "0", "1", 0, 1): Whether statements are sent to tenants (0 or 1). - `code` (string | null): Optional lease reference code. Example: ```json { "assignedToUserID": "122188", "leaseStatusID": "21", "noticeDate": "2025-03-21", "expectedMoveOutDate": "2025-08-05", "moveInDate": "2025-03-05", "moveOutDate": "2025-08-05", "depositRefundDueDate": "2026-04-21", "closedDate": "2026-04-21", "closedDescription": "test 1", "startDate": "2026-04-17", "endDate": "2026-10-17", "increaseEligibilityDate": "2028-03-05", "rentAmount": 100, "leaseReturnChargeAmount": "35.00", "lateFeeSettingID": "87", "showOverriddenAllowedPaymentType": true, "allowedPaymentAmountTypeID": 1, "isTenantPastDueNoticeEnabled": "1", "statementSettingID": "1", "sendStatements": "1" } ``` Responses: - `200`: Lease updated successfully. Returns the full lease detail (same shape as `GET /leases/{leaseID}`). - `application/json`: object - `lease` (`lease`, required) Example: ```json { "lease": { "leaseID": "2213", "propertyID": "406", "unitID": "391", "primaryLeaseStatusID": "2", "leaseStatusID": "21", "moveOutStatusID": "1", "assignedToUserID": "122188", "applicationID": null, "leaseDocumentTransactionID": null, "code": null, "tenants": [ "John Tester", "Joe Michael" ], "moveInDate": "2025-03-05", "startDate": "2026-04-17", "endDate": "2026-10-25", "tenantLiabilityInsuranceProviderID": null, "tenantLiabilityInsuranceEffectiveDate": null, "rentersInsuranceCompany": "rentersInsuranceCompany", "rentersInsurancePolicyNumber": "111222333-4", "rentersInsuranceExpirationDate": "2028-02-03", "rentersInsuranceFileID": null, "leaseFeeTransactionID": null, "leaseFeeBillID": null, "dateTimeCreated": "2025-03-06 17:04:46", "dateTimeModified": "2026-04-21 15:03:58", "lateFeeSettingID": "87", "isPortalDisabled": "0", "isPortalPaymentDisabled": "0", "isCertifiedFundsRequired": "0", "isLateFeesActive": "1", "allowedPaymentAmountTypeID": null, "isAchDisabled": "0", "isCreditCardDisabled": "1", "isCashDisabled": "0", "closedDate": null, "closedDescription": null, "noticeDate": "2025-03-21", "expectedMoveOutDate": "2025-08-05", "moveOutDate": "2025-08-05", "depositRefundDueDate": null, "leaseReturnChargeAmount": "35.00", "moveOutReasonID": "8", "moveOutUnitAvailabilityDate": null, "moveOutTenantRemarks": null, "moveOutLeaseTenantID": null, "isLeaseAgreementViolated": "0", "forwardingName": null, "forwardingCountryID": "US", "forwardingAddress": null, "forwardingAddress2": null, "forwardingCity": null, "forwardingStateID": "FL", "forwardingPostalCode": null, "forwardingEmail": null, "forwardingPhone": null, "moveOutTenantReason": null, "tenantRefundPayoutTypeID": "1", "statementSettingID": null, "sendStatements": "1", "isFromImport": "0", "importSourceKey": null, "isTenantPastDueNoticeEnabled": "0", "rentvineInsuranceEnrollmentID": null, "rentvineInsuranceEnrollmentStatusID": null, "rentvineInsurancePackageID": null, "rentvineInsuranceRecurringChargeID": null, "rentvineInsuranceChargeID": null, "leaseActivationOptionID": "3", "increaseEligibilityDate": "2028-03-05", "isAutoClosed": "0", "isPublicStatementEnabled": "1", "isMarkedToVacate": "0", "rentAmount": 100 } } ``` - `400`: Validation failed or lease not found. - `application/json` Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Lease `DELETE /leases/{leaseID}` Operation ID: `deleteLease` Permanently deletes a lease from the system. On success, returns the deleted lease record as it existed at time of deletion. **This endpoint will only succeed if the lease has never had any accounting transactions, payouts, or deposit releases tied to it.** Voiding or deleting individual charges, tenant credits, or tenant receipts does not satisfy this requirement — once any transaction has ever been recorded against a lease, the lease cannot be deleted. Use lease closure or move-out workflows instead to retire a lease that has financial history. ##### Use Cases - Removing a lease that was created in error before any accounting activity occurred - Cleaning up test or draft leases in non-production environments ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist; a `400` is returned if not found - The lease must have zero accounting transactions ever recorded (including voided ones); a `400` is returned with `"Cannot delete a lease that has accounting transactions"` if any exist - All associated tenants, occupants, recurring charges, and related records are cascade-deleted as part of this operation ##### Related Endpoints - `GET /leases/{leaseID}` - Get the lease detail before deleting - `POST /leases/{leaseID}/status` - Close or change lease status (for leases with transaction history) Parameters: - `leaseID` (path, integer, required) Responses: - `200`: Lease deleted successfully. Returns the deleted lease record. - `application/json`: object - `lease` (`lease`, required) Example: ```json { "leaseID": "2213", "propertyID": "406", "unitID": "391", "primaryLeaseStatusID": "1", "leaseStatusID": "21", "moveOutStatusID": "1", "assignedToUserID": null, "applicationID": null, "leaseDocumentTransactionID": null, "code": null, "moveInDate": "2026-05-01", "startDate": "2026-05-01", "endDate": "2027-04-30", "dateTimeCreated": "2026-04-22 10:00:00", "dateTimeModified": "2026-04-22 10:00:00", "lateFeeSettingID": null, "isPortalDisabled": "0", "isPortalPaymentDisabled": "0", "isCertifiedFundsRequired": "0", "isLateFeesActive": "1", "isLeaseAgreementViolated": "0", "tenantRefundPayoutTypeID": "1", "isFromImport": "0", "importSourceKey": null, "isTenantPastDueNoticeEnabled": "0", "isAutoClosed": "0", "isPublicStatementEnabled": "0", "isMarkedToVacate": "0" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Lease 2213 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Lease Status `POST /leases/{leaseID}/status` Operation ID: `updateLeaseStatus` Updates the status of an existing lease. On success the endpoint internally forwards to `GET /leases/{leaseID}` and returns the full lease detail. ##### Use Cases - Adjusting a lease status ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist; a `400` is returned if not found - Portfolio restrictions apply — users can only update leases within their accessible portfolios - `leaseStatusID` is the only required field; all other fields are optional and will be updated only when provided - `leaseStatusID` references custom statuses configured in the account (see `GET /leases/statuses`) ##### Related Endpoints - `GET /leases/{leaseID}` - Get full lease detail (same response shape as returned here) - `POST /leases/{leaseID}` - Update other lease fields (dates, settings, insurance info) - `GET /leases/statuses` - List available custom lease statuses Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `leaseStatusID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the custom lease status to assign. References the account-configured statuses from `GET /leases/statuses`. - `noticeDate` (string | null, date): Date the tenant gave notice to vacate. - `expectedMoveOutDate` (string | null, date): Expected date the tenant will move out. - `moveOutDate` (string | null, date): Actual date the tenant moved out. - `depositRefundDueDate` (string | null, date): Date by which the security deposit refund must be issued. - `closedDate` (string | null, date): Date the lease was closed. - `closedDescription` (string | null): Optional description or reason for closing the lease. - `isPortalPaymentDisabled` (string | integer | null, one of "0", "1", 0, 1, null): Whether portal payments are disabled for this lease (0 or 1). - `isTenantPastDueNoticeEnabled` (string | integer | null, one of "0", "1", 0, 1, null): Whether past-due notices are sent to tenants (0 or 1). Example: ```json { "leaseStatusID": 2 } ``` Responses: - `200`: Lease status updated successfully. Returns the full lease detail. - `application/json`: object - `lease` (`lease`, required) Example: ```json { "lease": { "leaseID": "2213", "propertyID": "406", "unitID": "391", "primaryLeaseStatusID": "2", "leaseStatusID": "2", "moveOutStatusID": "1", "assignedToUserID": "122188", "applicationID": null, "leaseDocumentTransactionID": null, "code": "test", "tenants": [ "John Tester", "Joe Michael" ], "moveInDate": "2025-03-05", "startDate": "2026-04-17", "endDate": "2026-10-17", "tenantLiabilityInsuranceProviderID": null, "tenantLiabilityInsuranceEffectiveDate": null, "rentersInsuranceCompany": "rentersInsuranceCompany", "rentersInsurancePolicyNumber": "111222333-4", "rentersInsuranceExpirationDate": "2028-02-03", "rentersInsuranceFileID": null, "leaseFeeTransactionID": null, "leaseFeeBillID": null, "dateTimeCreated": "2025-03-06 17:04:46", "dateTimeModified": "2026-04-21 20:44:34", "lateFeeSettingID": "87", "isPortalDisabled": "0", "isPortalPaymentDisabled": "0", "isCertifiedFundsRequired": "0", "isLateFeesActive": "1", "allowedPaymentAmountTypeID": "1", "isAchDisabled": "0", "isCreditCardDisabled": "1", "isCashDisabled": "0", "closedDate": "2026-04-21", "closedDescription": "test 1", "noticeDate": "2025-03-21", "expectedMoveOutDate": "2025-08-05", "moveOutDate": "2025-08-05", "depositRefundDueDate": "2026-04-21", "leaseReturnChargeAmount": "35.00", "moveOutReasonID": "8", "moveOutUnitAvailabilityDate": null, "moveOutTenantRemarks": null, "moveOutLeaseTenantID": null, "isLeaseAgreementViolated": "0", "forwardingName": null, "forwardingCountryID": "US", "forwardingAddress": null, "forwardingAddress2": null, "forwardingCity": null, "forwardingStateID": "FL", "forwardingPostalCode": null, "forwardingEmail": null, "forwardingPhone": null, "moveOutTenantReason": null, "tenantRefundPayoutTypeID": "1", "statementSettingID": "1", "sendStatements": "1", "isFromImport": "0", "importSourceKey": null, "isTenantPastDueNoticeEnabled": "1", "rentvineInsuranceEnrollmentID": null, "rentvineInsuranceEnrollmentStatusID": null, "rentvineInsurancePackageID": null, "rentvineInsuranceRecurringChargeID": null, "rentvineInsuranceChargeID": null, "leaseActivationOptionID": "3", "increaseEligibilityDate": "2028-03-05", "isAutoClosed": "0", "isPublicStatementEnabled": "1", "isMarkedToVacate": "0", "rentAmount": 100 } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Lease Tenants `GET /leases/{leaseID}/tenants` Operation ID: `listLeaseTenants` Returns all tenants associated with a lease, each as a pair of `leaseTenant` and `contact` objects. Portal access data (`hasPortalAccess`, `hasPortalInvitation`, `invitationDateTimeCreated`, `hasApplicantUser`) is always included. ##### Use Cases - Displaying a list of current and past tenants for a lease - Checking whether a tenant has portal access or a pending invitation ##### Business Rules - The lease must be within the user's accessible portfolios; a `400` is returned otherwise - Results are ordered: active first, primary first, then by `orderIndex`, then by `leaseTenantID` - When `isActive` is omitted, both active and inactive tenants are returned - Portal data is always computed inline (not an opt-in include) ##### Related Endpoints - `POST /leases/{leaseID}/tenants` - Add a tenant to the lease - `DELETE /leases/{leaseID}/tenants/{leaseTenantID}` - Remove a tenant from the lease Parameters: - `leaseID` (path, integer, required) - `isActive` (query, integer, one of 0, 1): Filter by active status. `1` returns only active tenants, `0` returns only inactive tenants. Omit to return all. Responses: - `200`: Successfully retrieved lease tenants. - `application/json`: object[] - Each item: - `leaseTenant` (object, required) - `leaseTenantID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the lease tenant record. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this tenant belongs to. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the linked contact record. - `isPrimary` (string, required, one of "0", "1"): Whether this tenant is the primary tenant on the lease (`1` = yes, `0` = no). - `isCosigner` (string, required, one of "0", "1"): Whether this tenant is a co-signer (`1` = yes, `0` = no). - `isActive` (string, required, one of "0", "1"): Whether the lease tenant is active (`1` = active, `0` = inactive). - `moveInDate` (string | null, date): Date the tenant moved in. - `moveOutDate` (string | null, date): Date the tenant moved out. Null for active tenants. - `leaseTenantCashCardID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the active tenant cash card associated with this lease tenant, if any. - `contact` (object, required) - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the contact. - `contactTypeID` (string, required, read-only, pattern `^-?[0-9]+$`): Type of contact. Lease tenants always have type `2`. * `2` - Tenant - `name` (string, required): Full name of the contact. - `email` (string | null, email): Primary email address of the contact. - `phone` (string | null): Primary phone number of the contact in E.164 format. - `birthDate` (string | null, date): Date of birth of the contact. - `applicantID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the screening applicant linked to this contact, if any. - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`): Type of government-issued ID on file. - `identificationNumber` (string | null): Government-issued ID number. - `identificationIssuingLocation` (string | null): State or country that issued the ID. - `identificationExpirationDate` (string | null, date): Expiration date of the government-issued ID. - `identificationCountryID` (string | null): Country associated with the identification document. - `taxIdentifierTruncated` (string | null, read-only): Last 4 digits of the decrypted tax identifier (SSN/EIN), if on file. - `hasPortalAccess` (integer, required): Whether the tenant has an active resident portal account (`1` = yes, `0` = no). - `hasPortalInvitation` (integer, required): Whether the tenant has a pending (non-expired) portal invitation (`1` = yes, `0` = no). - `invitationDateTimeCreated` (string | null, date-time, read-only): Timestamp when the portal invitation was created. Null when no pending invitation exists. - `hasApplicantUser` (integer, required): Whether the tenant's linked applicant has an associated user account (`1` = yes, `0` = no). Example: ```json [ { "leaseTenant": { "leaseTenantID": "2375", "leaseID": "2213", "contactID": "338", "isPrimary": "1", "isCosigner": "0", "isActive": "1", "moveInDate": "2025-03-05", "moveOutDate": null, "leaseTenantCashCardID": null }, "contact": { "contactID": "338", "contactTypeID": "2", "name": "John Tester", "email": "john.tester@email.com", "phone": "+12398877354", "birthDate": null, "applicantID": null, "identificationTypeID": null, "identificationNumber": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "identificationCountryID": null, "taxIdentifierTruncated": null, "hasPortalAccess": 1, "hasPortalInvitation": 0, "invitationDateTimeCreated": null, "hasApplicantUser": 0 } }, { "leaseTenant": { "leaseTenantID": "3013", "leaseID": "2213", "contactID": "988", "isPrimary": "0", "isCosigner": "0", "isActive": "1", "moveInDate": "2025-10-08", "moveOutDate": null, "leaseTenantCashCardID": null }, "contact": { "contactID": "988", "contactTypeID": "2", "name": "Joe Michael", "email": "joe2@yahoo.com", "phone": null, "birthDate": "1990-03-05", "applicantID": "195", "identificationTypeID": null, "identificationNumber": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "identificationCountryID": null, "taxIdentifierTruncated": "4444", "hasPortalAccess": 0, "hasPortalInvitation": 0, "invitationDateTimeCreated": null, "hasApplicantUser": 0 } } ] ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Lease 2213: Access Denied" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Add Tenant to Lease `POST /leases/{leaseID}/tenants` Operation ID: `createLeaseTenant` Adds a new tenant to an existing lease. You can either link an existing contact by providing `contactID`, or create a brand-new tenant contact by supplying `name`, `emails`, `phones`, and/or `addresses`. On success the endpoint internally forwards to `GET /leases/{leaseID}/tenants/{leaseTenantID}` and returns the full tenant detail. ##### Use Cases - Adding a new tenant to an active lease mid-term - Linking an existing tenant contact to a lease they will now occupy - Recording a co-signer who is financially responsible but not a primary tenant ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist and be within the user's accessible portfolios; a `400` is returned otherwise - Cannot add a tenant to a lease in `Closed` status (`primaryLeaseStatusID = 3`) - If `contactID` is omitted or empty, a new contact is created using `name` (required), plus optional `emails`, `phones`, and `addresses` - If `contactID` is provided, the existing contact is linked directly — `name`, `emails`, `phones`, and `addresses` are ignored - The linked or newly-created contact must be of type `Tenant` (`contactTypeID = 2`) and must be active - A contact can only appear once on a given lease — duplicate assignments return a `400` - `moveInDate` is required ##### Related Endpoints - `GET /leases/{leaseID}/tenants` - List all tenants on the lease - `GET /leases/{leaseID}/tenants/{leaseTenantID}` - Get a single tenant (same response shape returned here) - `DELETE /leases/{leaseID}/tenants/{leaseTenantID}` - Remove a tenant from the lease Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `moveInDate` (string, date, required): Date the tenant moves in. Required. - `contactID` (string | integer | null, pattern `^-?[0-9]+$`): ID of an existing contact to link to the lease. When provided, the contact must already be of type Tenant and be active. If omitted or null, a new tenant contact is created using `name`, `emails`, `phones`, and `addresses`. - `name` (string, required): Full name of the new tenant contact. Required when `contactID` is not provided. - `email` (object[]): Email addresses to attach to the new tenant contact. Ignored when `contactID` is provided. - `email` (string, email, required): Email address. - `phone` (object[]): Phone numbers to attach to the new tenant contact. Ignored when `contactID` is provided. - `phone` (string, required): Phone number in E.164 format. - `phoneTypeID` (string | integer, pattern `^-?[0-9]+$`): ID of the phone type (e.g. `1` = mobile, `2` = home, `3` = work). - `addresses` (object[]): Addresses to attach to the new tenant contact. Ignored when `contactID` is provided. - `address` (string, required): Street address. Example: ```json { "moveInDate": "2026-04-21", "isCosigner": 0, "name": "Testing Doc", "emails": [ { "email": "testingdoc@email.com" } ], "phones": [ { "phone": "+12399995555", "phoneTypeID": "1" } ] } ``` Responses: - `200`: Tenant added to lease successfully. Returns the new lease tenant and the associated contact. - `application/json`: object - `leaseTenant` (object, required): The newly created lease tenant record. - `leaseTenantID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the lease tenant record. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this tenant belongs to. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the linked contact record. - `isPrimary` (string, required, one of "0", "1"): Whether this tenant is the primary tenant on the lease (0 or 1). - `isCosigner` (string, required, one of "0", "1"): Whether this tenant is a co-signer (0 or 1). - `isActive` (string, required, one of "0", "1"): Whether the lease tenant is active (0 or 1). Always `1` on creation. - `moveInDate` (string | null, date): Date the tenant moved in. - `moveOutDate` (string | null, date): Date the tenant moved out. Null for active tenants. - `leaseTenantCashCardID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the active tenant cash card associated with this lease tenant, if any. - `contact` (object, required): The contact record for the tenant. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the contact. - `contactTypeID` (string, required, read-only, pattern `^-?[0-9]+$`): Type of contact. Lease tenants always have type `2`. * `2` - Tenant - `name` (string, required): Full name of the contact. - `email` (string | null, email): Primary email address of the contact. - `phone` (string | null): Primary phone number of the contact. - `birthDate` (string | null, date): Date of birth of the contact. - `applicantID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the screening applicant linked to this contact, if any. - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`): Type of government-issued ID on file. - `identificationNumber` (string | null): Government-issued ID number. - `identificationIssuingLocation` (string | null): State or country that issued the ID. - `identificationExpirationDate` (string | null, date): Expiration date of the government-issued ID. - `identificationCountryID` (string | null): Country associated with the identification document. - `taxIdentifierTruncated` (string | null, read-only): Last 4 digits of the decrypted tax identifier (SSN/EIN), if on file. Always null for newly created contacts. Example: ```json { "leaseTenant": { "leaseTenantID": "3389", "leaseID": "2213", "contactID": "5244", "isPrimary": "0", "isCosigner": "0", "isActive": "1", "moveInDate": "2026-04-21", "moveOutDate": null, "leaseTenantCashCardID": null }, "contact": { "contactID": "5244", "contactTypeID": "2", "name": "Testing Doc", "email": "testingdoc@email.com", "phone": "+12399995555", "birthDate": null, "applicantID": null, "identificationTypeID": null, "identificationNumber": null, "identificationIssuingLocation": null, "identificationExpirationDate": null, "identificationCountryID": null, "taxIdentifierTruncated": null } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Remove Tenant from Lease `DELETE /leases/{leaseID}/tenants/{leaseTenantID}` Operation ID: `deleteLeaseTenant` Removes a tenant from a lease. On success, returns the deleted lease tenant record as it existed at time of deletion. ##### Use Cases - Removing a tenant who no longer occupies the unit - Correcting a mistakenly added tenant before any accounting activity ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist and be within the user's accessible portfolios; a `400` is returned otherwise - The `leaseTenantID` must belong to the specified `leaseID`; a `400` is returned if the lease tenant is not found - The lease must have at least one active tenant; a `400` is returned if the lease has no active tenants ##### Related Endpoints - `GET /leases/{leaseID}/tenants` - List all tenants on the lease - `GET /leases/{leaseID}/tenants/{leaseTenantID}` - Get a single tenant detail - `POST /leases/{leaseID}/tenants` - Add a tenant to the lease Parameters: - `leaseID` (path, integer, required) - `leaseTenantID` (path, integer, required): The `leaseTenantID` of the tenant record to remove. Responses: - `200`: Tenant removed from lease successfully. Returns the deleted lease tenant record. - `application/json`: object - `leaseTenantID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the lease tenant record. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this tenant belonged to. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the linked contact record. - `isPrimary` (string, required, one of "0", "1"): Whether this tenant was the primary tenant on the lease (`1` = yes, `0` = no). - `isCosigner` (string, required, one of "0", "1"): Whether this tenant was a co-signer (`1` = yes, `0` = no). - `isActive` (string, required, one of "0", "1"): Active status at time of deletion (`1` = active, `0` = inactive). - `moveInDate` (string | null, date): Date the tenant moved in. - `moveOutDate` (string | null, date): Date the tenant moved out. Null for active tenants. - `orderIndex` (string | null, pattern `^-?[0-9]+$`): Display order index for the tenant on the lease. Example: ```json { "leaseTenantID": "3391", "leaseID": "2213", "contactID": "5246", "isPrimary": "0", "isCosigner": "0", "isActive": "1", "moveInDate": "2026-05-01", "moveOutDate": null, "orderIndex": "4" } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Lease Tenant not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Recurring Charges `GET /leases/{leaseID}/recurring-charges` Operation ID: `listLeaseRecurringCharges` Returns a paginated list of recurring charges for a lease. Each item includes the `recurringCharge` record and the associated `account` (chart-of-accounts entry). The `account` is always included — no additional `includes` parameter is needed. ##### Use Cases - Displaying all recurring charges on a lease detail page ##### Business Rules - The lease must be within the user's accessible portfolios; a `400` is returned otherwise - The `account` is always present in each list item — it cannot be excluded - `recurringStatusID` is **not** included in list items — use `GET /leases/{leaseID}/recurring-charges/{chargeID}` to get the computed status for a specific charge ##### Related Endpoints - `GET /leases/{leaseID}/recurring-charges/{chargeID}` - Get a single recurring charge with computed status - `POST /leases/{leaseID}/recurring-charges` - Create a new recurring charge Parameters: - `leaseID` (path, integer, required): The lease whose recurring charges to list. Responses: - `200`: Successfully retrieved recurring charges. - `application/json`: object[] - Each item: - `recurringCharge` (object, required) - `leaseRecurringChargeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring charge. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this charge belongs to. - `rentIncreaseID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the rent increase that created this charge, if any. - `accountID` (string, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against. - `amount` (string, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge as it appears on statements and reports. - `dayDue` (string, required, pattern `^-?[0-9]+$`): Day of the month on which charge transactions are generated. - `frequency` (string, required, pattern `^-?[0-9]+$`): Number of months between charge occurrences. - `startDate` (string, date, required): Date the charge begins appearing on reports. - `endDate` (string | null, date): Date the charge stops being generated. Null means open-ended. - `nextChargeDate` (string | null, date, read-only): Next date a charge transaction will be generated. - `isMoveInCharge` (string, required, one of "0", "1"): Whether this charge was created as a move-in charge (`1` = yes, `0` = no). - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this charge was created via import (`1` = yes, `0` = no). - `importSourceKey` (string | null, read-only): Import source key if the charge came from an import, otherwise null. - `account` (`account-2`, required) Example: ```json [ { "recurringCharge": { "leaseRecurringChargeID": "11546", "leaseID": "2213", "rentIncreaseID": null, "accountID": "9", "amount": "100.00", "description": "Monthly Rent", "dayDue": "1", "frequency": "1", "startDate": "2026-01-01", "endDate": "2027-03-04", "nextChargeDate": "2026-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null }, "account": { "accountID": "9", "parentAccountID": null, "accountTypeID": "7", "accountCategoryID": "7", "number": "4000", "name": "Rent Income", "isActive": "1", "isSubjectToManagementFees": "1", "isSubjectToLateFees": "1", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "1", "isSubsidized": "0", "isTaxable": "1", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "0", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "1", "isHeld": "0", "bankName": null, "bankAccountTypeID": null, "bankAccountCiphertextID": null, "bankAccountNumberTruncated": null, "bankAccountAddress": null, "bankAccountAddress2": null, "bankAccountCity": null, "bankAccountStateID": null, "bankAccountPostalCode": null, "bankAccountCountryID": null, "isCheckingEnabled": "0", "checkCompanyName": null, "checkSignatory": null, "checkAddress": null, "checkAddress2": null, "checkCity": null, "checkStateID": null, "checkPostalCode": null, "checkCountryID": null, "bankAccountNextCheckNumber": null, "bankAccountNextDepositNumber": null, "checkTemplateID": null, "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "1", "importSourceKey": "4100", "isNachaEnabled": "0", "isNachaFileBalanced": "0", "nachaOriginName": null, "nachaOriginNumber": null, "nachaDestinationName": null, "nachaDestinationNumber": null, "nachaCompanyIdentification": null, "nachaCompanyName": null, "nachaOriginatingFinancialInstitutionID": null, "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2023-01-14 18:39:10", "dateTimeModified": "2026-02-19 16:14:12", "dateTimeDeactivated": null } }, { "recurringCharge": { "leaseRecurringChargeID": "11547", "leaseID": "2213", "rentIncreaseID": null, "accountID": "122", "amount": "10.00", "description": "RBP Fee", "dayDue": "1", "frequency": "1", "startDate": "2026-01-01", "endDate": null, "nextChargeDate": "2026-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null }, "account": { "accountID": "122", "parentAccountID": null, "accountTypeID": "7", "accountCategoryID": null, "number": "4800", "name": "RBP Income", "isActive": "1", "isSubjectToManagementFees": "0", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "1", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": null, "bankAccountTypeID": null, "bankAccountCiphertextID": null, "bankAccountNumberTruncated": null, "bankAccountAddress": null, "bankAccountAddress2": null, "bankAccountCity": null, "bankAccountStateID": null, "bankAccountPostalCode": null, "bankAccountCountryID": null, "isCheckingEnabled": "0", "checkCompanyName": null, "checkSignatory": null, "checkAddress": null, "checkAddress2": null, "checkCity": null, "checkStateID": null, "checkPostalCode": null, "checkCountryID": null, "bankAccountNextCheckNumber": null, "bankAccountNextDepositNumber": null, "checkTemplateID": null, "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "0", "isNachaFileBalanced": "0", "nachaOriginName": null, "nachaOriginNumber": null, "nachaDestinationName": null, "nachaDestinationNumber": null, "nachaCompanyIdentification": null, "nachaCompanyName": null, "nachaOriginatingFinancialInstitutionID": null, "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2024-02-22 19:10:02", "dateTimeModified": "2024-02-22 19:10:02", "dateTimeDeactivated": null } } ] ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Lease 2213: Access Denied" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Recurring Charge `POST /leases/{leaseID}/recurring-charges` Operation ID: `createLeaseRecurringCharge` Creates a new recurring charge on a lease. On success the endpoint internally forwards to `GET /leases/{leaseID}/recurring-charges/{chargeID}` and returns the full charge detail along with the previous charge on the lease. ##### Use Cases - Adding a new monthly rent charge to a lease - Setting up recurring fees (e.g. pet fees, parking) that begin on a future date - Creating a time-bounded charge that expires before the lease ends ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease must exist and be within the user's accessible portfolios; a `400` is returned otherwise - `accountID` must reference a valid chart-of-account entry of a charge type - `startDate` is the date the charge appears on reports such as the Rent Roll; accepted as `MM/DD/YYYY` - `dayDue` is the day of the month (1–31) on which recurring charge transactions are generated - `frequency` is the number of months between charge occurrences; defaults to `1` (monthly) - `endDate` is optional — leaving it blank causes the charge to continue until the lease reaches a Primary Closed Status ##### Related Endpoints - `GET /leases/{leaseID}/recurring-charges` - List all recurring charges for the lease - `GET /leases/{leaseID}/recurring-charges/{chargeID}` - Get a single recurring charge (same response shape returned here) - `POST /leases/{leaseID}/recurring-charges/{chargeID}` - Update an existing recurring charge - `DELETE /leases/{leaseID}/recurring-charges/{chargeID}` - Delete a recurring charge Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `accountID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the chart-of-account entry to post the charge against. Must be a charge-type account. - `amount` (string | number, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge as it appears on statements and reports. - `dayDue` (string | integer, required, minimum 1, maximum 31, pattern `^-?[0-9]+$`): Day of the month (1–31) on which charge transactions are generated. - `frequency` (string | integer, required, default "1", minimum 1, maximum 24, pattern `^-?[0-9]+$`): Number of months between charge occurrences. Use `1` for monthly, `3` for quarterly, etc. - `startDate` (string, required): Date the charge begins appearing on reports such as the Rent Roll. Accepted format is `MM/DD/YYYY`. - `endDate` (string | null): Date the charge stops being generated. Accepted format is `MM/DD/YYYY`. Leave blank (omit) to continue the charge until the lease reaches a Primary Closed Status. Example: ```json { "dayDue": 1, "frequency": 1, "accountID": "16", "amount": "1500.00", "description": "Monthly Rent", "startDate": "04/20/2027", "endDate": "04/12/2028" } ``` Responses: - `200`: Recurring charge created successfully. Returns the new charge and the previous charge on the lease. - `application/json`: object - `recurringCharge` (object, required): The newly created recurring charge. - `leaseRecurringChargeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring charge. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this charge belongs to. - `rentIncreaseID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the rent increase that created this charge, if any. - `accountID` (string, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against. - `amount` (string, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge. - `dayDue` (string, required, pattern `^-?[0-9]+$`): Day of the month on which charge transactions are generated. - `frequency` (string, required, pattern `^-?[0-9]+$`): Number of months between charge occurrences. - `startDate` (string, date, required): Date the charge begins appearing on reports. - `endDate` (string | null, date): Date the charge stops being generated. Null means open-ended (until lease closes). - `nextChargeDate` (string | null, date, read-only): Next date a charge transaction will be generated. - `isMoveInCharge` (string, required, one of "0", "1"): Whether this charge was created as a move-in charge (0 or 1). - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this charge was created via import (0 or 1). - `importSourceKey` (string | null, read-only): Import source key if the charge came from an import, otherwise null. - `recurringStatusID` (integer, required, read-only, one of 1, 2, 3): Computed status of the recurring charge based on start date, end date, and next charge date. * `1` - Current * `2` - Future * `3` - Past - `previousCharge` (object | null): The previous recurring charge on this lease (immediately before the new one), if any. Does not include `recurringStatusID`. - `leaseRecurringChargeID` (string, read-only, pattern `^-?[0-9]+$`) - `leaseID` (string, read-only, pattern `^-?[0-9]+$`) - `rentIncreaseID` (string | null, pattern `^-?[0-9]+$`) - `accountID` (string, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `description` (string) - `dayDue` (string, pattern `^-?[0-9]+$`) - `frequency` (string, pattern `^-?[0-9]+$`) - `startDate` (string, date) - `endDate` (string | null, date) - `nextChargeDate` (string | null, date) - `isMoveInCharge` (string, one of "0", "1") - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) Example: ```json { "recurringCharge": { "leaseRecurringChargeID": "12012", "leaseID": "2213", "rentIncreaseID": null, "accountID": "16", "amount": "100.00", "description": "More Rent", "dayDue": "1", "frequency": "1", "startDate": "2027-04-20", "endDate": "2028-04-12", "nextChargeDate": "2027-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null, "recurringStatusID": 2 }, "previousCharge": { "leaseRecurringChargeID": "11950", "leaseID": "2213", "rentIncreaseID": null, "accountID": "9", "amount": "200.00", "description": "Base Rent", "dayDue": "1", "frequency": "1", "startDate": "2027-03-05", "endDate": null, "nextChargeDate": "2027-04-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Recurring Charge `GET /leases/{leaseID}/recurring-charges/{chargeID}` Operation ID: `getLeaseRecurringCharge` Returns a single recurring charge with its computed `recurringStatusID` and the previous charge on the lease (if one exists). ##### Use Cases - Displaying full detail for a specific recurring charge - Checking whether a charge is currently active, future, or past - Reviewing the prior charge that this one superseded ##### Business Rules - The lease must be within the user's accessible portfolios; a `400` is returned otherwise - If the recurring charge does not belong to the specified lease, a `400` is returned - `account` is only included when `includes=account` is passed ##### Related Endpoints - `GET /leases/{leaseID}/recurring-charges` - List all recurring charges for the lease - `POST /leases/{leaseID}/recurring-charges/{chargeID}` - Update this recurring charge - `DELETE /leases/{leaseID}/recurring-charges/{chargeID}` - Delete this recurring charge Parameters: - `leaseID` (path, integer, required) - `chargeID` (path, integer, required): The `leaseRecurringChargeID` of the recurring charge to retrieve. - `includes` (query, string): Comma-separated list of related data to include in the response. * `account` - the full chart-of-accounts entry for the account this charge posts against Responses: - `200`: Successfully retrieved recurring charge. - `application/json`: object - `recurringCharge` (object, required) - `leaseRecurringChargeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring charge. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this charge belongs to. - `rentIncreaseID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the rent increase that created this charge, if any. - `accountID` (string, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against. - `amount` (string, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge as it appears on statements and reports. - `dayDue` (string, required, pattern `^-?[0-9]+$`): Day of the month on which charge transactions are generated. - `frequency` (string, required, pattern `^-?[0-9]+$`): Number of months between charge occurrences. - `startDate` (string, date, required): Date the charge begins appearing on reports. - `endDate` (string | null, date): Date the charge stops being generated. Null means open-ended. - `nextChargeDate` (string | null, date, read-only): Next date a charge transaction will be generated. - `isMoveInCharge` (string, required, one of "0", "1"): Whether this charge was created as a move-in charge (`1` = yes, `0` = no). - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this charge was created via import (`1` = yes, `0` = no). - `importSourceKey` (string | null, read-only): Import source key if the charge came from an import, otherwise null. - `recurringStatusID` (integer, required, read-only, one of 1, 2, 3): Computed status of the recurring charge based on `startDate`, `endDate`, and `nextChargeDate`. * `1` - Current * `2` - Future * `3` - Past - `previousCharge` (object | null, required): The previous recurring charge on this lease (highest `leaseRecurringChargeID` below this one), or null if this is the first charge. Does not include `recurringStatusID`. - `leaseRecurringChargeID` (string, read-only, pattern `^-?[0-9]+$`) - `leaseID` (string, read-only, pattern `^-?[0-9]+$`) - `rentIncreaseID` (string | null, pattern `^-?[0-9]+$`) - `accountID` (string, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `description` (string) - `dayDue` (string, pattern `^-?[0-9]+$`) - `frequency` (string, pattern `^-?[0-9]+$`) - `startDate` (string, date) - `endDate` (string | null, date) - `nextChargeDate` (string | null, date) - `isMoveInCharge` (string, one of "0", "1") - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) - `account` (`account-2`): The chart-of-accounts entry for this charge (if `includes=account`). Example: ```json { "recurringCharge": { "leaseRecurringChargeID": "11546", "leaseID": "2213", "rentIncreaseID": null, "accountID": "9", "amount": "100.00", "description": "Monthly Rent", "dayDue": "1", "frequency": "1", "startDate": "2026-01-01", "endDate": "2027-03-04", "nextChargeDate": "2026-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null, "recurringStatusID": 1 }, "previousCharge": null } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Recurring Charge 11546 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Recurring Charge `POST /leases/{leaseID}/recurring-charges/{chargeID}` Operation ID: `updateLeaseRecurringCharge` Updates an existing recurring charge on a lease. Only include the fields you want to change — fields omitted from the request body retain their current values. Fields cannot be set to `null` via this endpoint. On success the endpoint internally forwards to `GET /leases/{leaseID}/recurring-charges/{chargeID}` and returns the full charge detail along with the previous charge on the lease. ##### Use Cases - Adjusting the amount on an existing rent charge - Changing the end date of a time-bounded charge - Updating the chart-of-account a charge posts against ##### Business Rules - Requires `Update Lease` permission under the Leasing component - The lease and recurring charge must both exist; a `400` is returned if either is not found - Portfolio restrictions apply — users can only update charges on leases within their accessible portfolios - Fields cannot be explicitly set to `null`; omit a field to leave it unchanged - `startDate` and `endDate` are accepted as `MM/DD/YYYY` in the request ##### Related Endpoints - `POST /leases/{leaseID}/recurring-charges` - Create a new recurring charge (use this to get the `chargeID`) - `GET /leases/{leaseID}/recurring-charges` - List all recurring charges for the lease - `DELETE /leases/{leaseID}/recurring-charges/{chargeID}` - Delete this recurring charge Parameters: - `leaseID` (path, integer, required) - `chargeID` (path, integer, required): The `leaseRecurringChargeID` of the recurring charge to update. Obtain this from `POST /leases/{leaseID}/recurring-charges` or `GET /leases/{leaseID}/recurring-charges`. Request body, required: - `application/json`: object - `accountID` (string | integer, pattern `^-?[0-9]+$`): ID of the chart-of-account entry to post the charge against. Must be a charge-type account. - `amount` (string | number, decimal): Charge amount as a decimal string. - `description` (string): Label for the charge as it appears on statements and reports. - `dayDue` (string | integer, pattern `^-?[0-9]+$`): Day of the month (1–31) on which charge transactions are generated. - `frequency` (string | integer, pattern `^-?[0-9]+$`): Number of months between charge occurrences. Use `1` for monthly, `3` for quarterly, etc. - `startDate` (string): Date the charge begins appearing on reports such as the Rent Roll. Accepted format is `MM/DD/YYYY`. - `endDate` (string): Date the charge stops being generated. Accepted format is `MM/DD/YYYY`. To keep the charge open-ended, omit this field rather than sending `null`. Example: ```json { "amount": "120.00" } ``` Responses: - `200`: Recurring charge updated successfully. Returns the updated charge and the previous charge on the lease. - `application/json`: object - `recurringCharge` (object, required): The updated recurring charge. - `leaseRecurringChargeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring charge. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this charge belongs to. - `rentIncreaseID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the rent increase that created this charge, if any. - `accountID` (string, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against. - `amount` (string, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge. - `dayDue` (string, required, pattern `^-?[0-9]+$`): Day of the month on which charge transactions are generated. - `frequency` (string, required, pattern `^-?[0-9]+$`): Number of months between charge occurrences. - `startDate` (string, date, required): Date the charge begins appearing on reports. - `endDate` (string | null, date): Date the charge stops being generated. Null means open-ended (until lease closes). - `nextChargeDate` (string | null, date, read-only): Next date a charge transaction will be generated. - `isMoveInCharge` (string, required, one of "0", "1"): Whether this charge was created as a move-in charge (0 or 1). - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this charge was created via import (0 or 1). - `importSourceKey` (string | null, read-only): Import source key if the charge came from an import, otherwise null. - `recurringStatusID` (integer, required, read-only, one of 1, 2, 3): Computed status of the recurring charge based on start date, end date, and next charge date. * `1` - Current * `2` - Future * `3` - Past - `previousCharge` (object | null): The previous recurring charge on this lease (immediately before this one), if any. Does not include `recurringStatusID`. - `leaseRecurringChargeID` (string, read-only, pattern `^-?[0-9]+$`) - `leaseID` (string, read-only, pattern `^-?[0-9]+$`) - `rentIncreaseID` (string | null, pattern `^-?[0-9]+$`) - `accountID` (string, pattern `^-?[0-9]+$`) - `amount` (string, decimal) - `description` (string) - `dayDue` (string, pattern `^-?[0-9]+$`) - `frequency` (string, pattern `^-?[0-9]+$`) - `startDate` (string, date) - `endDate` (string | null, date) - `nextChargeDate` (string | null, date) - `isMoveInCharge` (string, one of "0", "1") - `isFromImport` (string, one of "0", "1") - `importSourceKey` (string | null) Example: ```json { "recurringCharge": { "leaseRecurringChargeID": "12012", "leaseID": "2213", "rentIncreaseID": null, "accountID": "16", "amount": "120.00", "description": "More Rent", "dayDue": "1", "frequency": "1", "startDate": "2027-04-20", "endDate": "2028-04-12", "nextChargeDate": "2027-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null, "recurringStatusID": 2 }, "previousCharge": { "leaseRecurringChargeID": "11950", "leaseID": "2213", "rentIncreaseID": null, "accountID": "9", "amount": "200.00", "description": "Base Rent", "dayDue": "1", "frequency": "1", "startDate": "2027-03-05", "endDate": null, "nextChargeDate": "2027-04-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null } } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Recurring Charge `DELETE /leases/{leaseID}/recurring-charges/{chargeID}` Operation ID: `deleteLeaseRecurringCharge` Permanently deletes a recurring charge from a lease. On success, returns the deleted recurring charge record as it existed at time of deletion. ##### Use Cases - Removing a charge that was added in error - Deleting a charge whose schedule has been superseded by a new one ##### Business Rules - Requires `Update Lease` permission under the Leasing component - Portfolio restrictions apply — users can only delete recurring charges on leases within their accessible portfolios - The recurring charge must exist and belong to the specified lease; a `400` is returned if not found - This operation is permanent — use `POST /leases/{leaseID}/recurring-charges/{chargeID}` to set an `endDate` instead if you want to stop future postings while preserving history ##### Related Endpoints - `GET /leases/{leaseID}/recurring-charges/{chargeID}` - Get the charge detail before deleting - `GET /leases/{leaseID}/recurring-charges` - List all recurring charges for the lease - `POST /leases/{leaseID}/recurring-charges/{chargeID}` - Update the charge (e.g. set an end date) Parameters: - `leaseID` (path, integer, required) - `chargeID` (path, integer, required): The `leaseRecurringChargeID` of the recurring charge to delete. Responses: - `200`: Recurring charge deleted successfully. Returns the deleted recurring charge record. - `application/json`: object - `leaseRecurringChargeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the recurring charge. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the lease this charge belonged to. - `rentIncreaseID` (string | null, read-only, pattern `^-?[0-9]+$`): ID of the rent increase that created this charge, if any. - `accountID` (string, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posted against. - `amount` (string, decimal, required): Charge amount as a decimal string. - `description` (string, required): Label for the charge as it appeared on statements and reports. - `dayDue` (string, required, pattern `^-?[0-9]+$`): Day of the month on which charge transactions were generated. - `frequency` (string, required, pattern `^-?[0-9]+$`): Number of months between charge occurrences. - `startDate` (string, date, required): Date the charge began appearing on reports. - `endDate` (string | null, date): Date the charge was scheduled to stop. Null means it was open-ended. - `nextChargeDate` (string | null, date, read-only): Next charge date at time of deletion. - `isMoveInCharge` (string, required, one of "0", "1"): Whether this charge was created as a move-in charge (`1` = yes, `0` = no). - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this charge was created via import (`1` = yes, `0` = no). - `importSourceKey` (string | null, read-only): Import source key if the charge came from an import, otherwise null. Example: ```json { "leaseRecurringChargeID": "12012", "leaseID": "2213", "rentIncreaseID": null, "accountID": "16", "amount": "120.00", "description": "More Rent", "dayDue": "1", "frequency": "1", "startDate": "2027-04-20", "endDate": "2028-04-12", "nextChargeDate": "2027-05-01", "isMoveInCharge": "0", "isFromImport": "0", "importSourceKey": null } ``` - `400`: Bad request - `application/json`: object - `error` (string) Example: ```json { "error": "Recurring Charge 12012 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Lease Pets `GET /leases/{leaseID}/pets` Operation ID: `listLeasePets` Lists the pets on one lease, sorted by name, one page at a time. Each item wraps the pet under `pet`, beside a `token` the search adds. ##### Use Cases - Show the animals living at a lease's unit - Find a lease's pet by part of its name before updating or removing it ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets a 403 `Lease {leaseID}: Access Denied` for a lease whose property is outside those groups' portfolios. - A well-formed `leaseID` with no lease answers 200 with an empty list (a restricted key gets the 403 above instead); a value that isn't a number answers the stock 404. `leaseID` `0` is the exception: for a key with no portfolio restrictions it isn't read as a filter, so it lists every pet on the account. - `search` matches any part of the pet's name (not its type); without it every pet of the lease is listed. The value is HTML-escaped before matching, so a name holding `'`, `"`, `&`, `<` or `>` can't be found, and `%` and `_` act as wildcards. - Pets with the same name have no tie-breaker, so across pages they can repeat or be skipped. - Sorted by name, pets with no name first. ##### Related Endpoints - `GET /leases/{leaseID}/pets/{leasePetID}` - get one pet - `POST /leases/{leaseID}/pets` - add a pet to the lease - `GET /leases/{leaseID}` - the lease Parameters: - `leaseID` (path, integer, required): The lease, from `GET /leases`. - `search` (query, string): Part of the pet's name, matched anywhere in it and in any case. - `page` (query, integer, default 1): Page number (default 1). `0` or a value that isn't a number is read as 1. A negative page returns the first page's items, but the pagination headers count from the page asked for (`page=-2` answers current page -2, next -1, previous -3). - `pageSize` (query, integer, default 15, minimum 1): Items per page (default 15). Values above 5000 are served at 5000. `0`, a negative value or one that isn't a number fails with a 500. Responses: - `200`: One page of the lease's pets - `application/json`: object[] - Each item: - `pet` (`lease_pet`, required) - `token` (string, required, pattern `^[0-9]+$`): The time of the request as a Unix timestamp, added by the search to every item. Carries no information about the pet. Example: ```json [ { "pet": { "leasePetID": "66", "leaseID": "60", "type": "Dog", "name": "Biscuit", "age": "4", "weight": "45 lbs", "isTrained": "1", "color": "Brown", "hasShots": "1", "isNeutered": "1", "isDeclawed": "0", "isEmotionalSupportAnimal": "0", "isServiceAnimal": "1", "gender": "Male", "dateTimeCreated": "2026-11-12 07:37:59", "petScreeningAnimalID": "88123" }, "token": "1794469079" } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` - `500`: A `pageSize` of 0 or less, or one that isn't a number. No body. #### Add Lease Pet `POST /leases/{leaseID}/pets` Operation ID: `createLeasePet` Adds a pet to the lease and returns it as `GET /leases/{leaseID}/pets/{leasePetID}` does, including any `includes` the request asks for. ##### Use Cases - Record an animal a tenant brings to the unit - Note whether a pet is a service or emotional support animal ##### Business Rules - Requires the **Update Lease** permission (`Leasing` › `UpdateLease`); without it the request is refused with `{"error": "Permission Denied"}`. - A user restricted to portfolio groups gets a 403 `Lease {leaseID}: Access Denied` for a lease whose property is outside those groups' portfolios. - An empty body or `{}` answers 400 `{"error": "invalid input."}`. - `type` is required and can't be empty or only spaces (`{"type": ["Type is required"]}`). `type`, `name`, `weight`, `color` and `gender` take up to 100 characters, and `age` digits only; each failure is a message under its field, all of them in one response. - A well-formed `leaseID` with no lease answers 400 `{"leaseID": ["Lease does not exist."]}` (a restricted key gets a 403 `Lease {leaseID}: Access Denied` instead); a value that isn't a number answers the stock 404. ##### Side Effects - Adds a `Pet Added` entry, naming the pet's type and name, to the lease's history log. - Stamps the lease's modified date in `GET /leases/export` (its `lease.dateTimeModified`, which that export reports and filters on) with now and the API user. The lease record's own `dateTimeModified`, as `GET /leases/{leaseID}` and the `lease` include send it, doesn't change. ##### Related Endpoints - `GET /leases/{leaseID}/pets` - list the lease's pets - `POST /leases/{leaseID}/pets/{leasePetID}` - update a pet - `GET /leases` - find the lease Parameters: - `leaseID` (path, integer, required): The lease to add the pet to, from `GET /leases`. - `includes` (query, string): `lease` adds the pet's lease to the response, as on `GET /leases/{leaseID}/pets/{leasePetID}`. Any other name is ignored. Request body, required: - `application/json`: combined object - All of: - Option 1: `lease_pet_request` - Option 2: object Example: ```json { "type": "Dog", "name": "Maple", "age": 3, "weight": "52 lbs", "color": "Golden", "gender": "Female", "hasShots": 1, "isTrained": 1, "isNeutered": 1, "isDeclawed": 0, "isEmotionalSupportAnimal": 0, "isServiceAnimal": 0 } ``` Responses: - `200`: The new pet - `application/json`: `lease_pet_detail` Example: ```json { "pet": { "leasePetID": "90", "leaseID": "81", "type": "Dog", "name": "Maple", "age": "3", "weight": "52 lbs", "isTrained": "1", "color": "Golden", "hasShots": "1", "isNeutered": "1", "isDeclawed": "0", "isEmotionalSupportAnimal": "0", "isServiceAnimal": "0", "gender": "Female", "dateTimeCreated": "2026-11-12 07:38:03", "petScreeningAnimalID": null } } ``` - `400`: see shared response `lease_pet_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Get Lease Pet `GET /leases/{leaseID}/pets/{leasePetID}` Operation ID: `getLeasePet` Returns one of the lease's pets under `pet`, plus the lease under `lease` when the `lease` include is asked for. ##### Use Cases - Show a pet's details on the lease - Load a pet before editing it ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets a 403 `Lease {leaseID}: Access Denied` for a lease whose property is outside those groups' portfolios. - A well-formed `leasePetID` with no pet, or a pet of another lease, answers 400 `{"error": "Pet {leasePetID} not found"}`; a value that isn't a number answers the stock 404. ##### Available Includes (1) - `lease` - the pet's lease, every column of the lease row ##### Related Endpoints - `GET /leases/{leaseID}/pets` - list the lease's pets - `POST /leases/{leaseID}/pets/{leasePetID}` - update the pet - `DELETE /leases/{leaseID}/pets/{leasePetID}` - remove the pet Parameters: - `leaseID` (path, integer, required): The pet's lease, from `GET /leases`. - `leasePetID` (path, integer, required): The pet, from `GET /leases/{leaseID}/pets`. - `includes` (query, string): `lease` adds the pet's lease. Any other name is ignored. Responses: - `200`: The pet - `application/json`: `lease_pet_detail` Example: ```json { "pet": { "leasePetID": "81", "leaseID": "73", "type": "Dog", "name": "Biscuit", "age": "4", "weight": "45 lbs", "isTrained": "1", "color": "Brown", "hasShots": "1", "isNeutered": "1", "isDeclawed": "0", "isEmotionalSupportAnimal": "0", "isServiceAnimal": "1", "gender": "Male", "dateTimeCreated": "2026-11-12 07:38:01", "petScreeningAnimalID": "88123" } } ``` - `400`: see shared response `lease_pet_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Lease Pet `POST /leases/{leaseID}/pets/{leasePetID}` Operation ID: `updateLeasePet` Updates one of the lease's pets and returns it as `GET /leases/{leaseID}/pets/{leasePetID}` does, including any `includes` the request asks for. Only the keys sent are changed. ##### Use Cases - Correct a pet's details - Record that a pet's vaccinations are now current ##### Business Rules - Requires the **Update Lease** permission (`Leasing` › `UpdateLease`); without it the request is refused with `{"error": "Permission Denied"}`. - A user restricted to portfolio groups gets a 403 `Lease {leaseID}: Access Denied` for a lease whose property is outside those groups' portfolios. - An empty body or `{}` answers 400 `{"error": "invalid input."}`. - A body holding only keys the API doesn't read (`{"extraKey": "x"}`) is accepted: 200, nothing changes. - A well-formed `leasePetID` with no pet, or a pet of another lease, answers 400 `{"error": "Pet not found"}` (without the ID, unlike the GET); a value that isn't a number answers the stock 404. - `type` can't be set to `null`, empty or only spaces (`{"type": ["Type is required"]}`). The other limits are those of `POST /leases/{leaseID}/pets`, each failure a message under its field. ##### Side Effects - When a field changes, adds a `Pet Modified` entry, listing the changes, to the lease's history log. - Stamps the lease's modified date in `GET /leases/export` (its `lease.dateTimeModified`, which that export reports and filters on) with now and the API user. The lease record's own `dateTimeModified`, as `GET /leases/{leaseID}` and the `lease` include send it, doesn't change. ##### Related Endpoints - `GET /leases/{leaseID}/pets/{leasePetID}` - get the pet - `DELETE /leases/{leaseID}/pets/{leasePetID}` - remove the pet - `POST /leases/{leaseID}/pets` - add a pet Parameters: - `leaseID` (path, integer, required): The pet's lease, from `GET /leases`. - `leasePetID` (path, integer, required): The pet, from `GET /leases/{leaseID}/pets`. - `includes` (query, string): `lease` adds the pet's lease to the response. Any other name is ignored. Request body, required: - `application/json`: `lease_pet_request` Example: ```json { "weight": "48 lbs", "isTrained": 0 } ``` Responses: - `200`: The updated pet - `application/json`: `lease_pet_detail` Example: ```json { "pet": { "leasePetID": "102", "leaseID": "91", "type": "Dog", "name": "Biscuit", "age": "4", "weight": "48 lbs", "isTrained": "0", "color": "Brown", "hasShots": "1", "isNeutered": "1", "isDeclawed": "0", "isEmotionalSupportAnimal": "0", "isServiceAnimal": "1", "gender": "Male", "dateTimeCreated": "2026-11-12 07:38:05", "petScreeningAnimalID": "88123" } } ``` - `400`: see shared response `lease_pet_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Remove Lease Pet `DELETE /leases/{leaseID}/pets/{leasePetID}` Operation ID: `deleteLeasePet` Removes a pet from the lease for good and returns the removed pet as it was, without the `pet` wrapper the GET uses. ##### Use Cases - Remove an animal that no longer lives at the unit - Correct a pet added by mistake ##### Business Rules - Requires the **Update Lease** permission (`Leasing` › `UpdateLease`); without it the request is refused with `{"error": "Permission Denied"}`. - A user restricted to portfolio groups gets a 403 `Lease {leaseID}: Access Denied` for a lease whose property is outside those groups' portfolios. - A well-formed `leasePetID` with no pet, or a pet of another lease, answers 400 `{"error": "Pet {leasePetID} not found"}`; a value that isn't a number answers the stock 404. ##### Side Effects - Deletes the pet's row; it no longer appears in `GET /leases/{leaseID}/pets`. - Deletes the pet's photo attachments; the photo files themselves are kept. - Adds a `Pet Removed` entry, naming the pet's type and name, to the lease's history log. - Stamps the lease's modified date in `GET /leases/export` (its `lease.dateTimeModified`, which that export reports and filters on) with now and the API user. The lease record's own `dateTimeModified`, as `GET /leases/{leaseID}` and the `lease` include send it, doesn't change. ##### Related Endpoints - `GET /leases/{leaseID}/pets` - list the lease's remaining pets - `POST /leases/{leaseID}/pets` - add a pet Parameters: - `leaseID` (path, integer, required): The pet's lease, from `GET /leases`. - `leasePetID` (path, integer, required): The pet to remove, from `GET /leases/{leaseID}/pets`. Responses: - `200`: The removed pet, as it was before the delete - `application/json`: `lease_pet` Example: ```json { "leasePetID": "110", "leaseID": "99", "type": "Dog", "name": "Biscuit", "age": "4", "weight": "45 lbs", "isTrained": "1", "color": "Brown", "hasShots": "1", "isNeutered": "1", "isDeclawed": "0", "isEmotionalSupportAnimal": "0", "isServiceAnimal": "1", "gender": "Male", "dateTimeCreated": "2026-11-12 07:38:07", "petScreeningAnimalID": "88123" } ``` - `400`: see shared response `lease_pet_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ### Lease Resident Package A lease's REP package enrollment (`lease_resident_packages`) — at most one per lease, located by `leaseID`. View it, or enroll/update via POST. The package *catalog* lives under Resident Experience. #### Get Lease Resident Package `GET /leases/{leaseID}/resident-package` Operation ID: `getLeaseResidentPackage` Returns the lease's single REP (Resident Experience Package) enrollment, joined to its catalog package. A lease has **at most one** package, so this is a singleton (not a list) located by `leaseID` — there is no enrollment id in the path. ##### Business Rules - The lease must be within the user's accessible portfolios; a `400`/Access Denied is returned otherwise. - A lease that isn't enrolled returns `200` with both `leaseResidentPackage` and `residentPackage` set to `null` (not a `404`). ##### Related Endpoints - `POST /leases/{leaseID}/resident-package` — enroll the lease, or update its enrollment - `GET /leases/{leaseID}/resident-services` — the lease's service entitlements Parameters: - `leaseID` (path, integer, required) Responses: - `200`: The lease's package enrollment (or nulls when not enrolled). - `application/json`: object - `leaseResidentPackage` (`lease_resident_package`, required): The enrollment row, or null when the lease isn't enrolled. - All of: - Option 1: `lease_resident_package` - `residentPackage` (`package`, required): The catalog package the enrollment points to, or null when not enrolled. - All of: - Option 1: `package` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create or Update Lease Resident Package `POST /leases/{leaseID}/resident-package` Operation ID: `saveLeaseResidentPackage` Creates or updates the lease's one package enrollment in a single call — located by `leaseID`, no enrollment id in the path. Not enrolled yet → enrolls the lease (opening the bundled recurring charge and snapshotting the package's services as member entitlements); already enrolled → updates the same row in place. ##### Status transitions (driven by `leaseResidentPackageStatusID`) The enrollment is **never deleted** — it's turned off and back on via its status: - **Enroll** (no enrollment yet) → status defaults to Active; opens the bundled charge + member services. - **Switch package** (change `residentPackageID` on an active enrollment) → re-prices the same bundled charge to the new package and reconciles members: services in the new package are kept/added, services dropped from the old package are cancelled (converted to cancelled à la carte). - **Cancel** (`leaseResidentPackageStatusID = 2`) → stops the bundled recurring charge and cancels the member services. - **Reactivate** (`leaseResidentPackageStatusID = 1` on a cancelled enrollment) → resumes the bundled charge and reactivates the members. ##### Business Rules - Requires the **Update Lease** permission under the Leasing component. - The lease must exist (`400` otherwise) and be within the user's accessible portfolios. - `residentPackageID` is always required (even for a status-only change) and must reference an existing, active catalog package with at least one active service. - `leaseResidentPackageStatusID` is optional — omit it to leave the current status unchanged. - On success the endpoint forwards to `GET /leases/{leaseID}/resident-package` and returns that shape. Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `residentPackageID` (string | integer, required, pattern `^-?[0-9]+$`): The catalog package (`resident_packages`) to enroll the lease in. On an existing enrollment, changing this to a different package switches the lease to it (re-prices the bundled charge + reconciles members). - `leaseResidentPackageStatusID` (string | integer, one of "1", "2", 1, 2): Enrollment status — `1` Active, `2` Cancelled. Omit to leave the current status unchanged. `2` cancels (stops the bundled charge + cancels members); `1` on a cancelled enrollment reactivates it. Defaults to Active on first enrollment. Responses: - `200`: The saved enrollment (same shape as the GET). - `application/json`: object - `leaseResidentPackage` (`lease_resident_package`) - All of: - Option 1: `lease_resident_package` - `residentPackage` (`package`) - All of: - Option 1: `package` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Lease Resident Services A lease's REP service entitlements (`lease_resident_services`) — the services active on a lease, each joined to its catalog service. The service *catalog* lives under Resident Experience. #### List Lease Resident Services `GET /leases/{leaseID}/resident-services` Operation ID: `listLeaseResidentServices` Returns the lease's REP service entitlements (`lease_resident_services`), each joined to its catalog service. Includes both package-member entitlements (covered by the bundled package charge) and à la carte services (each with its own recurring charge). Not paginated — the full set is returned. ##### Business Rules - The lease must be within the user's accessible portfolios; a `400`/Access Denied is returned otherwise. ##### Related Endpoints - `POST /leases/{leaseID}/resident-services` — add an à la carte service to the lease - `GET /leases/{leaseID}/resident-services/{id}` — a single entitlement - `GET /leases/{leaseID}/resident-package` — the lease's package enrollment Parameters: - `leaseID` (path, integer, required) Responses: - `200`: The lease's service entitlements (each entitlement joined to its catalog service). - `application/json`: object[] - Each item: - `leaseResidentService` (`lease_resident_service`) - `residentService` (`service`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Add À La Carte Service `POST /leases/{leaseID}/resident-services` Operation ID: `createLeaseResidentService` Adds a single **à la carte** REP service to the lease (`lease_resident_services`) — a standalone service with its **own** recurring charge, separate from any package. This endpoint manages à la carte services only; services provided by the lease's package are managed through the package. ##### Business Rules - Requires the **Update Lease** permission under the Leasing component. - The lease must exist (`404` otherwise) and be within the user's accessible portfolios. - `residentServiceID` must reference an active catalog service (`resident_services`). - A service the lease already gets through its **package** cannot be added à la carte — returns `400` ("provided by the lease's package… cannot be added separately"). Manage it through the package instead. - The service's own recurring charge is opened on create (starting the first of next month). - On success the endpoint forwards to `GET /leases/{leaseID}/resident-services/{id}` and returns that shape. ##### Related Endpoints - `POST /leases/{leaseID}/resident-services/{id}` — turn an à la carte service off / back on (status) - `POST /leases/{leaseID}/resident-package` — manage the lease's package (and package-provided services) Parameters: - `leaseID` (path, integer, required) Request body, required: - `application/json`: object - `residentServiceID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the catalog service (`resident_services`) to add to the lease. Responses: - `200`: The created entitlement joined to its catalog service (same shape as `GET …/{id}`). - `application/json`: object - `leaseResidentService` (`lease_resident_service`, required) - `residentService` (`service`, required) - `400`: Invalid input, or the service is already provided by the lease's package. - `application/json` Example: ```json { "error": "This service is provided by the lease's package and cannot be added separately." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Get Lease Resident Service `GET /leases/{leaseID}/resident-services/{id}` Operation ID: `getLeaseResidentService` Returns a single REP service entitlement on the lease (`lease_resident_services`), joined to its catalog service. Constrained to the lease — an entitlement id from another lease returns `404`. ##### Business Rules - The lease must be within the user's accessible portfolios; a `400`/Access Denied is returned otherwise. ##### Related Endpoints - `POST /leases/{leaseID}/resident-services/{id}` — turn this à la carte service off / back on (status) - `GET /leases/{leaseID}/resident-services` — all entitlements on the lease Parameters: - `leaseID` (path, integer, required) - `id` (path, integer, required): The lease resident service (entitlement) id. Responses: - `200`: The entitlement joined to its catalog service. - `application/json`: object - `leaseResidentService` (`lease_resident_service`, required) - `residentService` (`service`, required) - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update À La Carte Service `POST /leases/{leaseID}/resident-services/{id}` Operation ID: `updateLeaseResidentService` Updates an à la carte service entitlement. The **only** mutable field is its status — setting it to Cancelled turns the service off, setting it back to Active turns it on. The service reacts to the transition by adjusting the à la carte recurring charge. ##### Status transitions (`leaseResidentServiceStatusID`) - **Cancel** (`2`) → stops the service's recurring charge. A charge that has already started billing is end-dated as of today (history kept); a charge that hasn't started yet is deleted. - **Reactivate** (`1`) → resumes the charge (or mints a fresh one if the prior charge was deleted). ##### Business Rules - Requires the **Update Lease** permission under the Leasing component. - The lease must exist, and the entitlement must exist **on that lease** (`404` otherwise). - A **package-member** entitlement (one carrying a `residentPackageID`) cannot be modified here — returns `400` ("part of a package and cannot be modified directly"). Manage it through the package. - On success the endpoint forwards to `GET /leases/{leaseID}/resident-services/{id}` and returns that shape. Parameters: - `leaseID` (path, integer, required) - `id` (path, integer, required): The lease resident service (entitlement) id. Request body, required: - `application/json`: object - `leaseResidentServiceStatusID` (string | integer, required, one of "1", "2", 1, 2): New status — `1` Active, `2` Cancelled. Responses: - `200`: The updated entitlement joined to its catalog service (same shape as the GET). - `application/json`: object - `leaseResidentService` (`lease_resident_service`, required) - `residentService` (`service`, required) - `400`: Invalid input, or the entitlement is a package member (manage through the package). - `application/json` Example: ```json { "error": "This service is part of a package and cannot be modified directly. Manage it through the package." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ## Maintenance ### Work Orders #### List Work Orders `GET /maintenance/work-orders` Operation ID: `listWorkOrders` Retrieve a paginated list of work orders with their assigned vendor contact. Supports filtering by property, unit, status, vendor, date range, and more. ##### Use Cases - Filter open work orders by property or unit - Find work orders assigned to a specific vendor - Show newly submitted (unacknowledged) work orders - Review work orders within a specific date range ##### Business Rules - Results are scoped to the authenticated user's accessible portfolios - Default page size is 15 ##### Related Endpoints - `GET /maintenance/work-orders/{workOrderID}` - Get full work order details with includes - `POST /maintenance/work-orders` - Create a work order - `GET /maintenance/work-order/statuses` - Get available work order statuses Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 15): Number of items per page - `search` (query, string): Free-text search across work order fields (description, work order number, etc.) - `propertyID` (query, integer): Filter by property ID - `unitID` (query, integer): Filter by unit ID - `workOrderStatusID` (query, integer): Filter by work order status ID. See [Work Order Statuses](https://docs.rentvine.com/#tag/Work-Order-Statuses) for available values. - `isOwnerApproved` (query, integer, one of 0, 1): Filter by owner approval state (`0` = pending, `1` = approved) - `vendorContactID` (query, integer): Filter by assigned vendor contact ID - `startDate` (query, string, date): Filter work orders created on or after this date (`YYYY-MM-DD`) - `endDate` (query, string, date): Filter work orders created on or before this date (`YYYY-MM-DD`) - `leaseID` (query, integer): Filter by associated lease ID - `isNew` (query, integer, one of 0, 1): Filter to only unacknowledged (`1`) or acknowledged (`0`) work orders Responses: - `200`: Successfully retrieved work orders - `application/json`: object[] - Each item: - `workOrder` (`work_order`, required) - `contact` (one of several shapes, required): Vendor contact assigned to the work order. All fields are `null` when no vendor is assigned. - One of: - Option 1: `contact` - Option 2: null Example: ```json [ { "workOrder": { "workOrderID": "5954", "workOrderNumber": "105781", "workOrderProjectID": null, "recurringWorkOrderID": null, "isInternal": "1", "propertyID": "630", "unitID": "607", "leaseID": null, "vendorContactID": null, "primaryWorkOrderStatusID": "2", "workOrderStatusID": "1", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "1", "vendorWorkOrderStatusUpdated": "2026-04-23 13:41:59", "priorityID": "2", "sourceTypeID": null, "isOwnerApproved": "0", "isVacant": "1", "description": "

Water damage on ceiling in living room

", "diagnosticSummary": null, "aiSessionID": null, "isResolvedByRequestor": "0", "vendorInstructions": "

Call before arriving

", "dateClosed": null, "closingDescription": null, "isSharedWithTenant": "1", "isSharedWithOwner": "1", "isNew": "1", "createdByUserID": "1", "closedByUserID": null, "cancelledByUserID": null, "dateTimeCreated": "2026-04-22 17:39:33", "modifiedByUserID": "381140", "dateTimeModified": "2026-04-23 15:30:58", "inspectionID": null, "incidentLocation": null, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null, "isTenantPresenceRequired": "0", "rejectedByVendorContactID": null, "vendorRejectReason": null, "vendorClosingComments": null, "orderIndex": "0", "dateDue": null, "reviewID": null, "vendorAccessTypeID": "3", "residentProvidedEntryInstructions": null, "entryInstructions": null, "isTenantFinanciallyResponsible": "0", "portfolioID": "359", "vendorTradeID": null, "assignedToUserID": "381140", "requestedByContactID": null, "estimatedAmount": null, "scheduledStartDate": null, "actualStartDate": null, "scheduledEndDate": null, "actualEndDate": null }, "contact": { "contactID": null, "name": null, "firstName": null, "lastName": null, "email": null, "phone": null, "isActive": null } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Work Order `POST /maintenance/work-orders` Operation ID: `createWorkOrder` Create a new work order. Requires the **Manage Work Orders** permission. On success, returns the full work order detail (same shape as `GET /maintenance/work-orders/{workOrderID}`). ##### Use Cases - Submit a new maintenance request for a property or unit - Create a work order from a template via `workOrderTemplateID` - Assign a vendor and send a vendor notification email in one step ##### Business Rules - Requires **Manage Work Orders** permission - `propertyID` is required; `unitID` and `leaseID` are optional - `technicianContactIDs` assigns one or more technician contacts to the work order - When `sendVendorNotification` is `true` and a vendor is assigned, a notification email is dispatched - `workOrderTemplateID` pre-populates fields from an existing template when supplied - Dates accept `MM/DD/YYYY` or ISO 8601 `YYYY-MM-DD` format ##### Related Endpoints - `GET /maintenance/work-orders/{workOrderID}` - Get the created work order - `GET /maintenance/work-orders` - List all work orders - `POST /maintenance/work-orders/{workOrderID}` - Update a work order Request body, required: - `application/json`: object - `propertyID` (string | integer, required, pattern `^-?[0-9]+$`): Property the work order is attached to - `unitID` (string | integer | null, pattern `^-?[0-9]+$`): Unit the work order is attached to (null for property-level) - `leaseID` (string | integer | null, pattern `^-?[0-9]+$`): Lease associated with the work order - `isInternal` (string | integer, one of "0", "1", 0, 1): `1` = internal (not shared with tenant or owner), `0` = standard - `isVacant` (string | integer, required, one of "0", "1", 0, 1): Whether the unit is vacant - `description` (string, required): Description of the maintenance issue (may contain HTML) - `priorityID` (string | integer, required, pattern `^-?[0-9]+$`): * `1` - Low * `2` - Medium * `3` - High - `workOrderStatusID` (string | integer, required, pattern `^-?[0-9]+$`): Initial status ID for the work order - `vendorWorkOrderStatusID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor-specific status ID - `isOwnerApproved` (string | integer, required, one of "0", "1", 0, 1): Whether the owner has approved the work order - `isSharedWithTenant` (string | integer, required, one of "0", "1", 0, 1): `1` to share with the Resident Portal, `0` to hide - `isSharedWithOwner` (string | integer, required, one of "0", "1", 0, 1): Whether the work order is visible in the Owner Portal - `vendorContactID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor contact ID to assign to the work order - `vendorTradeID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor trade / maintenance category ID - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): Internal user ID to assign to the work order - `requestedByContactID` (string | integer | null, pattern `^-?[0-9]+$`): Contact ID of the person who requested the work - `technicianContactIDs` (string[]): One or more contact IDs to assign as technicians - `estimatedAmount` (string | number | null, decimal): Estimated cost as a decimal string (e.g. `"500.00"`) - `scheduledStartDate` (string | null): Scheduled start date (`MM/DD/YYYY` or `YYYY-MM-DD`) - `scheduledEndDate` (string | null): Scheduled end date (`MM/DD/YYYY` or `YYYY-MM-DD`) - `actualStartDate` (string | null, date) - `actualEndDate` (string | null, date) - `dateDue` (string | null): Due date (`MM/DD/YYYY` or `YYYY-MM-DD`) - `dateClosed` (string | null, date) - `vendorInstructions` (string | null): HTML instructions for the assigned vendor - `entryInstructions` (string | null): Entry instructions for the vendor - `residentProvidedEntryInstructions` (string | null) - `closingDescription` (string | null) - `vendorAccessTypeID` (string | integer | null, pattern `^-?[0-9]+$`): * `1` - Permission Required * `2` - Permission Not Required * `3` - Do Not Enter - `appointmentWindowStartDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `inspectionID` (string | integer | null, pattern `^-?[0-9]+$`) - `incidentLocation` (string | null) - `workOrderProjectID` (string | integer | null, pattern `^-?[0-9]+$`): Project ID to attach this work order to - `workOrderTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): Template ID to pre-populate work order fields - `orderIndex` (string | integer | null, pattern `^-?[0-9]+$`) - `sourceTypeID` (string | integer | null, pattern `^-?[0-9]+$`) - `isTenantFinanciallyResponsible` (string | integer | null, one of "0", "1", 0, 1, null): `1` when the tenant is responsible for the cost - `sendVendorNotification` (boolean, default true): Whether to send a notification email to the assigned vendor - `sendEmail` (boolean | null): Whether to send an email notification (separate from vendor notification) - `email` (object | null): Custom email content for the vendor notification - `message` (string): HTML message body for the vendor email - `attachments` (integer[]): File IDs to attach to the work order - `issueImages` (integer[]): File IDs to attach as issue images (shared with vendor) Example: ```json { "propertyID": "172", "unitID": null, "leaseID": null, "isInternal": "0", "isVacant": "0", "description": "Leaky faucet in kitchen", "priorityID": "2", "workOrderStatusID": "1", "isOwnerApproved": "0", "isSharedWithTenant": "1", "isSharedWithOwner": "1", "vendorContactID": "5150", "vendorTradeID": "5", "vendorInstructions": "

Call tenant before arriving.

", "technicianContactIDs": [ "5150" ], "sendVendorNotification": true, "vendorAccessTypeID": "1", "attachments": [], "issueImages": [] } ``` Responses: - `200`: Work order created successfully. Returns full work order detail. - `application/json`: object - `workOrder` (`work_order`, required) - `schedulingStatusID` (integer | null, required) Example: ```json { "workOrder": { "workOrderID": "5960", "workOrderNumber": "105787", "workOrderProjectID": "156", "recurringWorkOrderID": null, "isInternal": "1", "propertyID": "172", "unitID": null, "leaseID": null, "vendorContactID": "5150", "primaryWorkOrderStatusID": "2", "workOrderStatusID": "1", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "1", "vendorWorkOrderStatusUpdated": null, "priorityID": "1", "sourceTypeID": null, "isOwnerApproved": "1", "isVacant": "1", "description": "Clean carpet", "diagnosticSummary": null, "aiSessionID": null, "isResolvedByRequestor": "0", "vendorInstructions": "

Instructions

", "dateClosed": null, "closingDescription": null, "isSharedWithTenant": "1", "isSharedWithOwner": "1", "isNew": "1", "createdByUserID": "1", "closedByUserID": null, "cancelledByUserID": null, "dateTimeCreated": "2026-04-26 10:00:00", "modifiedByUserID": "501195", "dateTimeModified": "2026-04-26 10:00:01", "inspectionID": null, "incidentLocation": null, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null, "isTenantPresenceRequired": "0", "rejectedByVendorContactID": null, "vendorRejectReason": null, "vendorClosingComments": null, "orderIndex": "0", "dateDue": "2026-04-30", "reviewID": null, "vendorAccessTypeID": "3", "residentProvidedEntryInstructions": null, "entryInstructions": null, "isTenantFinanciallyResponsible": "0", "portfolioID": "85", "vendorTradeID": "5", "assignedToUserID": "501195", "requestedByContactID": null, "estimatedAmount": "12.00", "scheduledStartDate": "2026-04-26", "actualStartDate": null, "scheduledEndDate": "2026-04-28", "actualEndDate": null, "daysOverdue": 0, "isOverdue": 0, "technicianContactIDs": [ 5150 ], "technicianData": [ { "technicianID": 5150, "name": "ABC Plumbing", "phone": "+15551234567", "contactTypeID": 3, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null } ] }, "schedulingStatusID": 1 } ``` - `400`: Validation error or invalid input - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Work Orders `GET /maintenance/work-orders/search` Operation ID: `searchWorkOrders` Returns a filtered page of work orders, each row denormalized: the `workOrder` (with its days open and overdue, the amounts billed and paid on its bills, its image counts and its technicians), its `workOrderStatus`, `workOrderType`, `portfolio`, `property` and `unit`, its `vendorContact` and `requestedByContact`, its `vendorTrade` and its `propertyGroup` names. Unlike `GET /maintenance/work-orders`, it filters on when a work order last changed (`dateTimeModifiedMin`, `dateTimeModifiedMax`), which is how an integration pulls only the work orders that changed since its last sync. This reference covers paging, sorting, the modified-date filters and the filters documented below, which `GET /maintenance/work-orders` also takes. The endpoint reads more filters and an include that aren't documented here yet. ##### Use Cases - Pull the work orders that changed since the last sync: note the time the sync starts, send the UTC date the previous sync started as `dateTimeModifiedMin` (`YYYY-MM-DD`), sort by `workOrder.dateTimeModified|desc`, and ask for page 1, 2, 3 and so on until a page comes back with fewer rows than `pageSize`. Keep each work order once, by `workOrderID`, then store the start time for the next sync. - Power a work order list with property, unit, vendor and status context, no extra lookups - Find a property's, unit's, lease's or vendor's work orders, or the new or owner-approved ones ##### Business Rules - Requires only authentication; no permission is checked. - With the parameters documented here, a user restricted to portfolio groups only gets work orders whose portfolio is in those groups (a filtered 200, never a 403). - Saving a work order sets its `dateTimeModified` to the current UTC time. Changes stored in other records don't, although this search returns their values: a bill on the work order changes `amountBilled` and a rename of its vendor changes `vendorContact.name` while `dateTimeModified` stays put, and the same goes for the joined property, unit, requester, status, type and trade records and the image counts. A sync keyed on `dateTimeModified` misses those until the work order itself is next saved. - Paging is by offset, and each request moves on by one page, so a sync that pages until a short page ends however many work orders share one `dateTimeModified`. Sorted by `workOrder.dateTimeModified|desc`, a work order saved while you page moves to the front, ahead of the rows you haven't read: the rows behind it shift back, so you may read one twice but never skip one, and the saved work order comes back in the next sync, whose `dateTimeModifiedMin` covers the time it was saved. Sorted any other way, a save can move a row you've read behind you and push one you haven't across a page boundary, where you skip it. A work order deleted while you page shifts the rows behind it forward and can do the same. - `dateTimeModifiedMin` and `dateTimeModifiedMax` take a date (`YYYY-MM-DD`), read as midnight UTC. A sync bounded by the date of its last run gets back the work orders changed earlier that day too; keep each once by `workOrderID`. - Filters combine: a work order must match every one sent. - `workOrderStatusID`, `startDate` and `endDate`, which `GET /maintenance/work-orders` takes, aren't read here: sent to this endpoint they're ignored and the list isn't filtered by them. - A filter value the API can't read is ignored rather than refused: the request still answers 200, unfiltered by that value (a boolean other than `1`/`0`/`true`/`false`/`yes`/`no` in any letter case, an ID that isn't a number). - The page size defaults to 25 and has no cap today. A cap is planned, so don't build a sync on one large page. When some work orders match, `pagination-page-size` reports the page size or the number that match, whichever is smaller. A `pageSize` of `0` or below, or one with no digit in it, is read as 15. - When nothing matches, or the page is past the last one, the body is an empty array; when nothing matches, `pagination-total-items` is `0`. - `page` and `pageSize` keep only their digits: `10abc` is read as 10, `3.4` as 34 and `1e2` as 12. Send whole numbers. - Sorted by `orderBy` (default `workOrder.dateTimeCreated|desc`, newest first), then `workOrderID` ascending. - The joined objects are always present. When a work order has no unit, type, vendor, requester or trade, or the record it points to no longer exists, that object comes back with every key `null`. - A modified-date filter sent as a list (`dateTimeModifiedMin[]=2026-01-01`) fails with a 500. ##### Related Endpoints - `GET /maintenance/work-orders` - the plain work order list, without the modified-date filters - `GET /maintenance/work-orders/{workOrderID}` - one work order, with includes - `GET /properties` - property IDs for `propertyID` - `GET /leases` - lease IDs for `leaseID` - `GET /vendors` - vendor contact IDs for `vendorContactID` Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Items per page (default 25). No cap today; a cap is planned, so don't rely on very large pages. `0`, a negative value or a value with no digit in it is read as 15; any other character is dropped (`10abc` is 10, `3.4` is 34). - `orderBy` (query, string): Sort column, optionally followed by `|asc` or `|desc` (any letter case); anything else after the `|`, or nothing, sorts ascending. Several are separated by commas. Each must be one of the columns below. `workOrderID` always breaks ties, ascending. Columns: `workOrder.dateTimeCreated` (the default, `desc`), `workOrder.dateTimeModified`, `workOrder.workOrderNumber`, `workOrder.workOrderStatusID`, `workOrder.vendorWorkOrderStatusID`, `workOrder.portalVendorWorkOrderStatusID`, `workOrder.isOwnerApproved`, `workOrder.description`, `workOrder.dateClosed`, `workOrder.daysOpen`, `workOrder.daysOverdue`, `workOrder.daysOverdueVendor`, `workOrder.priorityID`, `workOrder.workOrderTypeID`, `workOrder.orderIndex`, `workOrder.scheduledStartDate`, `workOrder.actualStartDate`, `workOrder.scheduledEndDate`, `workOrder.actualEndDate`, `workOrder.dateDue`, `workOrder.isSharedWithTenant`, `workOrder.isSharedWithOwner`, `workOrder.isNew`, `workOrder.appointmentWindowStartDateTime`, `workOrder.appointmentWindowEndDateTime` (both sort by the work order's own window, so an internal work order, which returns its technicians' window, can sort out of step with the value it returns), `workOrder.isInternal`, `workOrder.incidentLocation`, `workOrder.isResolvedByRequestor`, `workOrder.assignedToUserName` (first name, then last name; a `System User - ` name sorts with the unassigned rows), `workOrderStatus.name`, `workOrderType.name`, `portfolio.name`, `property.property` (street name, street number, address 2, city, state), `property.name`, `property.address`, `property.address2`, `property.city`, `property.postalCode`, `unit.unit` (street name, street number, address 2, city, state), `unit.name`, `unit.address`, `unit.address2`, `unit.city`, `unit.postalCode`, `vendorContact.name`, `smartActions.dateTimeCreated` (the newest pending smart action, a value this response doesn't return). - `dateTimeModifiedMin` (query, string, date): Only work orders last modified on or after midnight UTC of this date (`YYYY-MM-DD`). - `dateTimeModifiedMax` (query, string, date): Only work orders last modified on or before midnight UTC of this date (`YYYY-MM-DD`), so it leaves out the rest of that day. - `search` (query, string): Case-insensitive substring match on the work order's number, description, vendor instructions, closing description and incident location, the vendor's name, the property's name, address and city, the unit's name, address and address 2, and the names of an internal work order's technicians; matches the property's state and postal code exactly. - `propertyID` (query, integer): Only this property's work orders (from `GET /properties`). - `unitID` (query, integer): Only this unit's work orders (unit IDs from `GET /properties/{propertyID}/units`). - `leaseID` (query, integer): Only the work orders linked to this lease (from `GET /leases`). - `vendorContactID` (query, integer): Only the work orders assigned to this vendor (from `GET /vendors`). - `isOwnerApproved` (query, string): `1` (or `true`, `yes`, in any letter case) only owner-approved work orders, `0` (or `false`, `no`) only those not approved; omitted returns both. - `isNew` (query, string): `1` (or `true`, `yes`, in any letter case) only work orders flagged new, `0` (or `false`, `no`) only those not; omitted returns both. A work order is flagged new when it is created and again when it is assigned to a different vendor. Responses: - `200`: A page of matching work orders - `application/json`: object[] - Each item: - `workOrder` (object, required): The work order, with values the search computes. - `workOrderID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `workOrderNumber` (string, required, pattern `^-?[0-9]+$`): The number shown on the work order in the app, unique within the account. - `workOrderStatusID` (string, required, pattern `^-?[0-9]+$`): The work order's status (from `GET /maintenance/work-order/statuses`); `workOrderStatus` has its name. - `vendorWorkOrderStatusID` (`vendor_work_order_statuses`, required) - `portalVendorWorkOrderStatusID` (`vendor_work_order_statuses`, required) - `isOwnerApproved` (string, required, one of "0", "1"): `1` when the owner approved the work. - `description` (string, required): The issue, as entered (may contain HTML). - `diagnosticSummary` (string | null, required): The AI intake's diagnostic summary as a JSON-encoded string (decode it to read it), or `null`. - `agentSummary` (string | null, required): The maintenance agent's summary of the work order, or `null`. - `vendorContactID` (string | null, required, pattern `^-?[0-9]+$`): The assigned vendor; `vendorContact` has its name and contact details. On some older internal work orders it holds a technician's contact instead. - `vendorInstructions` (string | null, required): Instructions for the vendor (may contain HTML). - `dateTimeCreated` (string, required, read-only): When the work order was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateClosed` (string | null, date, required): The date the work order was closed, or `null` while it is open. - `vendorTradeID` (string | null, required, pattern `^-?[0-9]+$`): The vendor trade (maintenance category); `vendorTrade` has its name. - `propertyID` (string, required, pattern `^-?[0-9]+$`): The work order's property. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio the work order belongs to. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): The work order's unit, or `null` for the whole property. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): The lease the work order is linked to, or `null`. - `priorityID` (`priorities`, required) - `sourceTypeID` (one of several shapes, required): How the request came in, or `null` when not recorded. - One of: - Option 1: `source_types` - Option 2: null - `isVacant` (string, required, one of "0", "1"): `1` when the work order is marked vacant. Saving a work order with no lease linked sets it to `1`; older work orders with no lease can still hold `0`. - `requestedByContactID` (string | null, required, pattern `^-?[0-9]+$`): The person who asked for the work; `requestedByContact` has their name and contact details. - `estimatedAmount` (string | null, decimal, required): Estimated cost, or `null`. - `scheduledStartDate` (string | null, date, required): The date the work is scheduled to start, or `null`. - `actualStartDate` (string | null, date, required): The date the work actually started, or `null`. - `scheduledEndDate` (string | null, date, required): The date the work is scheduled to end, or `null`. - `actualEndDate` (string | null, date, required): The date the work actually ended, or `null`. - `dateDue` (string | null, date, required): The date the work is due, or `null`. - `closingDescription` (string | null, required): Notes entered when the work order was closed. - `dateTimeModified` (string, required, read-only): When the work order last changed, set on every save. UTC, formatted `YYYY-MM-DD HH:MM:SS`. The modified-date filters compare against it. - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): The manager user the work order is assigned to, or `null`. - `assignedToUserName` (string | null, required): The assigned user's first and last name, `System User - ` when the account has no record of that user, or `null` when nothing is assigned. - `isTenantFinanciallyResponsible` (string, required, one of "0", "1"): `1` when the tenant pays for the work. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Position within its project; `0` for a work order outside a project. - `isSharedWithTenant` (string, required, one of "0", "1"): `1` when the work order shows in the Resident Portal. - `isSharedWithOwner` (string, required, one of "0", "1"): `1` when the work order shows in the Owner Portal. - `isNew` (string, required, one of "0", "1"): `1` while the work order is flagged new: set when it is created and again when it is assigned to a different vendor. - `appointmentWindowStartDateTime` (string | null, required): Start of the appointment window; on an internal work order, taken from its technicians' windows (`technicianData`). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null, required): End of the same appointment window. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isInternal` (string | null, required, one of "0", "1", null): `1` when the account's own technicians do the work, `0` when a vendor does. - `incidentLocation` (string | null, required, max length 255): Where in the property the issue is. - `isResolvedByRequestor` (string, required, one of "0", "1"): `1` when the person who asked for the work marked it resolved themselves. - `daysOpen` (string, required, pattern `^-?[0-9]+$`): Days the work order has been open, from its creation date to its closing date, or to today while it is open. Both dates are in the account's time zone, not UTC, so this can differ by a day from a count made from `dateTimeCreated`. - `daysOverdue` (string | null, required, pattern `^-?[0-9]+$`): Days since `dateDue` (negative before it), counted to today in the account's time zone, or `null` when the work order is closed or has no due date. - `daysOverdueVendor` (string | null, required, pattern `^-?[0-9]+$`): Days since `dateDue` (negative before it), counted to today in the account's time zone, or `null` when `portalVendorWorkOrderStatusID` is `3` (Closed) or there is no due date. - `amountBilled` (string | null, decimal, required): Total of the charges on the work order's bills, or `null` when it has none. - `amountPaid` (string | null, decimal, required): Amount paid on those charges, or `null` when it has none. - `workOrderTypeID` (string | null, required, pattern `^-?[0-9]+$`): The work order's type; `workOrderType` has its name. `null` on older work orders with no type. - `issueImageCount` (string, required, pattern `^-?[0-9]+$`): Number of images attached to the issue. - `resolutionImageCount` (string, required, pattern `^-?[0-9]+$`): Number of images attached to the resolution. - `technicianData` (object[], required): Who does the work. An internal work order lists its technicians; a vendor work order lists its vendor; empty when nobody is assigned. - `technicianID` (integer, required): The technician's or vendor's contact ID (a JSON number). - `name` (string | null, required): The contact's name. - `phone` (string | null, required): The contact's phone number, or `null`. - `contactTypeID` (integer, required, one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9): The contact's type, a JSON number: usually `3` (Vendor) or `8` (Internal Technician), though older work orders can point at a contact of another type; `0` when the contact record no longer exists. * `0` - Contact not found * `1` - Owner * `2` - Tenant * `3` - Vendor * `4` - Manager * `5` - Association * `6` - Applicant * `7` - Screening Prospect * `8` - Internal Technician * `9` - Owner Lead - `appointmentWindowStartDateTime` (string | null, required): Start of this technician's appointment window (the work order's own, for a vendor). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null, required): End of that window. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `workOrderStatus` (object, required): The work order's status. - `workOrderStatusID` (string, required, pattern `^-?[0-9]+$`): The status's ID (from `GET /maintenance/work-order/statuses`). - `primaryWorkOrderStatusID` (`primary_statuses`, required) - `name` (string, required, max length 100): The status's name, as the account named it. - `workOrderType` (object, required): The work order's type. Every key is `null` for an older work order with no type. - `workOrderTypeID` (string | null, required, pattern `^-?[0-9]+$`): The type's ID. - `systemWorkOrderTypeID` (string | null, required, one of "1", "2", "3", "4", "5", null): The built-in type this one is, or `1` for a type the account added. * `1` - Custom * `2` - Service Request * `3` - Make Ready * `4` - Routine / Preventative * `5` - Capital Improvement - `name` (string | null, required, max length 100): The type's name, as the account named it. - `portfolio` (object, required): The portfolio the work order belongs to. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio's ID. - `name` (string, required, max length 100): The portfolio's name. - `property` (object, required): The work order's property. - `propertyID` (string, required, pattern `^-?[0-9]+$`): The property's ID. - `name` (string | null, required, max length 100): The property's display name, if it has one. - `address` (string, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line. - `city` (string, required, max length 100): City. - `stateID` (string, required, max length 3): State code, such as `FL` (letters, not a numeric ID). - `postalCode` (string | null, required, max length 20): Postal code. - `isMultiUnit` (string, required, one of "0", "1"): `1` for a multi-unit property, `0` for a single-family one. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio that owns the property. - `unit` (object, required): The work order's unit. Every key is `null` when the work order is for the whole property. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): The unit's ID. - `name` (string | null, required, max length 100): The unit's name. - `address` (string | null, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line, such as the unit number. - `city` (string | null, required, max length 100): City. - `stateID` (string | null, required, max length 3): State code, such as `FL` (letters, not a numeric ID). - `postalCode` (string | null, required, max length 20): Postal code. - `latitude` (string | null, decimal, required): Latitude, in degrees. - `longitude` (string | null, decimal, required): Longitude, in degrees. - `vendorContact` (`work_order_search_contact`, required) - `requestedByContact` (`work_order_search_contact`, required) - `vendorTrade` (object, required): The work order's vendor trade (maintenance category). Every key is `null` when it has none. - `vendorTradeID` (string | null, required, pattern `^-?[0-9]+$`): The trade's ID. - `name` (string | null, required, max length 500): The trade's name. - `propertyGroup` (object, required): The property groups the work order's property is in. - `propertyGroupNames` (string | null, required): The groups' names, separated by `, `, or `null` when the property is in none. Example: ```json [ { "workOrder": { "workOrderID": "1087", "workOrderNumber": "100001", "workOrderStatusID": "4", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "1", "isOwnerApproved": "1", "description": "Kitchen sink is leaking", "diagnosticSummary": "{\"summary\": {\"issue_description\": {\"summary\": \"Kitchen sink is leaking\"}}}", "agentSummary": "The tenant reports a slow leak under the kitchen sink.", "vendorContactID": "395", "vendorInstructions": "Call the tenant before arriving", "dateTimeCreated": "2026-02-27 15:04:11", "dateClosed": null, "vendorTradeID": "44", "propertyID": "1011", "portfolioID": "1202", "unitID": "601", "leaseID": "329", "priorityID": "3", "sourceTypeID": "1", "isVacant": "0", "requestedByContactID": "393", "estimatedAmount": "450.00", "scheduledStartDate": "2026-03-02", "actualStartDate": "2026-03-02", "scheduledEndDate": "2026-03-04", "actualEndDate": "2026-03-03", "dateDue": "2026-03-05", "closingDescription": null, "dateTimeModified": "2026-03-06 18:22:40", "assignedToUserID": "2", "assignedToUserName": "Pat Manager", "isTenantFinanciallyResponsible": "0", "orderIndex": "0", "isSharedWithTenant": "1", "isSharedWithOwner": "1", "isNew": "1", "appointmentWindowStartDateTime": "2026-03-02 14:00:00", "appointmentWindowEndDateTime": "2026-03-02 16:00:00", "isInternal": "0", "incidentLocation": "Kitchen", "isResolvedByRequestor": "0", "daysOpen": "260", "daysOverdue": "254", "daysOverdueVendor": "254", "amountBilled": null, "amountPaid": null, "workOrderTypeID": "28", "issueImageCount": "0", "resolutionImageCount": "0", "technicianData": [ { "technicianID": 395, "name": "Example Plumbing Co", "phone": "555-0101", "contactTypeID": 3, "appointmentWindowStartDateTime": "2026-03-02 14:00:00", "appointmentWindowEndDateTime": "2026-03-02 16:00:00" } ] }, "workOrderStatus": { "workOrderStatusID": "4", "primaryWorkOrderStatusID": "1", "name": "Requested" }, "workOrderType": { "workOrderTypeID": "28", "systemWorkOrderTypeID": "1", "name": "Inspection Follow-up" }, "portfolio": { "portfolioID": "1202", "name": "Metz Ltd Portfolio" }, "property": { "propertyID": "1011", "name": "Example Property", "address": "123 Main St", "address2": "Suite 2", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "isMultiUnit": "0", "portfolioID": "1202" }, "unit": { "unitID": "601", "name": "Example Property", "address": "123 Main St", "address2": "Unit 1A", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000" }, "vendorContact": { "contactID": "395", "name": "Example Plumbing Co", "email": "service@example.com", "phone": "555-0101" }, "requestedByContact": { "contactID": "393", "name": "Pat Tenant", "email": "pat.tenant@example.com", "phone": "555-0100" }, "vendorTrade": { "vendorTradeID": "44", "name": "Plumbing" }, "propertyGroup": { "propertyGroupNames": "North Side" } }, { "workOrder": { "workOrderID": "1088", "workOrderNumber": "100002", "workOrderStatusID": "2", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "3", "isOwnerApproved": "0", "description": "Replace the furnace filter", "diagnosticSummary": null, "agentSummary": null, "vendorContactID": null, "vendorInstructions": null, "dateTimeCreated": "2026-02-27 15:04:11", "dateClosed": "2026-03-06", "vendorTradeID": null, "propertyID": "1011", "portfolioID": "1202", "unitID": "601", "leaseID": null, "priorityID": "2", "sourceTypeID": null, "isVacant": "1", "requestedByContactID": null, "estimatedAmount": null, "scheduledStartDate": null, "actualStartDate": null, "scheduledEndDate": null, "actualEndDate": null, "dateDue": "2026-03-07", "closingDescription": "Filter replaced", "dateTimeModified": "2026-03-06 18:22:40", "assignedToUserID": null, "assignedToUserName": null, "isTenantFinanciallyResponsible": "0", "orderIndex": "0", "isSharedWithTenant": "0", "isSharedWithOwner": "0", "isNew": "1", "appointmentWindowStartDateTime": "2026-03-05 09:00:00", "appointmentWindowEndDateTime": "2026-03-05 11:00:00", "isInternal": "1", "incidentLocation": null, "isResolvedByRequestor": "0", "daysOpen": "7", "daysOverdue": null, "daysOverdueVendor": null, "amountBilled": "125.50", "amountPaid": "25.50", "workOrderTypeID": "1", "issueImageCount": "0", "resolutionImageCount": "0", "technicianData": [ { "technicianID": 396, "name": "Sam Technician", "phone": "555-0102", "contactTypeID": 8, "appointmentWindowStartDateTime": "2026-03-05 09:00:00", "appointmentWindowEndDateTime": "2026-03-05 11:00:00" } ] }, "workOrderStatus": { "workOrderStatusID": "2", "primaryWorkOrderStatusID": "3", "name": "Completed" }, "workOrderType": { "workOrderTypeID": "1", "systemWorkOrderTypeID": "2", "name": "Service Request" }, "portfolio": { "portfolioID": "1202", "name": "Metz Ltd Portfolio" }, "property": { "propertyID": "1011", "name": "Example Property", "address": "123 Main St", "address2": "Suite 2", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "isMultiUnit": "0", "portfolioID": "1202" }, "unit": { "unitID": "601", "name": "Example Property", "address": "123 Main St", "address2": "Unit 1A", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000" }, "vendorContact": { "contactID": null, "name": null, "email": null, "phone": null }, "requestedByContact": { "contactID": null, "name": null, "email": null, "phone": null }, "vendorTrade": { "vendorTradeID": null, "name": null }, "propertyGroup": { "propertyGroupNames": "North Side" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` - `500`: A modified-date filter sent as a list (`dateTimeModifiedMin[]=…` or `dateTimeModifiedMax[]=…`) fails, with no body. Send each as a single value. #### Get Work Order `GET /maintenance/work-orders/{workOrderID}` Operation ID: `getWorkOrder` Retrieve detailed information about a specific work order by ID, including computed overdue status and assigned technician data. ##### Use Cases - View complete work order details - Check work order status and progress - Review assigned technicians and scheduling status ##### Business Rules - Returns `400` with `"Work Order {id} not found"` if the work order does not exist - Access is verified against portfolio restrictions; unauthorized requests receive `403 "Work Order Access Not Allowed"` - `daysOverdue` and `isOverdue` are calculated dynamically from `dateDue` and today's date ##### Related Endpoints - `GET /maintenance/work-orders` - List work orders - `POST /maintenance/work-orders/{workOrderID}` - Update work order - `DELETE /maintenance/work-orders/{workOrderID}` - Delete work order - `GET /maintenance/work-orders/{workOrderID}/print` - Print work order PDF Parameters: - `workOrderID` (path, integer, required): The unique work order ID Responses: - `200`: Successfully retrieved work order - `application/json`: object - `workOrder` (object, required) - `workOrderID` (string, required, read-only, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, required, read-only, pattern `^-?[0-9]+$`) - `workOrderProjectID` (string | null, pattern `^-?[0-9]+$`) - `recurringWorkOrderID` (string | null, pattern `^-?[0-9]+$`) - `isInternal` (string | null, one of "0", "1", null): `0` = no, `1` = yes - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `vendorContactID` (string | null, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (string, required, pattern `^-?[0-9]+$`) - `workOrderStatusID` (string, required, pattern `^-?[0-9]+$`) - `vendorWorkOrderStatusID` (string | null, pattern `^-?[0-9]+$`) - `portalVendorWorkOrderStatusID` (string | null, pattern `^-?[0-9]+$`) - `vendorWorkOrderStatusUpdated` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `priorityID` (string, required, pattern `^-?[0-9]+$`): * `1` - Low * `2` - Medium * `3` - High - `sourceTypeID` (string | null, pattern `^-?[0-9]+$`): * `1` - Portal * `2` - In Person * `3` - Email * `4` - Text Message * `5` - Phone * `6` - Recurring * `7` - AI - `isOwnerApproved` (string, required, one of "0", "1"): `0` = pending, `1` = approved - `isVacant` (string, required, one of "0", "1") - `description` (string, required): Work order description / reported issue (may contain HTML) - `diagnosticSummary` (object | null): AI-generated diagnostic summary. Lazy-loaded when `aiSessionID` is set and summary is empty. - `aiSessionID` (string | null) - `isResolvedByRequestor` (string, one of "0", "1") - `vendorInstructions` (string | null) - `dateClosed` (string | null, date) - `closingDescription` (string | null) - `isSharedWithTenant` (string, required, one of "0", "1"): Visible in the Resident Portal (`0` = no, `1` = yes) - `isSharedWithOwner` (string, required, one of "0", "1"): Visible in the Owner Portal (`0` = no, `1` = yes) - `isNew` (string, required, one of "0", "1"): `1` if not yet acknowledged by a manager - `createdByUserID` (string | null, read-only, pattern `^-?[0-9]+$`) - `closedByUserID` (string | null, pattern `^-?[0-9]+$`) - `cancelledByUserID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `modifiedByUserID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `inspectionID` (string | null, pattern `^-?[0-9]+$`) - `incidentLocation` (string | null) - `appointmentWindowStartDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isTenantPresenceRequired` (string | null, one of "0", "1", null) - `rejectedByVendorContactID` (string | null, pattern `^-?[0-9]+$`) - `vendorRejectReason` (string | null) - `vendorClosingComments` (string | null) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) - `dateDue` (string | null, date) - `reviewID` (string | null, pattern `^-?[0-9]+$`) - `vendorAccessTypeID` (string | null, pattern `^-?[0-9]+$`) - `residentProvidedEntryInstructions` (string | null) - `entryInstructions` (string | null) - `isTenantFinanciallyResponsible` (string, one of "0", "1") - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `vendorTradeID` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `requestedByContactID` (string | null, pattern `^-?[0-9]+$`) - `estimatedAmount` (string | null, decimal): Decimal returned as string (e.g. `"500.00"`) - `scheduledStartDate` (string | null, date) - `actualStartDate` (string | null, date) - `scheduledEndDate` (string | null, date) - `actualEndDate` (string | null, date) - `daysOverdue` (integer): Calculated days past `dateDue` - `isOverdue` (integer): `1` when `daysOverdue > 0`, otherwise `0` - `technicianContactIDs` (integer[], required) - `technicianData` (object[], required) - `technicianID` (integer) - `name` (string | null) - `phone` (string | null) - `contactTypeID` (integer | null) - `appointmentWindowStartDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `schedulingStatusID` (integer | null, required) Example: ```json { "workOrder": { "workOrderID": "2314", "workOrderNumber": "102161", "workOrderProjectID": null, "recurringWorkOrderID": null, "isInternal": "0", "propertyID": "84", "unitID": "96", "leaseID": "154", "vendorContactID": "125", "primaryWorkOrderStatusID": "1", "workOrderStatusID": "11", "vendorWorkOrderStatusID": "1", "portalVendorWorkOrderStatusID": "1", "vendorWorkOrderStatusUpdated": null, "priorityID": "3", "sourceTypeID": "1", "isOwnerApproved": "0", "isVacant": "0", "description": "

leaky faucet

", "diagnosticSummary": null, "aiSessionID": null, "isResolvedByRequestor": "0", "vendorInstructions": null, "dateClosed": null, "closingDescription": null, "isSharedWithTenant": "1", "isSharedWithOwner": "0", "isNew": "0", "createdByUserID": "1", "closedByUserID": null, "cancelledByUserID": null, "dateTimeCreated": "2023-10-19 20:12:01", "modifiedByUserID": "94827", "dateTimeModified": "2023-10-19 20:15:19", "inspectionID": null, "incidentLocation": null, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null, "isTenantPresenceRequired": "0", "rejectedByVendorContactID": null, "vendorRejectReason": null, "vendorClosingComments": null, "orderIndex": "0", "dateDue": "2023-10-26", "reviewID": null, "vendorAccessTypeID": "2", "residentProvidedEntryInstructions": null, "entryInstructions": null, "isTenantFinanciallyResponsible": "0", "portfolioID": "59", "vendorTradeID": "7", "assignedToUserID": "2079", "requestedByContactID": "268", "estimatedAmount": "500.00", "scheduledStartDate": "2023-10-19", "actualStartDate": null, "scheduledEndDate": "2023-10-26", "actualEndDate": null, "daysOverdue": 910, "isOverdue": 1, "technicianContactIDs": [], "technicianData": [ { "technicianID": 125, "name": "Best View Windows", "phone": "+17193301649", "contactTypeID": 3, "appointmentWindowStartDateTime": null, "appointmentWindowEndDateTime": null } ] }, "schedulingStatusID": 1 } ``` - `400`: Work order not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order 99999 not found" } ``` - `401`: see shared response `error_401` - `403`: Access denied - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order Access Not Allowed" } ``` - `429`: see shared response `error_429` #### Update Work Order `POST /maintenance/work-orders/{workOrderID}` Operation ID: `updateWorkOrder` Update an existing work order. Supports updating all work order fields including status, assignment, scheduling, and shared visibility settings. ##### Use Cases - Update work order status - Assign/reassign vendor - Change priority level - Update schedule dates - Modify description and instructions - Change owner/tenant visibility - Set appointment windows ##### Business Rules - Access controlled by portfolio restrictions - Changing status may trigger notifications - Owner approval may be required for certain changes - Vendor assignment triggers vendor notification (if sendVendorNotification=true) - Status changes to completed status can trigger review requests - Requires **Manage Work Orders** permission ##### Workflow Changes - **Status Updates** - May trigger workflow automations - **Owner Sharing** - Controls visibility in owner portal - **Tenant Sharing** - Controls visibility in resident portal ##### Related Endpoints - `GET /maintenance/work-orders/{workOrderID}` - View work order - `DELETE /maintenance/work-orders/{workOrderID}` - Delete work order Parameters: - `workOrderID` (path, integer, required): The unique work order ID to update Request body, required: - `application/json`: object - `isInternal` (string | integer, one of "0", "1", 0, 1): Internal work order flag (0=no, 1=yes) - `propertyID` (string | integer, pattern `^-?[0-9]+$`): Property ID - `unitID` (string | integer | null, pattern `^-?[0-9]+$`): Unit ID (null for property-level) - `leaseID` (string | integer | null, pattern `^-?[0-9]+$`): Associated lease ID - `vendorTradeID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor trade/specialty - `vendorContactID` (string | integer | null, pattern `^-?[0-9]+$`): Assigned vendor contact ID - `workOrderStatusID` (string | integer, pattern `^-?[0-9]+$`): Work order status - `vendorWorkOrderStatusID` (string | integer | null, pattern `^-?[0-9]+$`): Vendor-specific status - `priorityID` (string | integer, pattern `^-?[0-9]+$`): Priority (1=Low, 2=Normal, 3=High, 4=Emergency) - `sourceTypeID` (string | integer, pattern `^-?[0-9]+$`): Work order source/origin - `isOwnerApproved` (string | integer, one of "0", "1", 0, 1): Owner approval (0=pending, 1=approved) - `isVacant` (string | integer, one of "0", "1", 0, 1): Vacant unit flag - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): Assigned internal user - `requestedByContactID` (string | integer | null, pattern `^-?[0-9]+$`): Contact who requested work - `estimatedAmount` (string | number | null, decimal): Estimated cost - `scheduledStartDate` (string | null, date): Scheduled start date - `actualStartDate` (string | null, date): Actual start date - `scheduledEndDate` (string | null, date): Scheduled end date - `actualEndDate` (string | null, date): Actual end date - `dateDue` (string | null, date): Due date - `dateClosed` (string | null, date): Closed date - `description` (string): Work order description/issue - `vendorInstructions` (string | null): Instructions for vendor - `closingDescription` (string | null): Closing notes/resolution - `isSharedWithOwner` (string | integer, one of "0", "1", 0, 1): Share with owner portal (0=no, 1=yes) - `isSharedWithTenant` (string | integer, one of "0", "1", 0, 1): Share with resident portal (0=no, 1=yes) - `inspectionID` (string | integer | null, pattern `^-?[0-9]+$`): Related inspection ID - `incidentLocation` (string | null): Location within property - `workOrderProjectID` (string | integer | null, pattern `^-?[0-9]+$`): Parent project ID - `orderIndex` (string | integer, pattern `^-?[0-9]+$`): Display order - `vendorAccessTypeID` (string | integer | null, pattern `^-?[0-9]+$`): Access type for vendor - `residentProvidedEntryInstructions` (string | null): Entry instructions from tenant - `entryInstructions` (string | null): Entry instructions for vendor - `isTenantFinanciallyResponsible` (string | integer, one of "0", "1", 0, 1): Tenant pays for work (0=no, 1=yes) - `appointmentWindowStartDateTime` (string | null): Appointment window start. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Appointment window end. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `sendVendorNotification` (boolean, default true): Send notification to vendor on changes - `sendReview` (boolean, default false): Send review request on completion Example: ```json { "workOrderStatusID": 2, "sendVendorNotification": false } ``` Responses: - `200`: Work order updated successfully - `application/json`: object - `workOrder` (object): Updated work order details (same structure as GET response) Example: ```json { "workOrder": { "workOrderID": 12345, "workOrderNumber": "WO-2024-12345", "workOrderStatusID": 2, "priorityID": 4, "description": "Kitchen sink is leaking under the cabinet - URGENT: Water damage spreading", "dateTimeModified": "2024-10-23 10:30:00" } } ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Work order not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order 99999 not found" } ``` - `429`: see shared response `error_429` #### Delete Work Order `DELETE /maintenance/work-orders/{workOrderID}` Operation ID: `deleteWorkOrder` Delete a work order. This operation removes the work order and all associated data including attachments, messages, and timeline events. ##### Use Cases - Remove duplicate work orders - Delete cancelled work orders - Clean up test/invalid work orders ##### Business Rules - Access controlled by portfolio restrictions - Cannot delete if associated bills exist - Deletes all attachments and messages - Requires **Manage Work Orders** permission ##### Data Cleanup - Removes work order record - Deletes file attachments - Removes work order messages - Removes from projects ##### Related Endpoints - `GET /maintenance/work-orders/{workOrderID}` - View work order - `GET /maintenance/work-orders` - View work orders Parameters: - `workOrderID` (path, string, required): The unique work order ID to delete Responses: - `200`: Work order deleted successfully - `application/json`: object - `workOrderID` (string, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, pattern `^-?[0-9]+$`) - `description` (string) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json { "workOrderID": "12345", "workOrderNumber": "WO-2024-12345", "description": "Kitchen sink is leaking under the cabinet", "dateTimeCreated": "2024-10-23 08:30:00", "dateTimeModified": "2024-10-23 09:15:00" } ``` - `400`: Cannot delete work order - `application/json`: object - `error` (string) Example: ```json { "error": "Cannot delete work order - 2 bills are associated. Please unlink bills first." } ``` - `401`: see shared response `error_401` - `403`: Access denied - insufficient permissions - `application/json`: object - `error` (string) Example: ```json { "error": "Access denied to work order" } ``` - `404`: Work order not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work order 99999 not found" } ``` - `429`: see shared response `error_429` #### Print Work Order PDF `GET /maintenance/work-orders/{workOrderID}/print` Operation ID: `printWorkOrder` Generate and download a PDF version of the specified work order. The response is a binary PDF document suitable for printing or archiving. ##### Use Cases - Print a work order to hand to a technician or vendor - Archive a completed work order as a PDF - Attach a work order PDF to an email or document management system ##### Business Rules - Returns `400` with `"Work Order not found"` if the work order does not exist - Access is verified against portfolio restrictions; unauthorized requests are rejected ##### Related Endpoints - `GET /maintenance/work-orders/{workOrderID}` - Get work order details as JSON Parameters: - `workOrderID` (path, integer, required): The unique work order ID to print Responses: - `200`: PDF document for the work order - `application/pdf`: string, binary - `400`: Work order not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Work Order Statuses #### List Work Order Statuses `GET /maintenance/work-order/statuses` Operation ID: `listWorkOrderStatuses` Retrieve all work order statuses available in the account, including both system statuses and any custom statuses created by the account. ##### Use Cases - Display a list of available statuses in a settings page ##### Business Rules - Returns both system statuses (`isSystemStatus = 1`) and custom account statuses (`isSystemStatus = 0`) - System statuses cannot be renamed or deleted, only custom statuses can be managed - The 7 built-in system statuses are: `Open`, `Completed`, `Cancelled`, `Requested`, `On Hold`, `Estimating`, `Rejected` ##### Related Endpoints - `GET /maintenance/work-order/statuses/{workOrderStatusID}` - Get a specific status by ID - `POST /maintenance/work-order/statuses` - Create or update a custom status Parameters: - `search` (query, string): Free-text search on status name - `isSystemStatus` (query, integer, one of 0, 1): Filter to system statuses only (`1`) or custom statuses only (`0`) Responses: - `200`: Successfully retrieved work order statuses - `application/json`: object[] - Each item: - `workOrderStatus` (`work_order_status`, required) Example: ```json [ { "workOrderStatus": { "workOrderStatusID": "1", "primaryWorkOrderStatusID": "2", "isSystemStatus": "1", "name": "Open", "orderIndex": "0" } }, { "workOrderStatus": { "workOrderStatusID": "9", "primaryWorkOrderStatusID": "2", "isSystemStatus": "0", "name": "Tech Completed", "orderIndex": "1" } }, { "workOrderStatus": { "workOrderStatusID": "2", "primaryWorkOrderStatusID": "3", "isSystemStatus": "1", "name": "Completed", "orderIndex": "10" } }, { "workOrderStatus": { "workOrderStatusID": "3", "primaryWorkOrderStatusID": "5", "isSystemStatus": "1", "name": "Cancelled", "orderIndex": "12" } }, { "workOrderStatus": { "workOrderStatusID": "5", "primaryWorkOrderStatusID": "4", "isSystemStatus": "1", "name": "On Hold", "orderIndex": "14" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create `POST /maintenance/work-order/statuses` Operation ID: `createWorkOrderStatus` Request body: - `application/json`: `work_order_status_base` Responses: - `200`: OK - `application/json`: `work_order_status` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Work Order Status `GET /maintenance/work-order/statuses/{workOrderStatusID}` Operation ID: `getWorkOrderStatus` Retrieve a single work order status by its ID. Returns both system statuses and custom account statuses. ##### Use Cases - Look up the name and primary status group for a specific status ID - Validate that a status ID exists before assigning it to a work order - Check whether a given status is a system status or a custom one ##### Business Rules - Returns `400` with `"Work Order Status {id} not found"` if the status does not exist - Both system statuses and custom account statuses are accessible by ID ##### Related Endpoints - `GET /maintenance/work-order/statuses` - List all work order statuses - `POST /maintenance/work-order/statuses/{workOrderStatusID}` - Update a custom status - `DELETE /maintenance/work-order/statuses/{workOrderStatusID}` - Delete a custom status Parameters: - `workOrderStatusID` (path, integer, required): The unique work order status ID Responses: - `200`: Successfully retrieved work order status - `application/json`: object - `workOrderStatus` (`work_order_status`, required) Example: ```json { "workOrderStatus": { "workOrderStatusID": "5", "primaryWorkOrderStatusID": "4", "isSystemStatus": "1", "name": "On Hold", "orderIndex": "14" } } ``` - `400`: Status not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order Status 999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Work Order Status `POST /maintenance/work-order/statuses/{workOrderStatusID}` Operation ID: `updateWorkOrderStatus` Update an existing custom work order status by ID. ##### Use Cases - Rename a custom status ##### Business Rules - Requires **Manage Work Order Statuses** permission - Returns `400` with `"Work Order Status {id} not found"` if the status does not exist - On success, forwards to the GET detail endpoint and returns the updated status wrapped in `workOrderStatus` - `primaryWorkOrderStatusID` cannot be modified ##### Related Endpoints - `GET /maintenance/work-order/statuses/{workOrderStatusID}` - Get status by ID - `DELETE /maintenance/work-order/statuses/{workOrderStatusID}` - Delete a custom status - `GET /maintenance/work-order/statuses` - List all statuses Parameters: - `workOrderStatusID` (path, integer, required): The unique work order status ID to update Request body, required: - `application/json`: object - `name` (string, required): Display name for the custom status - `primaryWorkOrderStatusID` (string | integer, required, one of "1", "2", "3", "4", "5", 1, 2, 3, 4, 5): The primary status group this custom status belongs to. * `1` - Pending * `2` - Open * `3` - Closed * `4` - On Hold * `5` - Cancelled Example: ```json { "name": "Tech Completed", "primaryWorkOrderStatusID": 2 } ``` Responses: - `200`: Work order status updated successfully - `application/json`: object - `workOrderStatus` (`work_order_status`, required) Example: ```json { "workOrderStatus": { "workOrderStatusID": "9", "primaryWorkOrderStatusID": "2", "isSystemStatus": "0", "name": "Tech Completed", "orderIndex": "1" } } ``` - `400`: Validation error or status not found - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order Status 999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Work Order Status `DELETE /maintenance/work-order/statuses/{workOrderStatusID}` Operation ID: `deleteWorkOrderStatus` Delete a custom work order status. Only custom statuses (those with `isSystemStatus = 0`) can be deleted; system statuses are protected. ##### Use Cases - Remove an outdated or duplicate custom status - Clean up statuses that are no longer used in the account's workflow ##### Business Rules - Requires `Manage Work Order Statuses` permission - Returns `400` with `"Work Order Status {id} not found"` if the status does not exist - System statuses (`isSystemStatus = 1`) cannot be deleted via this endpoint - Any work orders that currently have this status may need to be reassigned manually ##### Related Endpoints - `GET /maintenance/work-order/statuses` - List all statuses - `GET /maintenance/work-order/statuses/{workOrderStatusID}` - Get a status by ID Parameters: - `workOrderStatusID` (path, integer, required): The unique work order status ID to delete Responses: - `200`: Work order status deleted successfully. Returns the deleted status data. - `application/json`: object - `workOrderStatusID` (string, required, read-only, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (string, required, pattern `^-?[0-9]+$`) - `isSystemStatus` (string, required, one of "0", "1") - `name` (string, required) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) Example: ```json { "workOrderStatusID": "9", "primaryWorkOrderStatusID": "2", "isSystemStatus": "0", "name": "Tech Completed", "orderIndex": "1" } ``` - `400`: Status not found or cannot be deleted - `application/json`: object - `error` (string) Example: ```json { "error": "Work Order Status 999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Vendor Trades #### List `GET /maintenance/vendor-trades` Operation ID: `listVendorTrades` List vendor trades Responses: - `200`: OK - `application/json`: `vendor_trade`[] - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create `POST /maintenance/vendor-trades` Operation ID: `createVendorTrade` Request body: - `application/json`: `vendor_trade_base` Responses: - `200`: OK - `application/json`: `vendor_trade` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Vendor Trade `GET /maintenance/vendor-trades/{vendorTradeID}` Operation ID: `getVendorTrade` Retrieve a single vendor trade (maintenance category) by ID. ##### Use Cases - Fetch the list of vendors associated with a trade via the `vendors` include ##### Available Includes (1) - **vendors** - Contacts assigned to this vendor trade (each with their `contact`) ##### Related Endpoints - `GET /maintenance/vendor-trades` - List all vendor trades - `POST /maintenance/vendor-trades/{vendorTradeID}` - Update a vendor trade Parameters: - `vendorTradeID` (path, integer, required): The unique vendor trade ID - `includes` (query, string): Comma-separated list of related objects. Available values: `vendors`. Responses: - `200`: Successfully retrieved vendor trade - `application/json`: object - `vendorTrade` (`vendor_trade`, required) - `vendors` (object[]): Vendor contacts assigned to this trade (if `includes=vendors`). Each item includes the contact sub-object. Example: ```json { "vendorTrade": { "vendorTradeID": "5", "name": "Plumbing", "isVisibleTenantPortal": "1" } } ``` - `400`: Vendor trade not found - `application/json`: object - `error` (string) Example: ```json { "error": "Maintenance Category 999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Vendor Trade `POST /maintenance/vendor-trades/{vendorTradeID}` Operation ID: `updateVendorTrade` Update an existing vendor trade (maintenance category). Requires the `ManageMaintenanceCategories` permission. ##### Use Cases - Rename a vendor trade - Toggle resident portal visibility for a trade ##### Business Rules - Requires **Manage Maintenance Categories** permission - Returns `400` with `"Maintenance Category {id} not found"` if the trade does not exist - On success, forwards to the GET detail endpoint and returns the updated trade wrapped in `vendorTrade` ##### Related Endpoints - `GET /maintenance/vendor-trades/{vendorTradeID}` - Get vendor trade details - `DELETE /maintenance/vendor-trades/{vendorTradeID}` - Delete a vendor trade - `GET /maintenance/vendor-trades` - List all vendor trades Parameters: - `vendorTradeID` (path, integer, required): The unique vendor trade ID to update Request body, required: - `application/json`: object - `name` (string, required): Name of the vendor trade / maintenance category - `isVisibleTenantPortal` (string | integer, required, one of "0", "1", 0, 1): Whether residents can select this trade when submitting work orders via the Resident Portal Example: ```json { "name": "Plumbing", "isVisibleTenantPortal": "1" } ``` Responses: - `200`: Vendor trade updated successfully - `application/json`: object - `vendorTrade` (`vendor_trade`, required) Example: ```json { "vendorTrade": { "vendorTradeID": "5", "name": "Plumbing", "isVisibleTenantPortal": "1" } } ``` - `400`: Validation error or trade not found - `application/json`: object - `error` (string) Example: ```json { "error": "Maintenance Category 999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Inspections #### List `GET /maintenance/inspections` Operation ID: `listInspections` List of inspections Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 15): Number of items per page Responses: - `200`: OK - `application/json`: `inspection`[] - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create `POST /maintenance/inspections` Operation ID: `createInspection` Request body: - `application/json`: `inspection_base` Responses: - `200`: OK - `application/json`: `inspection` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### View `GET /maintenance/inspections/{inspectionID}` Operation ID: `getInspection` View inspection Parameters: - `inspectionID` (path, integer, required) Responses: - `200`: OK - `application/json`: `inspection` - `401`: see shared response `error_401` - `429`: see shared response `error_429` ### Materials #### List Materials `GET /maintenance/materials` Operation ID: `listMaterials` Returns a paginated list of inventory materials available for use on work orders. ##### Use Cases - Search for a specific material by name, description, or UPC ##### Business Rules - `search` matches against `name`, `description`, and `upc` fields - `isActive` defaults to all active materials when omitted ##### Related Endpoints - `GET /maintenance/materials/{materialID}` — retrieve a single material with file detail - `POST /maintenance/materials` — create a new material - `POST /maintenance/materials/{materialID}` — update an existing material - `DELETE /maintenance/materials/{materialID}` — delete a material Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of results per page. Defaults to 25. - `search` (query, string): Full-text search against material name, description, and UPC - `isActive` (query, integer, one of 0, 1): Filter by active status. `1` = active, `0` = inactive - `purchasePriceMin` (query, number): Filter materials with a purchase price at or above this value - `purchasePriceMax` (query, number): Filter materials with a purchase price at or below this value - `sellPriceMin` (query, number): Filter materials with a sell price at or above this value - `sellPriceMax` (query, number): Filter materials with a sell price at or below this value - `orderBy` (query, string): Sort field in dot-notation. Prefix with `-` for descending order. Available values: `material.name`, `material.description`, `material.isActive`, `material.upc`, `material.purchasePrice`, `material.sellPrice` Responses: - `200`: Successfully retrieved materials - `application/json`: object[] - Each item: - `material` (`material`, required) Example: ```json [ { "material": { "materialID": "5", "name": "AC Vent", "description": "10 AC Vents for replacement", "isActive": "1", "upc": null, "purchasePrice": "8.00", "sellPrice": "20.00", "imageFileID": null, "dateTimeCreated": "2026-01-26 20:55:33", "dateTimeModified": "2026-01-26 20:55:33", "isDeleted": "0" }, "file": { "fileID": null, "title": null, "fileName": null, "fileType": null, "fileSize": null } }, { "material": { "materialID": "7", "name": "Batteries AAA", "description": null, "isActive": "1", "upc": null, "purchasePrice": "5.00", "sellPrice": "6.00", "imageFileID": null, "dateTimeCreated": "2026-02-12 13:09:36", "dateTimeModified": "2026-02-12 13:09:36", "isDeleted": "0" }, "file": { "fileID": null, "title": null, "fileName": null, "fileType": null, "fileSize": null } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Material `POST /maintenance/materials` Operation ID: `createMaterial` Creates a new maintenance material in the inventory catalog. On success, returns the full material detail (same shape as `GET /maintenance/materials/{materialID}`). ##### Use Cases - Add a new item to the materials catalog for use on work orders - Import materials from an external catalog by name and price ##### Business Rules - `name` and `sellPrice` are the only required fields - `isActive` defaults to `1` (active) when not supplied - `name` must be unique among non-deleted materials (max 200 characters) - `purchasePrice` and `sellPrice` must be valid decimal amounts ##### Related Endpoints - `GET /maintenance/materials` — list all materials - `GET /maintenance/materials/{materialID}` — retrieve the created material - `POST /maintenance/materials/{materialID}` — update an existing material Request body, required: - `application/json`: `material_base` Example: ```json { "name": "New Item Name", "sellPrice": "12.00" } ``` Responses: - `200`: Material created successfully - `application/json`: object - `material` (`material`, required) Example: ```json { "material": { "materialID": "13", "name": "New Item Name", "description": null, "isActive": "1", "upc": null, "purchasePrice": null, "sellPrice": "12.00", "imageFileID": null, "dateTimeCreated": "2026-04-24 22:41:08", "dateTimeModified": "2026-04-24 22:41:08", "isDeleted": "0" } } ``` - `400`: Validation error - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Material `GET /maintenance/materials/{materialID}` Operation ID: `getMaterial` Retrieves a single maintenance material by ID ##### Use Cases - Display full material detail in a management UI - Verify material data after creation or update ##### Business Rules - Returns `400` with `"Material {id} not found"` if the material does not exist or has been deleted ##### Related Endpoints - `GET /maintenance/materials` — list all materials - `POST /maintenance/materials/{materialID}` — update this material - `DELETE /maintenance/materials/{materialID}` — delete this material Parameters: - `materialID` (path, integer, required): The unique material ID Responses: - `200`: Successfully retrieved material - `application/json`: object - `material` (`material`, required) - `file` (object, required): Image file associated with the material, if any - `fileID` (string | null, pattern `^-?[0-9]+$`): Unique file identifier - `title` (string | null): File title - `fileName` (string | null): Original file name - `fileType` (string | null): MIME type of the file - `fileSize` (string | null, pattern `^-?[0-9]+$`): File size in bytes Example: ```json { "material": { "materialID": "8", "name": "Drywall", "description": "Home Depot", "isActive": "1", "upc": null, "purchasePrice": "200.00", "sellPrice": "300.00", "imageFileID": null, "dateTimeCreated": "2026-02-27 16:19:22", "dateTimeModified": "2026-02-27 16:19:22", "isDeleted": "0" }, "file": { "fileID": null, "title": null, "fileName": null, "fileType": null, "fileSize": null } } ``` - `400`: Material not found - `application/json`: object - `error` (string) Example: ```json { "error": "Material 8 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Material `POST /maintenance/materials/{materialID}` Operation ID: `updateMaterial` Updates an existing maintenance material. Only send the fields you want to change — omitted fields are left unchanged. On success, returns the full updated material detail. ##### Use Cases - Adjust the sell price of a material after a supplier price change - Update the description or UPC of an existing item ##### Business Rules - Returns `400` with `"Material {id} not found"` if the material does not exist - `name` must remain unique among non-deleted materials if changed - `purchasePrice` and `sellPrice` must be valid decimal amounts when supplied ##### Related Endpoints - `GET /maintenance/materials/{materialID}` — retrieve current material state - `GET /maintenance/materials` — list all materials - `DELETE /maintenance/materials/{materialID}` — delete this material Parameters: - `materialID` (path, integer, required): The unique material ID Request body, required: - `application/json`: object - `name` (string, max length 200): Display name of the material - `description` (string | null, max length 4000): Optional description or supplier note - `isActive` (string | integer, one of "0", "1", 0, 1): Active status. `1` = active, `0` = inactive - `upc` (string | null): Universal Product Code - `purchasePrice` (string | number | null, decimal): Cost to purchase the material (decimal as string) - `sellPrice` (string | number, decimal): Price charged when the material is used on a work order - `imageFileID` (string | integer | null, pattern `^-?[0-9]+$`): File ID of an associated image Example: ```json { "sellPrice": "10.00" } ``` Responses: - `200`: Material updated successfully - `application/json`: object - `material` (`material`, required) Example: ```json { "material": { "materialID": "13", "name": "New Item Name", "description": null, "isActive": "1", "upc": null, "purchasePrice": null, "sellPrice": "10.00", "imageFileID": null, "dateTimeCreated": "2026-04-24 22:41:08", "dateTimeModified": "2026-04-24 22:43:00", "isDeleted": "0" } } ``` - `400`: Material not found or validation error - `application/json`: object - `error` (string) Example: ```json { "error": "Material 13 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Material `DELETE /maintenance/materials/{materialID}` Operation ID: `deleteMaterial` Deletes a maintenance material by setting `isDeleted = 1`. The record is retained in the database and the response includes the final state of the material. ##### Use Cases - Remove a discontinued item from the active material catalog - Clean up test or duplicate materials ##### Business Rules - Returns `400` with `"Material {id} not found"` if the material does not exist\ - Deleted materials no longer appear in `GET /maintenance/materials` list results - Deletion is a permanent delete: the record is removed from the database ##### Related Endpoints - `GET /maintenance/materials` — list active materials - `POST /maintenance/materials` — create a replacement material Parameters: - `materialID` (path, integer, required): The unique material ID to delete Responses: - `200`: Material deleted successfully. Returns the final state of the deleted material. - `application/json`: object - `materialID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the material - `name` (string, required): Display name of the material - `description` (string | null): Optional description or supplier note - `isActive` (string, one of "0", "1"): Active status - `upc` (string | null): Universal Product Code - `purchasePrice` (string | null, decimal): Cost to purchase the material - `sellPrice` (string, decimal): Price charged when the material is used on a work order - `imageFileID` (string | null, pattern `^-?[0-9]+$`): File ID of the associated image - `dateTimeCreated` (string, required, read-only): Timestamp when the material was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp of the delete operation. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isDeleted` (integer, required, read-only, one of 1): Soft-delete flag. Always `1` in this response, sent as the JSON integer `1`: the delete sets it in memory and the response is built from the model without re-reading it. Every other material response, including `POST /maintenance/materials`, sends it as the string `'0'` or `'1'`. Example: ```json { "materialID": "13", "name": "New Item Name", "description": null, "isActive": "1", "upc": null, "purchasePrice": null, "sellPrice": "10.00", "imageFileID": null, "dateTimeCreated": "2026-04-24 22:41:08", "dateTimeModified": "2026-04-24 22:46:20", "isDeleted": 1 } ``` - `400`: Material not found - `application/json`: object - `error` (string) Example: ```json { "error": "Material 13 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Labor Rates #### List Labor Rates `GET /maintenance/labor-rates` Operation ID: `listLaborRates` Returns a paginated list of maintenance labor rates. Supports full-text search and rate-range filtering. Results exclude soft-deleted records by default. ##### Use Cases - Search for a specific rate by name ##### Business Rules - `search` matches against the `name` field ##### Related Endpoints - `GET /maintenance/labor-rates/{laborRateID}` — retrieve a single labor rate - `POST /maintenance/labor-rates` — create a new labor rate - `POST /maintenance/labor-rates/{laborRateID}` — update an existing labor rate - `DELETE /maintenance/labor-rates/{laborRateID}` — delete a labor rate Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of results per page. Defaults to 25. - `search` (query, string): Full-text search against labor rate name - `laborRateID` (query, integer): Filter to a specific labor rate by ID - `laborRateIDs` (query, string): Filter to a set of labor rate IDs (comma-separated) - `rateMin` (query, number): Filter labor rates with a rate at or above this value - `rateMax` (query, number): Filter labor rates with a rate at or below this value - `isDeleted` (query, integer, one of 0, 1, default 0): Filter by deleted status. Defaults to `0` (active only). Pass `1` to include deleted records. - `orderBy` (query, string): Sort field in dot-notation. Prefix with `-` for descending order. Available values: `laborRate.name`, `laborRate.rate`, `laborRate.hourlyRate` Responses: - `200`: Successfully retrieved labor rates - `application/json`: object[] - Each item: - `laborRate` (`labor_rate`, required) Example: ```json [ { "laborRate": { "laborRateID": "2", "name": "Company Labor Rate", "description": null, "rate": "75.00", "hourlyRate": "55.00", "isDeleted": "0", "dateTimeCreated": "2025-08-07 14:16:24", "dateTimeModified": "2026-02-12 12:56:16" } }, { "laborRate": { "laborRateID": "3", "name": "Trip Charge", "description": null, "rate": "75.00", "hourlyRate": null, "isDeleted": "0", "dateTimeCreated": "2025-08-07 20:45:22", "dateTimeModified": "2025-08-07 20:45:22" } }, { "laborRate": { "laborRateID": "7", "name": "Jake Internal Maintenance Tech", "description": "Test", "rate": "25.00", "hourlyRate": "20.00", "isDeleted": "0", "dateTimeCreated": "2026-02-27 16:18:41", "dateTimeModified": "2026-02-27 16:18:41" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Labor Rate `POST /maintenance/labor-rates` Operation ID: `createLaborRate` Creates a new maintenance labor rate. On success, returns the created labor rate as a flat object. ##### Use Cases - Add a new labor rate to the catalog for use on work order line items ##### Business Rules - `name`, `rate`, and `hourlyRate` are required; `description` is optional - `name` must be unique among non-deleted labor rates - `rate` and `hourlyRate` must be non-negative decimal amounts; zero is allowed ##### Related Endpoints - `GET /maintenance/labor-rates` — list all labor rates - `GET /maintenance/labor-rates/{laborRateID}` — retrieve the created labor rate - `POST /maintenance/labor-rates/{laborRateID}` — update an existing labor rate Request body, required: - `application/json`: `labor_rate_base` Example: ```json { "name": "New Labor Item", "rate": "5.00" } ``` Responses: - `200`: Labor rate created successfully. Returns a flat object (no wrapper key). - `application/json`: `labor_rate` Example: ```json { "laborRateID": "8", "name": "New Labor Item", "description": null, "rate": "5.00", "hourlyRate": "10.00", "isDeleted": "0", "dateTimeCreated": "2026-04-24 23:04:24", "dateTimeModified": "2026-04-24 23:04:24" } ``` - `400`: Validation error - `application/json`: object - `error` (string) Example: ```json { "error": "Invalid JSON data" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Labor Rate `GET /maintenance/labor-rates/{laborRateID}` Operation ID: `getLaborRate` Retrieves a single maintenance labor rate by ID. Returns a flat object (no wrapper key). ##### Use Cases - Display full labor rate detail in a management UI - Verify labor rate data after creation or update ##### Business Rules - Returns `400` with `"Labor Rate {id} not found"` if the labor rate does not exist ##### Related Endpoints - `GET /maintenance/labor-rates` — list all labor rates - `POST /maintenance/labor-rates/{laborRateID}` — update this labor rate - `DELETE /maintenance/labor-rates/{laborRateID}` — delete this labor rate Parameters: - `laborRateID` (path, integer, required): The unique labor rate ID Responses: - `200`: Successfully retrieved labor rate. Returns a flat object (no wrapper key). - `application/json`: `labor_rate` Example: ```json { "laborRateID": "7", "name": "Jake Internal Maintenance Tech", "description": "Test", "rate": "25.00", "hourlyRate": "20.00", "isDeleted": "0", "dateTimeCreated": "2026-02-27 16:18:41", "dateTimeModified": "2026-02-27 16:18:41" } ``` - `400`: Labor rate not found - `application/json`: object - `error` (string) Example: ```json { "error": "Labor Rate 7 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Labor Rate `POST /maintenance/labor-rates/{laborRateID}` Operation ID: `updateLaborRate` Updates an existing maintenance labor rate. Only send the fields you want to change — omitted fields are left unchanged. Returns the updated labor rate as a flat object. ##### Use Cases - Adjust the rate for a labor type after a cost review - Update the name or description of an existing rate - Set the hourly rate on a labor item that previously had none ##### Business Rules - Returns `400` with `"Labor Rate {id} not found"` if the labor rate does not exist - `name` must remain unique among non-deleted labor rates if changed - `rate` and `hourlyRate` must be non-negative decimal amounts when supplied; zero is allowed - `laborRateID`, `dateTimeCreated`, and `dateTimeModified` in the request body are accepted but ignored ##### Related Endpoints - `GET /maintenance/labor-rates/{laborRateID}` — retrieve current labor rate state - `GET /maintenance/labor-rates` — list all labor rates - `DELETE /maintenance/labor-rates/{laborRateID}` — delete this labor rate Parameters: - `laborRateID` (path, integer, required): The unique labor rate ID Request body, required: - `application/json`: object - `name` (string, max length 200): Display name of the labor rate - `description` (string | null, max length 4000): Optional description - `rate` (string | number, decimal): Flat rate charged (decimal as string). Zero is allowed. - `hourlyRate` (string | number | null, decimal): Hourly cost rate (decimal as string). Zero is allowed. Example: ```json { "rate": "0.00" } ``` Responses: - `200`: Labor rate updated successfully. Returns a flat object (no wrapper key). - `application/json`: `labor_rate` Example: ```json { "laborRateID": "7", "name": "Jake Internal Maintenance Tech", "description": "Test", "rate": "0.00", "hourlyRate": "20.00", "isDeleted": "0", "dateTimeCreated": "2026-02-27 16:18:41", "dateTimeModified": "2026-02-27 16:18:41" } ``` - `400`: Labor rate not found or validation error - `application/json`: object - `error` (string) Example: ```json { "error": "Labor Rate 7 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Labor Rate `DELETE /maintenance/labor-rates/{laborRateID}` Operation ID: `deleteLaborRate` Deletes a labor rate from the catalog. The record is removed from the database. Returns a success confirmation. ##### Use Cases - Remove a discontinued labor rate from the active catalog - Clean up duplicate or test labor rates ##### Business Rules - Returns `400` with `"Labor Rate {id} not found"` if the labor rate does not exist - Deleted labor rates no longer appear in `GET /maintenance/labor-rates` by default ##### Related Endpoints - `GET /maintenance/labor-rates` — list active labor rates - `POST /maintenance/labor-rates` — create a replacement labor rate Parameters: - `laborRateID` (path, integer, required): The unique labor rate ID to delete Responses: - `200`: Labor rate deleted successfully. - `application/json`: object - `success` (boolean, required): Always `true` on successful deletion - `message` (string | null, required): Confirmation message Example: ```json { "success": true, "message": "Labor rate deleted successfully" } ``` - `400`: Labor rate not found - `application/json`: object - `error` (string) Example: ```json { "error": "Labor Rate 7 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ## Portfolios ### Portfolios #### List Portfolios `GET /portfolios` Operation ID: `listPortfolios` Returns a paginated list of portfolios with their associated statement settings. Each result item wraps the portfolio and its statement setting in keyed properties. Use `/portfolios/search` for advanced filtering by reserve amount, hold distributions, tags, portfolio groups, and assigned users. ##### Use Cases - Display a paginated list of all portfolios in the account - Filter to active or inactive portfolios - Filter to portfolios that send statements - Exclude a specific portfolio from results (e.g., for a reassignment UI) ##### Business Rules - Results are scoped to the authenticated account; cross-account data is never returned - Portfolio access is restricted based on the user's portfolio group assignments - `isActive` defaults to `1` — only active portfolios are returned unless explicitly set to `0` ##### Related Endpoints - `GET /portfolios/search` - Advanced filtered search with denormalized columns and additional filters - `GET /portfolios/{portfolioID}` - Full portfolio detail with optional includes Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Free-text search across portfolio name and owner contact names. - `isActive` (query, boolean) - `sendStatements` (query, integer, one of 0, 1): Filter to portfolios that have statement sending enabled (`1`) or disabled (`0`). - `excludePortfolioID` (query, integer): Exclude a specific portfolio from results by its ID. Responses: - `200`: Successfully retrieved portfolios. - `application/json`: object[] - Each item: - `portfolio` (`portfolio`, required) - `token` (string, required): Opaque pagination token for this row. Example: ```json [ { "portfolio": { "portfolioID": "279", "code": null, "name": "123 Main St", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "name": "Test holder" }, { "contactID": "3444", "percentOwned": "0.0000", "percentDistributed": "5.0000", "name": "Johnson and Smith" }, { "contactID": "2992", "percentOwned": "0.0000", "percentDistributed": "10.0000", "name": "Angel Deca Test" } ], "postingSettingID": "13", "assignedToUserID": "491061", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2025-03-20 19:51:20", "dateTimeModified": "2026-04-22 18:00:15", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null }, "token": "1776988961" } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Portfolio `POST /portfolios` Operation ID: `createPortfolio` Creates a new portfolio with the provided name, financial settings, owner assignments, and optional group memberships. On success the newly created portfolio is returned in the same shape as `GET /portfolios/{portfolioID}`. ##### Use Cases - Create a new owner portfolio when onboarding a property owner - Programmatically provision portfolios with pre-configured reserve and distribution rules - Bulk-create portfolios during a data migration by supplying `attachments` file IDs ##### Business Rules - Requires the `UpdatePortfolio` permission - `owners` must be supplied as an array; each entry requires `contactID`, `percentOwned`, and `percentDistributed` - `isLiveLedgerEnabled` accepts `-1` to reset the value to `null` (account default); any other value is stored as-is - `portfolioGroupIDs` assigns the new portfolio to one or more portfolio groups - `attachments` is an array of existing file IDs to attach to the portfolio on creation ##### Related Endpoints - `GET /portfolios/{portfolioID}` - Retrieve the created portfolio - `POST /portfolios/{portfolioID}` - Update portfolio settings - `POST /portfolios/{portfolioID}/owners` - Sync owner list after creation Request body, required: - `application/json`: object - `name` (string, required): Display name of the portfolio. - `code` (string | null): Optional short reference code for the portfolio. - `postingSettingID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the posting setting template to assign. - `statementSettingID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the statement setting template to assign. - `sendStatements` (string | integer, one of "0", "1", 0, 1): Whether to send owner statements. `1` = enabled, `0` = disabled. - `payoutAmount` (string | null): Fixed payout amount (decimal string), if applicable. - `fiscalYearEndMonth` (string | integer, pattern `^-?[0-9]+$`): Month number (1–12) when the fiscal year ends. - `minimumDistributionAmount` (string | number, decimal): Minimum distribution amount (decimal string). - `maximumDistributionAmount` (string | number, decimal): Maximum distribution amount per cycle (decimal string). - `overdraftOverrideAmount` (string | number, decimal): Amount the balance can go negative before blocking transactions (decimal string). - `additionalReserveAmount` (string | number, decimal): Additional reserve on top of the base reserve (decimal string). - `additionalReserveDescription` (string | null): Explanation of the additional reserve amount. - `holdDistributions` (string | integer, one of "0", "1", 0, 1): Whether to hold distributions. `1` = held, `0` = normal. - `isLiveLedgerEnabled` (string | integer | null, one of "0", "1", 0, 1, null): Real-time ledger updates. Pass `-1` to reset to account default (stored as `null`). - `isBalanceNoticeDisabled` (string | integer, one of "0", "1", 0, 1): Whether to suppress balance notice emails. `1` = disabled, `0` = enabled. - `owners` (object[]): Initial owner assignments for the portfolio. - `contactID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the contact to assign as an owner. - `percentOwned` (string | number, decimal, required): Ownership percentage (0–100). - `percentDistributed` (string | number, decimal, required): Distribution percentage (0–100). - `portfolioGroupIDs` (integer[]): IDs of portfolio groups to add this portfolio to. - `attachments` (integer[]): File IDs to attach to the new portfolio. Example: ```json { "name": "456 Oak Ave - Johnson", "postingSettingID": 3, "statementSettingID": 1, "sendStatements": 1, "fiscalYearEndMonth": 12, "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "overdraftOverrideAmount": "100.00", "additionalReserveAmount": "0.00", "holdDistributions": 0, "isBalanceNoticeDisabled": 0, "owners": [ { "contactID": 4679, "percentOwned": "100.00", "percentDistributed": "100.00" } ] } ``` Responses: - `200`: Portfolio created successfully. Returns the new portfolio detail. - `application/json`: object - `portfolio` (`portfolio`, required) Example: ```json { "portfolio": { "portfolioID": "312", "code": "OAK-456", "name": "456 Oak Ave - Johnson", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "100.0000", "name": "Robert Johnson" } ], "postingSettingID": "3", "assignedToUserID": null, "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2026-04-23 10:15:00", "dateTimeModified": "2026-04-23 10:15:00", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null } } ``` - `400`: Invalid request body or creation failed. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Portfolios `GET /portfolios/search` Operation ID: `searchPortfolios` Performs an advanced, paginated search across portfolios. Returns denormalized rows combining portfolio data, statement setting details, derived property counts, owner contact names, and the most recent statement — ideal for list views and reporting dashboards. ##### Use Cases - Power the portfolio list UI with rich filter controls (reserve range, hold status, tags, assigned users) - Find portfolios by portfolio group, property group, or payout batch membership - Retrieve portfolios modified within a date range for sync/integration workflows ##### Business Rules - Results are scoped to the authenticated account; cross-account data is never returned - Portfolio access is restricted based on the user's portfolio group assignments - `propertyCount` is a derived column counting properties currently assigned to the portfolio - `contactNames` is a derived comma-separated string of owner contact names ##### Related Endpoints - `GET /portfolios` - Basic paginated list (fewer filters, lighter payload) - `GET /portfolios/{portfolioID}` - Full portfolio detail with optional includes Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of results per page. - `search` (query, string): Free-text search across portfolio name, code, and owner contact names. - `isActive` (query, integer, one of 0, 1): Filter by active status. Pass `1` for active, `0` for inactive. - `portfolioIDs[]` (query, integer[]): Filter to specific portfolios by ID. Pass multiple values as `portfolioIDs[0]=150&portfolioIDs[1]=200`. - `postingSettingIDs[]` (query, integer[]): Filter to portfolios using specific posting settings. - `statementSettingIDs[]` (query, integer[]): Filter to portfolios using specific statement settings. - `portfolioGroupIDs[]` (query, integer[]): Filter to portfolios belonging to specific portfolio groups. - `propertyGroupIDs[]` (query, integer[]): Filter to portfolios that have at least one property in the specified property groups. - `tagIDs[]` (query, integer[]): Filter to portfolios tagged with specific tag IDs. - `reserveAmountMin` (query, number): Filter to portfolios with a reserve amount at or above this value. - `reserveAmountMax` (query, number): Filter to portfolios with a reserve amount at or below this value. - `holdDistributions` (query, integer, one of 0, 1): Filter by distribution hold status. `1` returns portfolios with distributions on hold. - `hasAdditionalReserve` (query, integer, one of 0, 1): Filter to portfolios that have an additional reserve amount greater than zero. - `sendStatements` (query, integer, one of 0, 1): Filter by statement sending preference. - `dateTimeModifiedMin` (query, string, date-time): Filter to portfolios modified on or after this datetime (ISO 8601). - `dateTimeModifiedMax` (query, string, date-time): Filter to portfolios modified on or before this datetime (ISO 8601). - `dateClosedMin` (query, string, date): Filter to portfolios closed on or after this date. - `dateClosedMax` (query, string, date): Filter to portfolios closed on or before this date. - `portfolioAssignedToUserIDs[]` (query, integer[]): Filter to portfolios assigned to specific users. - `propertyAssignedToUserIDs[]` (query, integer[]): Filter to portfolios that have at least one property assigned to specific users. - `payoutBatchID` (query, integer): Filter to portfolios included in a specific payout batch. - `orderBy` (query, string): Field to sort results by. Responses: - `200`: Successfully retrieved matching portfolios. - `application/json`: object[] - Each item: - `portfolio` (object, required) - `isActive` (string, required, one of "0", "1"): Whether the portfolio is active. `"1"` = active, `"0"` = inactive. - `portfolioID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the portfolio. - `code` (string | null): Optional short code for the portfolio. - `name` (string, required): Display name of the portfolio. - `contacts` (string | null, required): JSON-encoded array of owner contacts with ownership and distribution percentages. - `postingSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the posting setting configuration for this portfolio. - `minimumDistributionAmount` (string | null, decimal, required): Minimum distribution amount (decimal string). - `maximumDistributionAmount` (string | null, decimal): Maximum distribution amount per cycle (decimal string). `null` means no cap. - `reserveAmount` (string, decimal, required): Required reserve balance (decimal string). - `additionalReserveAmount` (string, decimal, required): Additional reserve amount on top of the base reserve (decimal string). - `additionalReserveDescription` (string | null): Explanation of the additional reserve amount. - `overdraftOverrideAmount` (string | null, decimal, required): Amount the portfolio balance may go negative before blocking transactions (decimal string). - `fiscalYearEndMonth` (string, required, pattern `^-?[0-9]+$`): Month number (1–12) when the fiscal year ends for this portfolio. - `statementSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the statement setting configuration. - `sendStatements` (string, required, one of "0", "1"): Whether statements are sent to owners. `"1"` = enabled, `"0"` = disabled. - `holdDistributions` (string, required, one of "0", "1"): Whether distributions are on hold. `"1"` = held, `"0"` = normal. - `dateTimeCreated` (string | null, required, read-only): Timestamp when the portfolio was created (MySQL datetime format). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the portfolio was last modified (MySQL datetime format). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Timestamp when the portfolio was deactivated, or `null` if still active. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateClosed` (string | null, date): Date the portfolio was closed (YYYY-MM-DD), or `null` if still open. - `propertyCount` (string, required): Number of properties currently assigned to this portfolio. - `contactNames` (string, required): Comma-separated list of owner contact names. - `statementSetting` (object, required) - `statementSettingID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the statement setting. - `name` (string, required): Display name of the statement setting. - `lastStatement` (object | null, required): Most recent statement for this portfolio, or `null` if none exists. - `name` (string, required): Human-readable label for the statement period (e.g. "02/14/2026 to 03/13/2026"). - `startDate` (string | null, date, required): Start date of the statement period (YYYY-MM-DD). - `endDate` (string, date, required): End date of the statement period (YYYY-MM-DD). Example: ```json [ { "portfolio": { "isActive": "0", "portfolioID": "210", "code": "2447", "name": "(NEW) Adrians Portfolio test", "contacts": "[{\"contactID\":\"2086\",\"percentOwned\":\"100.0000\",\"percentDistributed\":\"100.0000\",\"name\":\"(NEW) Adrians Portfolio test\"},{\"contactID\":\"4115\",\"percentOwned\":\"0.0000\",\"percentDistributed\":\"0.0000\",\"name\":\"test man jones jr the third\"}]", "postingSettingID": "5", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": null, "reserveAmount": "0.00", "additionalReserveAmount": "500.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "1000000.00", "fiscalYearEndMonth": "12", "statementSettingID": "62", "sendStatements": "1", "holdDistributions": "0", "dateTimeCreated": "2024-06-23 21:38:02", "dateTimeModified": "2026-03-20 20:04:50", "dateTimeDeactivated": "2026-03-20 20:03:42", "dateClosed": "2026-03-20", "propertyCount": "0", "contactNames": "(NEW) Adrians Portfolio test, test man jones jr the third, Amber TEST, Vasco Lambert, Mario" }, "statementSetting": { "statementSettingID": "62", "name": "2023" }, "lastStatement": { "name": "02/14/2026 to 03/13/2026", "startDate": "2026-02-14", "endDate": "2026-03-13" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Portfolio `GET /portfolios/{portfolioID}` Operation ID: `getPortfolio` Returns the full detail for a single portfolio by its ID. The response always includes the core portfolio object; additional related data can be requested via the `includes` query parameter. ##### Use Cases - Load a portfolio detail page in the manager UI - Fetch owner and ledger context for distribution or accounting workflows ##### Business Rules - Access is restricted to portfolios the authenticated user's portfolio group assignments permit - `isLiveLedgerEnabled` of `null` means the account-level default applies; `-1` is used by the update endpoint to reset to null, but the GET response always returns `null` or a boolean ##### Available Includes (4) - `owners` — List of portfolio owners, each with contact data included - `ledger` — The portfolio's accounting ledger record - `posting` — The posting setting template assigned to the portfolio - `statementSetting` — The statement setting template assigned to the portfolio ##### Related Endpoints - `GET /portfolios` - Paginated portfolio list - `GET /portfolios/{portfolioID}/owners` - List owners for the portfolio - `GET /portfolios/{portfolioID}/statements` - List statements for the portfolio Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio to retrieve. - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `owners`, `ledger`, `posting`, `statementSetting` Responses: - `200`: Successfully retrieved the portfolio. - `application/json`: object - `portfolio` (`portfolio`, required) - `owners` (object[]): Portfolio owners with contact data (if includes=owners). - `portfolioOwner` (`portfolio_owner`) - `contact` (object): The contact record for this owner. - `ledger` (object | null): The portfolio's accounting ledger record (if includes=ledger). - `ledgerID` (string, pattern `^-?[0-9]+$`) - `ledgerTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) - `balance` (string) - `posting` (object | null): The posting setting template (if includes=posting). - `postingSettingID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `statementSetting` (`statement_setting`) Example: ```json { "portfolio": { "portfolioID": "279", "code": null, "name": "123 Main St- Amber Negron", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "name": "Test holder" }, { "contactID": "3444", "percentOwned": "0.0000", "percentDistributed": "5.0000", "name": "(Redacted) and Miggy" }, { "contactID": "2992", "percentOwned": "0.0000", "percentDistributed": "10.0000", "name": "Angel Deca Test" } ], "postingSettingID": "13", "assignedToUserID": "491061", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2025-03-20 19:51:20", "dateTimeModified": "2026-04-22 18:00:15", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null } } ``` - `400`: Portfolio not found or invalid request. - `application/json`: object - `error` (string) Example: ```json { "error": "Invalid Request" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Update Portfolio `POST /portfolios/{portfolioID}` Operation ID: `updatePortfolio` Updates the settings for an existing portfolio. Only the fields present in the request body are written; omitted fields retain their current values. On success the updated portfolio is returned in the same shape as `GET /portfolios/{portfolioID}`. ##### Use Cases - Edit reserve amounts, distribution thresholds, or posting/statement settings - Reassign the portfolio to a different user (`assignedToUserID`) - Close a portfolio by setting `dateClosed` - Toggle live ledger, balance notices, or distribution hold ##### Business Rules - Requires the `UpdatePortfolio` permission - The caller must be permitted to access this portfolio via portfolio group restrictions - `isLiveLedgerEnabled` accepts `-1` to reset the value to `null` (account default) - `dateClosed` accepts an ISO date string (`YYYY-MM-DD`); set to `null` to reopen ##### Related Endpoints - `GET /portfolios/{portfolioID}` - Retrieve current portfolio state - `POST /portfolios/{portfolioID}/activate` - Reactivate a deactivated portfolio - `POST /portfolios/{portfolioID}/deactivate` - Deactivate a portfolio - `POST /portfolios/{portfolioID}/owners` - Sync the owner list independently Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio to update. Request body, required: - `application/json`: object - `name` (string): Display name of the portfolio. - `code` (string | null): Optional short reference code. - `postingSettingID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the posting setting template to assign. - `statementSettingID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the statement setting template to assign. - `sendStatements` (string | integer, one of "0", "1", 0, 1): Whether to send owner statements. - `fiscalYearEndMonth` (string | integer, pattern `^-?[0-9]+$`): Month number (1–12) when the fiscal year ends. - `minimumDistributionAmount` (string | number, decimal): Minimum distribution amount (decimal string). - `maximumDistributionAmount` (string | number, decimal): Maximum distribution amount per cycle (decimal string). - `overdraftOverrideAmount` (string | number, decimal): Amount the balance can go negative before blocking transactions (decimal string). - `additionalReserveAmount` (string | number, decimal): Additional reserve on top of the base reserve (decimal string). - `additionalReserveDescription` (string | null): Explanation of the additional reserve amount. - `holdDistributions` (string | integer, one of "0", "1", 0, 1): Whether to hold distributions. - `holdDistributionsDescription` (string | null): Reason distributions are being held. - `isLiveLedgerEnabled` (string | integer | null, one of "0", "1", 0, 1, null): Real-time ledger updates. Pass `-1` to reset to account default (stored as `null`). - `isBalanceNoticeDisabled` (string | integer, one of "0", "1", 0, 1): Whether to suppress balance notice emails. - `dateClosed` (string | null, date): Date the portfolio was closed (YYYY-MM-DD). Set to `null` to reopen. - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the user assigned to manage this portfolio. Example: ```json { "name": "456 Oak Ave - Johnson (Updated)", "reserveAmount": "750.00", "maximumDistributionAmount": "6000.00", "assignedToUserID": 491061, "holdDistributions": 0 } ``` Responses: - `200`: Portfolio updated successfully. Returns the updated portfolio detail. - `application/json`: object - `portfolio` (`portfolio`, required) Example: ```json { "portfolio": { "portfolioID": "279", "code": null, "name": "456 Oak Ave - Johnson (Updated)", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "name": "Test holder" } ], "postingSettingID": "13", "assignedToUserID": "491061", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "6000.00", "reserveAmount": "750.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2025-03-20 19:51:20", "dateTimeModified": "2026-04-23 11:30:00", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null } } ``` - `400`: Invalid request or portfolio not found. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Activate Portfolio `POST /portfolios/{portfolioID}/activate` Operation ID: `activatePortfolio` Reactivates a previously deactivated portfolio. On success the updated portfolio is returned in the same shape as `GET /portfolios/{portfolioID}`. ##### Use Cases - Reactivate a portfolio that was deactivated in error - Restore a portfolio after a temporary hold period ##### Business Rules - Requires the `UpdatePortfolio` permission - The caller must be permitted to access this portfolio via portfolio group restrictions - No request body is required; the action takes no input fields - Sets `isActive` to `"1"` and clears `dateTimeDeactivated` ##### Related Endpoints - `POST /portfolios/{portfolioID}/deactivate` - Deactivate a portfolio - `GET /portfolios/{portfolioID}` - Retrieve current portfolio state Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio to activate. Responses: - `200`: Portfolio activated successfully. Returns the updated portfolio detail. - `application/json`: object - `portfolio` (`portfolio`, required) Example: ```json { "portfolio": { "portfolioID": "279", "code": null, "name": "123 Main St - Amber Negron", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "name": "Test holder" } ], "postingSettingID": "13", "assignedToUserID": "491061", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "1", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2025-03-20 19:51:20", "dateTimeModified": "2026-04-23 12:00:00", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": null } } ``` - `400`: Portfolio not found or activation failed. - `application/json`: object - `error` (string) Example: ```json { "error": "Portfolio279 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Deactivate Portfolio `POST /portfolios/{portfolioID}/deactivate` Operation ID: `deactivatePortfolio` Deactivates an active portfolio, optionally recording a closure date. On success the updated portfolio is returned in the same shape as `GET /portfolios/{portfolioID}`. ##### Use Cases - Mark a portfolio as inactive when the management agreement ends - Close a portfolio and record the official closure date for accounting purposes ##### Business Rules - Requires the `UpdatePortfolio` permission - The caller must be permitted to access this portfolio via portfolio group restrictions - `dateClosed` is optional; when supplied it must be a valid date string (`YYYY-MM-DD`) - Sets `isActive` to `"0"` and records `dateTimeDeactivated` ##### Related Endpoints - `POST /portfolios/{portfolioID}/activate` - Reactivate a deactivated portfolio - `GET /portfolios/{portfolioID}` - Retrieve current portfolio state Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio to deactivate. Request body: - `application/json`: object - `dateClosed` (string | null, date): Date the portfolio was officially closed (YYYY-MM-DD). Example: ```json { "dateClosed": "2026-04-30" } ``` Responses: - `200`: Portfolio deactivated successfully. Returns the updated portfolio detail. - `application/json`: object - `portfolio` (`portfolio`, required) Example: ```json { "portfolio": { "portfolioID": "279", "code": null, "name": "123 Main St - Amber Negron", "contacts": [ { "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "name": "Test holder" } ], "postingSettingID": "13", "assignedToUserID": "491061", "minimumDistributionAmount": "0.00", "maximumDistributionAmount": "5000.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "additionalReserveDescription": null, "overdraftOverrideAmount": "100.00", "fiscalYearEndMonth": "12", "statementSettingID": "1", "sendStatements": "1", "holdDistributions": "0", "holdDistributionsDescription": null, "isActive": "0", "isLiveLedgerEnabled": null, "isBalanceNoticeDisabled": "0", "dateTimeCreated": "2025-03-20 19:51:20", "dateTimeModified": "2026-04-23 14:00:00", "dateTimeDeactivated": "2026-04-23 14:00:00", "isFromImport": "0", "importSourceKey": null, "isPublicStatementEnabled": "1", "dateClosed": "2026-04-30" } } ``` - `400`: Invalid request body or portfolio not found. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Portfolio Owners `GET /portfolios/{portfolioID}/owners` Operation ID: `listPortfolioOwners` Returns a list of owners for a specific portfolio. Each item contains an `owner` object with the ownership and payout configuration, plus a `token` value used for cache validation. Use the `includes` parameter to attach the full contact record for each owner. ##### Use Cases - Display the owner list on a portfolio detail page - Build owner distribution summaries or payout previews - Fetch owner data for ACH / check payout workflows ##### Business Rules - The caller must have access to the specified portfolio (enforced via portfolio group restrictions) - Results are not paginated at the model level when includes are used; the search returns all owners for the portfolio ##### Available Includes (1) - `contact` — The full contact record for the owner (name, email, address, phone numbers) ##### Related Endpoints - `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}` - Single owner detail with includes - `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details` - Decrypted ACH bank account info - `GET /portfolios/{portfolioID}` - Portfolio detail (also supports owners include) Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio whose owners to retrieve. - `search` (query, string): Free-text search across owner contact names. - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `contact` Responses: - `200`: Successfully retrieved portfolio owners. - `application/json`: object[] - Each item: - `owner` (`portfolio_owner`, required) - `token` (string, required): Cache token for the owner record. Example: ```json [ { "owner": { "portfolioOwnerID": "536", "portfolioID": "279", "contactID": "4679", "percentOwned": "100.0000", "percentDistributed": "85.0000", "overrideContactPayoutSettings": "0", "payeeName": "Robert Harmon", "payoutTypeID": "3", "achDetailsCiphertextID": "1021", "achAccountNumberTruncated": "8842", "achAccountTypeID": "2", "achIsCorporateAccount": "0" }, "token": "1776991733" }, { "owner": { "portfolioOwnerID": "556", "portfolioID": "279", "contactID": "3444", "percentOwned": "0.0000", "percentDistributed": "5.0000", "overrideContactPayoutSettings": "1", "payeeName": "Sandra Villanueva", "payoutTypeID": "2", "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0" }, "token": "1776991733" }, { "owner": { "portfolioOwnerID": "641", "portfolioID": "279", "contactID": "2992", "percentOwned": "0.0000", "percentDistributed": "10.0000", "overrideContactPayoutSettings": "0", "payeeName": "Westfield Capital LLC", "payoutTypeID": "4", "achDetailsCiphertextID": "1087", "achAccountNumberTruncated": "3301", "achAccountTypeID": "1", "achIsCorporateAccount": "1" }, "token": "1776991733" } ] ``` - `400`: Portfolio ID is missing or invalid. - `application/json`: object - `error` (string) Example: ```json { "error": "Portfolio ID is Required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Sync Portfolio Owners `POST /portfolios/{portfolioID}/owners` Operation ID: `syncPortfolioOwners` Replaces the full owner list for a portfolio in a single operation. All existing owners are removed and the supplied `owners` array is set as the new authoritative list. On success the updated owner list is returned in the same paginated shape as `GET /portfolios/{portfolioID}/owners`. ##### Use Cases - Set or completely replace the owner roster after a portfolio change-of-ownership - Programmatically sync owner data from an external system ##### Business Rules - Requires the `UpdatePortfolio` permission - The caller must be permitted to access this portfolio via portfolio group restrictions - `owners` is required and must be a non-empty array; each entry requires `contactID`, `percentOwned`, and `percentDistributed` - This is a full replace, not a merge — owners not present in the payload will be removed ##### Related Endpoints - `GET /portfolios/{portfolioID}/owners` - List current owners - `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}` - Single owner detail - `POST /portfolios/{portfolioID}` - Update portfolio settings (owners can also be set on create) Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio whose owners to replace. Request body, required: - `application/json`: object - `owners` (object[], required): Full replacement owner list. Each entry must include contactID, percentOwned, and percentDistributed. - `contactID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the contact to assign as an owner. - `percentOwned` (string | number, decimal, required): Ownership percentage (0–100). - `percentDistributed` (string | number, decimal, required): Distribution percentage (0–100). Example: ```json { "owners": [ { "contactID": 4679, "percentOwned": "100.00", "percentDistributed": "100.00" } ] } ``` Responses: - `200`: Owner list replaced successfully. Returns the updated paginated owner list. - `application/json`: object[] - Each item: - `owner` (`portfolio_owner`, required) - `token` (string, required): Cache token for the owner record. Example: ```json [ { "owner": { "portfolioOwnerID": "601", "portfolioID": "279", "contactID": "4679", "percentOwned": "60.0000", "percentDistributed": "60.0000", "overrideContactPayoutSettings": "0", "payeeName": "Robert Johnson", "payoutTypeID": "2", "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0" }, "token": "1776991900" }, { "owner": { "portfolioOwnerID": "602", "portfolioID": "279", "contactID": "3444", "percentOwned": "40.0000", "percentDistributed": "40.0000", "overrideContactPayoutSettings": "0", "payeeName": "Sandra Villanueva", "payoutTypeID": "3", "achDetailsCiphertextID": "1021", "achAccountNumberTruncated": "8842", "achAccountTypeID": "2", "achIsCorporateAccount": "0" }, "token": "1776991900" } ] ``` - `400`: Invalid request body or portfolio not found. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Portfolio Owner `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}` Operation ID: `getPortfolioOwner` Returns the detail for a single portfolio owner record. Use the `includes` parameter to attach the full portfolio or contact record. ##### Use Cases - Load an owner detail panel to display ownership percentage and payout configuration - Retrieve contact info for an owner without a separate contacts API call ##### Business Rules - The caller must have access to the specified portfolio (enforced via portfolio group restrictions) - Returns a 400 error if the `portfolioOwnerID` does not belong to the specified `portfolioID` ##### Available Includes (2) - `portfolio` — The portfolio this owner belongs to - `contact` — The full contact record for the owner (name, email, address, phone numbers) ##### Related Endpoints - `GET /portfolios/{portfolioID}/owners` - List all owners for the portfolio - `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details` - Decrypted ACH bank account info Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio. - `portfolioOwnerID` (path, integer, required): The ID of the portfolio owner record. - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `portfolio`, `contact` Responses: - `200`: Successfully retrieved the portfolio owner. - `application/json`: object - `portfolioOwner` (`portfolio_owner`, required) - `portfolio` (`portfolio`) - `contact` (object): The owner's contact record (if includes=contact). - `contactID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `email` (string | null, email) Example: ```json { "portfolioOwner": { "portfolioOwnerID": "641", "portfolioID": "279", "contactID": "2992", "percentOwned": "0.0000", "percentDistributed": "10.0000", "overrideContactPayoutSettings": "0", "payeeName": null, "payoutTypeID": "2", "achDetailsCiphertextID": null, "achAccountNumberTruncated": null, "achAccountTypeID": null, "achIsCorporateAccount": "0" } } ``` - `400`: Portfolio owner not found or does not belong to the specified portfolio. - `application/json`: object - `error` (string) Example: ```json { "error": "Invalid Request" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Owner ACH Details `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details` Operation ID: `getPortfolioOwnerAchDetails` Returns the decrypted ACH bank account details for a specific portfolio owner. The account number and routing number are stored encrypted; this endpoint decrypts and returns the plain-text values. ##### Use Cases - Pre-populate an ACH payout settings form for editing - Verify bank account details before initiating a payout ##### Business Rules - The caller must have access to the specified portfolio (enforced via portfolio group restrictions) - Returns a 400 error if the `portfolioOwnerID` does not belong to the specified `portfolioID` - If no ACH details have been saved, all fields in `achDetails` are returned as empty strings ##### Related Endpoints - `GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}` - Owner detail (includes truncated account number) - `GET /portfolios/{portfolioID}/owners` - List all portfolio owners Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio. - `portfolioOwnerID` (path, integer, required): The ID of the portfolio owner record. Responses: - `200`: Successfully retrieved ACH details. - `application/json`: object - `achDetails` (object, required) - `nameOnAccount` (string, required): Name on the bank account. Empty string if not set. - `routingNumber` (string, required): ACH routing number. Empty string if not set. - `accountNumber` (string, required): Full ACH account number (decrypted). Empty string if not set. Example: ```json { "achDetails": { "nameOnAccount": "John Smith", "routingNumber": "021000021", "accountNumber": "123456784567" } } ``` - `400`: Portfolio owner not found or does not belong to the specified portfolio. - `application/json`: object - `error` (string) Example: ```json { "error": "Portfolio Owner id is required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Statements `GET /portfolios/statements/search` Operation ID: `searchStatements` Performs an advanced, paginated search across all owner statements. Returns denormalized rows combining statement data, the associated portfolio, statement setting details, and derived file/attachment counts. Suitable for account-wide statement dashboards and batch management workflows. ##### Use Cases - List all statements in a specific batch (filter by `statementBatchID`) - Find statements in a specific status (e.g., all statements in Review) - Query statements for a set of portfolios within a date range ##### Business Rules - Results are scoped to the authenticated account; cross-account data is never returned - Statement access respects portfolio group restrictions for the authenticated user - `statementFileCount` and `statementAttachmentCount` are derived counts, not arrays ##### Related Endpoints - `GET /portfolios/{portfolioID}/statements` - Statements for a single portfolio - `GET /portfolios/statements/{statementID}` - Single statement detail with includes - `GET /portfolios/statements/batches/search` - Search statement batches Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of results per page. - `search` (query, string): Free-text search across portfolio name and owner contact names. - `statementBatchID` (query, integer): Filter to statements belonging to a specific batch. - `statementStatusID` (query, integer, one of 1, 2, 3, 4, 5): Filter by statement status. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `startDate` (query, string, date): Filter to statements whose period starts on or after this date. - `endDate` (query, string, date): Filter to statements whose period ends on or before this date. - `portfolioIDs[]` (query, integer[]): Filter to statements for specific portfolios. Responses: - `200`: Successfully retrieved matching statements. - `application/json`: object[] - Each item: - `statement` (object, required): Denormalized statement row returned by the search query. - `statementID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the statement. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio this statement belongs to. - `statementBatchID` (string | null, pattern `^-?[0-9]+$`): The batch this statement was generated from, if any. - `startDate` (string | null, date): Start of the statement period. - `endDate` (string | null, date): End of the statement period. - `statementPeriodTypeID` (string, pattern `^-?[0-9]+$`): Statement period type. * `1` - Monthly * `2` - Off-Cycle - `statementStatusID` (string, required, pattern `^-?[0-9]+$`): Current processing status of the statement. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `name` (string, required): Human-readable name for the statement period. - `statementFileCount` (string): Number of generated statement files for this statement. - `statementAttachmentCount` (string): Number of file attachments on this statement. - `portfolio` (object, required): Abbreviated portfolio details for the statement's owner portfolio. - `portfolioID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the portfolio. - `name` (string, required): Display name of the portfolio. - `contacts` (string | null): JSON-encoded array of owner contacts with ownership and distribution percentages. - `statementSetting` (object, required): Statement setting template used when generating this statement. - `statementSettingID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the statement setting. - `name` (string, required): Display name of the statement setting template. Example: ```json [ { "statement": { "statementID": "7787", "portfolioID": "377", "statementBatchID": "772", "startDate": "2026-04-14", "endDate": "2026-05-13", "statementPeriodTypeID": "1", "statementStatusID": "4", "name": "04/14/2026 to 05/13/2026", "statementFileCount": "8", "statementAttachmentCount": "0" }, "portfolio": { "portfolioID": "377", "name": "Andrew Luck LLC", "contacts": "[{\"contactID\":\"4845\",\"percentOwned\":\"100.0000\",\"percentDistributed\":\"100.0000\",\"name\":\"Andrew Luck\"},{\"contactID\":\"3983\",\"percentOwned\":\"0.0000\",\"percentDistributed\":\"0.0000\",\"name\":\"Alexander the Great\"}]" }, "statementSetting": { "statementSettingID": "62", "name": "2023" } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Portfolio Statements `GET /portfolios/{portfolioID}/statements` Operation ID: `listPortfolioStatements` Returns a paginated list of owner statements for a specific portfolio. Use `/portfolios/statements/search` for cross-portfolio queries with additional filters. ##### Use Cases - Display the statement history on a portfolio detail page - Check for a portfolio's most recent published statement ##### Business Rules - The caller must have access to the specified portfolio (enforced via portfolio group restrictions) ##### Related Endpoints - `GET /portfolios/statements/search` - Account-wide statement search with advanced filters - `GET /portfolios/statements/{statementID}` - Single statement detail with includes - `GET /portfolios/statements/{statementID}/download` - Download statement as a ZIP archive Parameters: - `portfolioID` (path, integer, required): The ID of the portfolio whose statements to list. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Free-text search across statement names. Responses: - `200`: Successfully retrieved statements for the portfolio. - `application/json`: object[] - Each item: - `statement` (`statement`, required) - `statementSetting` (`statement_setting`, required) Example: ```json [ { "statement": { "statementID": "7787", "statementBatchID": "772", "statementSettingID": "62", "portfolioID": "377", "name": "04/14/2026 to 05/13/2026", "startDate": "2026-04-14", "endDate": "2026-05-13", "statementPeriodTypeID": "1", "statementStatusID": "4", "beginningBalance": "14016.85", "endingBalance": "13997.10", "totalDistributionAmount": "0.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "unpaidBillAmount": "4969.50", "workOrderEstimateAmount": "11111.00", "totalIncomeAmount": "-18.75", "totalExpenseAmount": "1.00", "totalAdjustmentAmount": "0.00", "dateTimeCreated": "2026-04-23 00:08:03", "publicUUID": "96b998c8-719f-4c65-8de6-c8cc2775d336", "dateTimeAccessExpires": "2026-05-07 00:08:03", "publicVerificationCode": "652152", "message": "

YOYOYOYOYOYOYOYYOYOY

" }, "statementSetting": { "statementSettingID": "62", "name": "2023", "isActive": "1", "settings": { "statement": { "includeBills": true, "includeBillAttachments": false, "includeBillAttachmentsWithMarkup": false, "includeBillAttachmentsWithDiscount": false, "includeWorkOrders": true, "includeWorkOrderAttachments": false, "includeBalanceMessage": false, "combineDiscount": false, "combineMarkup": false, "includePrepayments": false }, "modules": { "summary": { "isActive": true, "pageBreak": true }, "taxSummary": { "isActive": true, "pageBreak": true, "includePrepayments": true }, "transactionSummary": { "isActive": true, "includeYearToDate": true, "excludeZeroBalanceAccounts": true, "pageBreak": true }, "transactionDetails": { "isActive": true, "pageBreak": true, "isMultiUnitConsolidated": false, "isTransactionConsolidated": false, "isIncomeConsolidated": false, "isManagementFeeConsolidated": false, "propertyTransactionsOrderField": 1, "includeTransactionRunningBalance": true, "includePayeePayer": true, "includePropertyReserveAmount": true, "includeNetValues": false, "propertyOrderType": 2 }, "ledger": { "isActive": true, "pageBreak": true, "includePayeePayer": true }, "openWorkOrders": { "isActive": true, "pageBreak": true }, "closedWorkOrders": { "isActive": true, "pageBreak": true, "includeClosingComments": 0 }, "unpaidBills": { "isActive": true, "pageBreak": true }, "notes": { "isActive": true, "pageBreak": true }, "units": { "isActive": true, "pageBreak": false, "showBalance": true, "showTenants": true, "showMoveInDate": 1 } } } } } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Statement `GET /portfolios/statements/{statementID}` Operation ID: `getStatement` Returns the full detail for a single owner statement by its ID. Additional related data can be requested via the `includes` query parameter, including the statement files (generated PDFs/HTML), file attachments, and the parent portfolio. ##### Use Cases - Load a statement detail view showing financial summary and status - Retrieve statement files to display or link for download - Check public sharing settings (UUID, expiry) for a published statement ##### Business Rules - Access is restricted to statements whose portfolio the authenticated user's group permits - Public statement sharing uses `publicUUID` and `publicVerificationCode` — these are unrelated to API auth ##### Available Includes (3) - `portfolio` — The portfolio this statement belongs to - `statementFiles` — List of generated statement files (PDFs, HTML exports) attached to the statement - `fileAttachments` — File attachments manually added to the statement ##### Related Endpoints - `GET /portfolios/statements/{statementID}/download` - Download the statement as a ZIP archive - `GET /portfolios/{portfolioID}/statements` - All statements for the portfolio - `GET /portfolios/statements/search` - Account-wide statement search Parameters: - `statementID` (path, integer, required): The ID of the statement to retrieve. - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `portfolio`, `statementFiles`, `fileAttachments` Responses: - `200`: Successfully retrieved the statement. - `application/json`: object - `statement` (`statement`, required) - `portfolio` (`portfolio`) - `statementFiles` (object[]): Generated statement files (if includes=statementFiles). - `statementFileID` (string, pattern `^-?[0-9]+$`) - `statementID` (string, pattern `^-?[0-9]+$`) - `fileID` (string, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `fileAttachments` (object[]): Manually attached files (if includes=fileAttachments). - `fileAttachmentID` (string, pattern `^-?[0-9]+$`) - `fileID` (string, pattern `^-?[0-9]+$`) - `objectTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) Example: ```json { "statement": { "statementID": "7787", "statementBatchID": "772", "statementSettingID": "62", "portfolioID": "377", "name": "04/14/2026 to 05/13/2026", "startDate": "2026-04-14", "endDate": "2026-05-13", "statementPeriodTypeID": "1", "statementStatusID": "4", "beginningBalance": "14016.85", "endingBalance": "13997.10", "totalDistributionAmount": "0.00", "reserveAmount": "500.00", "additionalReserveAmount": "0.00", "unpaidBillAmount": "4969.50", "workOrderEstimateAmount": "11111.00", "totalIncomeAmount": "-18.75", "totalExpenseAmount": "1.00", "totalAdjustmentAmount": "0.00", "dateTimeCreated": "2026-04-23 00:08:03", "publicUUID": "96b998c8-719f-4c65-8de6-c8cc2775d336", "dateTimeAccessExpires": "2026-05-07 00:08:03", "publicVerificationCode": "652152", "message": "

test

" } } ``` - `400`: Statement not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Statement 4501 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Download Statement `GET /portfolios/statements/{statementID}/download` Operation ID: `downloadStatement` Downloads the statement as a ZIP archive containing all generated statement files (PDFs, HTML). The response streams the binary ZIP content with a `Content-Disposition: attachment` header. ##### Use Cases - Provide a download button for owners or managers to save the statement package locally - Programmatically retrieve the statement ZIP for archival or third-party distribution ##### Business Rules - Access is restricted to statements whose portfolio the authenticated user's group permits - Returns a 400 error if the statement has no generated files to include in the ZIP ##### Related Endpoints - `GET /portfolios/statements/{statementID}` - Statement detail and metadata (includes statementFiles) - `GET /portfolios/{portfolioID}/statements` - All statements for the portfolio Parameters: - `statementID` (path, integer, required): The ID of the statement to download. Responses: - `200`: ZIP archive of the statement files, streamed as a binary download. - `application/zip`: string, binary - `400`: Statement not found or has no files to download. - `application/json`: object - `error` (string) Example: ```json { "error": "Statement 4501 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Search Statement Batches `GET /portfolios/statements/batches/search` Operation ID: `searchStatementBatches` Performs an advanced, paginated search across statement batches. Returns denormalized rows combining batch data, the associated statement setting, and a derived statement count. The response shape is a search projection — it includes only the fields from `portfolio_statement_batches` joined to `portfolio_statement_settings`, not the full batch entity. ##### Use Cases - Display a paginated list of all statement batches with status and statement count - Filter batches by status to find all batches in Review or Processing - Query batches created within a specific time range - Filter to batches that include statements for specific portfolios ##### Business Rules - Results are scoped to the authenticated account; cross-account data is never returned - `statementCount` is a derived count of statements in the batch (subquery) - `statementSetting` fields are nullable — a batch may not have an associated setting template - When `startFromLastStatement` is `1`, each portfolio's start date is calculated from its most recent statement end date, so `startDate` will be `null` ##### Related Endpoints - `GET /portfolios/statements/batches/{statementBatchID}` - Single batch detail with optional statement list - `GET /portfolios/statements/search` - Search individual statements across all batches Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of results per page. - `search` (query, string): Free-text search across batch name, portfolio names, and owner contact names. - `statementStatusIDs[]` (query, integer[]): Filter to batches with one or more of these statuses. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `dateTimeCreatedMin` (query, string, date-time): Filter to batches created on or after this datetime (account timezone). - `dateTimeCreatedMax` (query, string, date-time): Filter to batches created on or before this datetime (account timezone). - `portfolioIDs[]` (query, integer[]): Filter to batches that include statements for specific portfolios. Responses: - `200`: Successfully retrieved matching statement batches. - `application/json`: object[] - Each item: - `statementBatch` (object, required): Batch summary fields projected by the search query. - `statementBatchID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the statement batch. - `statementStatusID` (string, required, pattern `^-?[0-9]+$`): Overall processing status of the batch. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `statementPeriodTypeID` (string | null, pattern `^-?[0-9]+$`): Statement period type for this batch. * `1` - Monthly * `2` - Off-Cycle - `isAutoPublished` (string, one of "0", "1"): When `1`, statements are automatically published without a manual review step. - `startFromLastStatement` (string, pattern `^-?[0-9]+$`): When `1`, each portfolio's start date is calculated from its most recent statement end date. - `startDate` (string | null, date): Explicit start date for the statement period. Null when `startFromLastStatement` is `1`. - `endDate` (string | null, date): End date for the statement period. - `message` (string | null): Optional HTML message included with all statements in the batch. - `dateTimeCreated` (string, required, read-only): When the batch was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `name` (string, required): Name of the batch. - `statementCount` (string, required): Derived count of statements belonging to this batch. - `statementSetting` (object, required): Statement setting template linked to this batch, if any. - `statementSettingID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the statement setting template, or null if none is linked. - `name` (string | null, required): Human-readable name of the statement setting template, or null if none is linked. Example: ```json [ { "statementBatch": { "statementBatchID": "773", "statementStatusID": "2", "statementPeriodTypeID": "1", "isAutoPublished": "0", "startFromLastStatement": "1", "startDate": null, "endDate": "2026-05-13", "message": "

YOYOYOYOYOYOYOYYOYOY

", "dateTimeCreated": "2026-04-23 18:14:49", "name": "Last Statement through 05/13/2026", "statementCount": "1" }, "statementSetting": { "statementSettingID": null, "name": null } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Statement Batch `GET /portfolios/statements/batches/{statementBatchID}` Operation ID: `getStatementBatch` Returns the full detail for a single statement batch by its ID. Use the `includes` parameter to attach the complete list of statements in the batch (each with its portfolio) and access restriction flags. ##### Use Cases - Load a batch detail page showing status, date range, and file generation progress - Retrieve all statements in a batch to display a per-portfolio status table - Check whether the authenticated user has full or restricted access to the batch ##### Business Rules - Access is enforced via `verifyAccessToPortfolioBatch`; users with restricted portfolio access see the batch but individual statements may be flagged `restricted: 1` - When `includes=statements`, each statement item includes a `restricted` flag (`0` or `1`) indicating whether the authenticated user can access that statement's portfolio ##### Available Includes (2) - `statements` — All statements in the batch, each with portfolio data and a `restricted` access flag - `restrictions` — Adds a `fullAccess` boolean indicating whether the user has unrestricted batch access ##### Related Endpoints - `GET /portfolios/statements/batches/search` - Paginated batch list with advanced filters - `GET /portfolios/statements/{statementID}` - Single statement detail - `GET /portfolios/statements/search` - Account-wide statement search (filter by `statementBatchID`) Parameters: - `statementBatchID` (path, integer, required): The ID of the statement batch to retrieve. - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `statements`, `restrictions` Responses: - `200`: Successfully retrieved the statement batch. - `application/json`: object - `statementBatch` (`statement_batch`, required) - `fullAccess` (boolean): Present when includes=restrictions. `true` if the user has unrestricted access to all portfolios in the batch; `false` if some statements are restricted. - `statements` (object[]): All statements in the batch (if includes=statements). - `statement` (`statement`) - `portfolio` (`portfolio`) - `restricted` (integer, one of 0, 1): `1` if the authenticated user cannot access this statement's portfolio. Example: ```json { "statementBatch": { "statementBatchID": "754", "statementSettingID": null, "statementStatusID": "4", "statementPeriodTypeID": "1", "name": "02/14/2026 to 03/13/2026", "startFromLastStatement": "0", "startDate": "2026-02-14", "endDate": "2026-03-13", "isAutoPublished": "0", "sendNotifications": "1", "message": "

This is February - March statement

", "statementBatchFileStatusID": "3", "fileID": "9157", "dateTimeCreated": "2026-02-18 20:22:38" } } ``` - `400`: Statement batch not found. - `application/json`: object - `error` (string) Example: ```json { "error": "Statement Batch 88 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ## Properties ### Properties A property is a building or lot the account manages, owned by one portfolio at a time. A single-family property has exactly one unit, which carries the property's name and address; a multi-unit property has any number of units. List, search, create, read, update, activate, deactivate and delete properties here; one create makes the property and its units together, and returns the property alone: read the units back with `GET /properties/{propertyID}?includes=unit` (single-family) or `GET /properties/{propertyID}/units`. #### List Properties `GET /properties` Operation ID: `listProperties` Returns a page of properties, sorted by name. Each item is keyed by entity: `property`, plus `image` and `portfolio` when included. Use `GET /properties/search` for more filters and a denormalized row with portfolio, lease and group data. ##### Use Cases - Page through every active (or inactive) property on the account - Look up properties by name or address text - Load each property's image and portfolio records in the same request ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups only gets properties in those groups' portfolios (a filtered 200, never a 403). - `isActive` defaults to `1`: only active properties. `0` returns only inactive ones; any other value (`all`, `both`) returns both. - `search` is a substring match on `name`, `address`, `address2`, `city`, `stateID` and `postalCode`. - The page size defaults to 15 and is capped at 5000. Send a `pageSize` of at least 1. - To page through every property, stop once `pagination-current-page` is at or past `pagination-last-page`. - Sorted by `name`, then `propertyID`. - The `image` and `portfolio` includes are inner joins: a property whose image or portfolio row is missing drops out of the page. ##### Available Includes (2) - `image` - the property's primary image record - `portfolio` - the portfolio record that owns the property ##### Related Endpoints - `GET /properties/search` - filtered search with portfolio, lease and group data per row - `GET /properties/{propertyID}` - one property, with more includes - `POST /properties` - create a property Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 15, minimum 1): Items per page, at least 1 (default 15). Values above 5000 are served at 5000. - `search` (query, string): Substring match on `name`, `address`, `address2`, `city`, `stateID` and `postalCode`. - `isActive` (query, string, default "1"): `1` (the default) returns active properties, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. - `managementFeeSettingID` (query, integer): Only properties that use this management fee setting, from `GET /settings/management-fees` (undocumented). A value that isn't a number is ignored. - `includes` (query, string): Comma-separated related records to add to each item: `image`, `portfolio`. Other values are ignored. Responses: - `200`: A page of properties - `application/json`: object[] - Each item: - `property` (`property`, required) - `token` (string, pattern `^[0-9]+$`): The current Unix time. Sent only when neither `image` nor `portfolio` is included; carries no meaning for clients. - `image` (`property_image`): The property's primary image. Requires the `image` include. - `portfolio` (`included_portfolio`): The portfolio that owns the property. Requires the `portfolio` include. Example: ```json [ { "property": { "propertyID": "3", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "3", "managementFeeSettingID": "3", "name": "APITEST-6af0273e72edd A", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2028-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Insurance Co", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:42", "dateTimeModified": "2026-11-08 07:39:42", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null }, "token": "1794123582" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Property `POST /properties` Operation ID: `createProperty` Creates a property and its units in one request, and returns the property in the `GET /properties/{propertyID}` shape (without includes). A single-family property (`isMultiUnit` `0` or omitted) takes one `unit`; a multi-unit property takes a `units` array and an `attachments` array (`[]` when there are none). ##### Use Cases - Onboard a single-family home with its one unit - Onboard an apartment building with all of its units ##### Business Rules - Requires the **Create Property** permission (`Properties` › `CreateProperty`). - The body is refused with `invalid input.` when it is empty or `{}`. - Only the keys of the `property` and unit schemas below are read; any other key is ignored. - The request is checked in this order, each step answering a 400 on its own: the property type allows multi-unit (when `isMultiUnit` is `1`), the portfolio exists and is inside the API user's portfolio groups, then the property's validators (keyed `property.`), then each unit's validators (keyed `unitContract.unit.`). - The property's errors come in two rounds. The field validators (lengths, formats, `yearBuilt`, money fields) and the must-exist checks of every ID field (`countryID`, the `stateID`-`countryID` pair, `managementFeeSettingID`, `salesTaxSettingID`, `withholdingTaxAgencyID`, `applicationTemplateID`, `propertyShowingProviderID`, `assignedToUserID`, `defaultMonthToMonthPremiumSettingID`, `defaultResidentPackageID`) are reported together, an unknown `managementFeeSettingID` as `{"property.managementFeeSettingID": ["Management Fee does not exist."]}`; the pair's error is keyed `property.stateID, countryID`, with a space (`State does not exist.`, for a missing `stateID` as well as an unknown one; runtimes on Phalcon older than 5.21 send the key without the space, so match `property.stateID,countryID` with or without it). Only once those must-exist checks pass are missing required fields (`property.address`, `property.city` and the other `… is required` messages) reported, so fixing a body can take two round trips. - Unit errors carry no index: every unit's are keyed `unitContract.unit.`, and checking stops at the first unit that fails, so the later units' errors aren't reported. - Every type except Single Family Home (`1`) and Mobile Home (`8`) allows `isMultiUnit` `1`: Apartment, Condo, Townhouse, Duplex, Multiplex, Loft, Commercial, Garage and Lot (`2`-`7`, `9`-`11`). - A single-family property needs `unit` with at least `rent`: without it the request is refused with `{"unitContract.unit.rent": ["Rent is required"]}`. - A single-family property's unit takes the property's `name`, `address`, `address2`, `city`, `stateID` and `postalCode`, whatever the `unit` sends. The unit's limits then apply to those values: a `city` longer than 50 characters is refused with `{"unitContract.unit.city": ["Cannot exceed 50 characters"]}`, although the property alone would take 100. - Money fields (`rent`, `deposit`, `reserveAmount`, `maintenanceLimitAmount`, the markup amounts, `leaseReturnChargeAmount`, `requiredRentersInsuranceLiabilityAmount`) take at most two decimal places. - `latitude` and `longitude` are geocoded from the address; when geocoding finds nothing they are stored as `0.00000000`. - `reserveAmount` defaults to `0.00`; `requiredRentersInsuranceLiabilityAmount` to the account's insurance setting, or 100000.00. ##### Side Effects - Creates the units, each with its own ledger and an inactive listing, and a current property-portfolio record for the owning portfolio. A multi-unit property also gets a property ledger. - Geocodes each unit of a multi-unit property and queues an address validation for it. - Recalculates the owning portfolio's reserve amount. - Queues an address validation for the property; `addressValidationStatusID` starts at `1` (Not Validated). - The property's address is geocoded before its validators run, so a request refused with a `property.` or `unitContract.unit.` error has still sent that address to the geocoding service. - With `assignedToUserID` set, sends that user the Property Assigned To User notification. - Fires the `property::property::created` webhook event, and `unit::unit::created` for each unit; a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `GET /properties/{propertyID}` - read the property back with includes - `POST /properties/{propertyID}/units` - add units later - `GET /portfolios` - portfolio IDs for `portfolioID` - `GET /properties` - every row's `property` carries the `portfolioID`, `managementFeeSettingID`, `countryID` and `stateID` an existing property uses - `GET /properties/{propertyID}?includes=portfolio,managementFeeSetting` - until `GET /settings/management-fees` (undocumented), `GET /countries` (undocumented) and `GET /states` (undocumented) are documented, the valid `portfolioID`, `managementFeeSettingID`, `countryID` and `stateID` of an existing property Request body, required: - `application/json`: object - `property` (`property_create`, required) - `unit` (`unit_for_property_create`): The one unit of a single-family property, needed with at least `rent` (leaving it out answers 400 `unitContract.unit.rent`). Ignored when `isMultiUnit` is `1`. - `units` (combined object[]): The units of a multi-unit property, each with at least `address`, `city`, `stateID` and `rent`. Ignored for a single-family property. - All of: - Option 1: `unit_for_property_create` - Option 2: object - `attachments` (string | integer[]): IDs of already uploaded files to link to the new property (multi-unit) or its unit (single-family); an ID with no file is refused with 400. Send it with a multi-unit property, as `[]` when there are none. Example: ```json { "property": { "propertyTypeID": 1, "portfolioID": 32, "managementFeeSettingID": 30, "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "county": "Example County", "yearBuilt": 2001, "maintenanceLimitAmount": "375.00", "reserveAmount": "500.00", "dateContractBegins": "01/01/2026", "leaseReturnChargeAmount": "15.00" }, "unit": { "rent": "1500.00", "deposit": "800.00", "beds": 3, "fullBaths": 2, "halfBaths": 1, "size": 1200 } } ``` Responses: - `200`: The created property - `application/json`: object - `property` (`property`, required) Example: ```json { "property": { "propertyID": "30", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "32", "managementFeeSettingID": "30", "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": null, "legalDescription": null, "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": null, "dateWarrantyExpires": null, "maintenanceNotes": null, "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": null, "markupAmount": null, "markupAmountMin": null, "markupAmountMax": null, "dateContractBegins": "2026-01-01", "dateContractEnds": null, "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": null, "insuranceAgent": null, "insurancePolicyNumber": null, "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": null, "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:47", "dateTimeModified": "2026-11-08 07:39:47", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } } ``` - `400`: The request was refused. Bodies: - `{"error": "invalid input."}` for an empty body or `{}`; - `{"isMultiUnit": [...]}` when the property type doesn't allow multiple units; - `{"portfolioID": [...]}` when the portfolio doesn't exist (`Portfolio not found`) or is outside the API user's portfolio groups (`Portfolio not allowed`); - a map of `property.` to messages for the property's validators, in two rounds: the field validators with the must-exist checks of the ID fields (`property.countryID`, `property.managementFeeSettingID` and the others, and `property.stateID, countryID` for the state-country pair) first, the missing required fields only once those pass; - a map of `unitContract.unit.` to messages for the first unit that fails (no index); - `{"attachments.fileID": ["File does not exist"]}` for an `attachments` ID with no uploaded file (keyed `unitContract.attachments.fileID` on a single-family property); - `{"error": ""}` for any other error raised while saving. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Create Property** (`Properties` › `CreateProperty`). - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `429`: see shared response `error_429` #### Search Properties `GET /properties/search` Operation ID: `searchProperties` Returns a filtered page of properties, each row denormalized: the `property` (with unit counts and vacancy), its `portfolio`, the current `lease` of a single-family property's unit, its `propertyGroup` names and its `primaryImage`. ##### Use Cases - Power a property list view with portfolio, tenant and group context, no extra lookups - Filter by status, vacancy, type, portfolio, portfolio group, property group, assignee, tag or location - Pull the properties modified in a time window for a sync ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups only gets properties in those groups' portfolios (a filtered 200, never a 403). - With no `isActive`, active and inactive properties are both returned. - A filter value the API can't read is ignored rather than refused: the request still answers 200 (a boolean other than `1`/`0`/`true`/`false`/`yes`/`no`, a date it can't parse). - List filters (`propertyIDs[]` and the others ending in `[]`) take one `name[]=value` per value; a single plain `name=value` is read as a one-item list. - The page size defaults to 25; send at most 5000. On a page that holds items, `pagination-page-size` reports the page size or the number of matching items, whichever is smaller. A `pageSize` of `0` or below is read as 15. - To page through every match, stop once `pagination-current-page` is at or past `pagination-last-page`. - Sorted by `orderBy` (default `property.property`: street name, street number, address 2, city, state), then `propertyID`. `orderBy` takes only the columns listed under it. - `dateTimeModifiedMin` and `dateTimeModifiedMax` are compared in UTC: send them in UTC. - `lease` is set only for a single-family property whose unit has a current lease; it is `{leaseID: null, tenants: null}` otherwise, and always for a multi-unit property. - `property.isVacant` is `1` when a single-family property's unit has no current lease, `0` when it has one, and `null` for a multi-unit property. ##### Related Endpoints - `GET /properties` - the plain property list - `GET /properties/{propertyID}` - one property, with includes - `GET /portfolios` - portfolio IDs for `portfolioIDs[]` Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25, maximum 5000): Items per page, at most 5000 (default 25). `0` or a negative value is read as 15. - `orderBy` (query, string): Sort column, optionally followed by `|asc` or `|desc` (default `asc`; any other direction is read as `asc`); several are separated by commas. Use only the columns below. `propertyID` always breaks ties. Columns: `property.property` (the default: street name, street number, address 2, city, state), `property.isActive`, `property.name`, `property.address`, `property.address2`, `property.city`, `property.postalCode`, `property.streetNumber`, `property.streetName`, `property.propertyTypeID`, `property.isMultiUnit`, `property.unitCount`, `property.activeUnitCount`, `property.isVacant`, `property.dateTimeCreated`, `portfolio.name`, `lease.tenants` (the current lease's stored tenant list, which sorts by the number of tenants rather than by name). - `search` (query, string): Substring match on the property's name, address, address 2, city and postal code, the portfolio's name, the current lease's tenant names and the portfolio owners' names. Also matches the state code, sent whole (`FL`). - `isActive` (query, string): `1` active only, `0` inactive only; omitted returns both. - `isMultiUnit` (query, string): `1` multi-unit only, `0` single-family only. - `isVacant` (query, string): `1` single-family properties with no current lease, `0` single-family properties with one. Either value leaves out every multi-unit property. - `isNonRevenue` (query, string): `1` properties with at least one non-revenue unit, `0` properties with none. - `propertyIDs[]` (query, integer[]): Only these properties. One `propertyIDs[]=` per value. - `propertyTypeIDs[]` (query, integer[]): Only these property types. One `propertyTypeIDs[]=` per value. * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot - `portfolioIDs[]` (query, integer[]): Only properties owned by these portfolios (from `GET /portfolios`). One `portfolioIDs[]=` per value. - `portfolioGroupIDs[]` (query, integer[]): Only properties whose portfolio belongs to one of these portfolio groups. One `portfolioGroupIDs[]=` per value. - `propertyGroupIDs[]` (query, integer[]): Only properties in one of these property groups. One `propertyGroupIDs[]=` per value. - `assignedToUserIDs[]` (query, integer[]): Only properties assigned to one of these users. One `assignedToUserIDs[]=` per value. - `propertyManagerIDs[]` (query, integer[]): Deprecated: only single-family properties whose unit has one of these property manager records. Use `assignedToUserIDs[]`. - `tagIDs[]` (query, integer[]): Only properties tagged with one of these tags. One `tagIDs[]=` per value. - `city` (query, string): Substring match on the city. - `stateID` (query, string): State code, matched exactly. - `postalCode` (query, string): Substring match on the postal code. - `dateTimeModifiedMin` (query, string): Only properties modified at or after this time, in UTC. Accepts `YYYY-MM-DD HH:MM:SS`, ISO 8601 in UTC (`2026-01-01T00:00:00Z`) or `MM/DD/YYYY`. A value it can't parse is ignored. - `dateTimeModifiedMax` (query, string): Only properties modified at or before this time. Same forms as `dateTimeModifiedMin`; a date alone means midnight at the start of that day, so send a time to include the whole day. Responses: - `200`: A page of matching properties - `application/json`: object[] - Each item: - `property` (object, required) - `isActive` (string, required, one of "0", "1"): `1` active, `0` deactivated. - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the property - `name` (string | null, required, max length 100): Optional display name for the property - `address` (string, required, max length 100): Full street address - `streetNumber` (string | null, required, pattern `^-?[0-9]+$`): Parsed street number component of the address - `streetName` (string | null, required, max length 100): Parsed street name component of the address - `address2` (string | null, required, max length 100): Secondary address line (unit, suite, apt) - `city` (string, required, max length 100) - `stateID` (string, required, max length 3): 2-character state or province code - `postalCode` (string | null, required, max length 20) - `portfolioID` (string, required, pattern `^-?[0-9]+$`): ID of the portfolio this property belongs to - `propertyTypeID` (`property_types`, required) - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user assigned to manage this property - `isMultiUnit` (string, required, one of "0", "1"): `1` = multi-unit property, `0` = single-unit property - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): When the property was deactivated, or null. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `unitCount` (string, required, pattern `^[0-9]+$`): Number of units, active and inactive. - `activeUnitCount` (string, required, pattern `^[0-9]+$`): Number of active units. - `isVacant` (string | null, required, one of "0", "1", null): `1` when a single-family property's unit has no current lease, `0` when it has one; always null for a multi-unit property. - `portfolio` (object, required) - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required): Display name of the portfolio - `contacts` (string | null, required): The portfolio's owners as a JSON-encoded string (not decoded), an array of `{"name", "contactID", "percentOwned", "percentDistributed"}`; null when not yet built. Inside it the IDs and percentages are numbers in some rows and strings in others (`377` or `"983"`, `50.0000` or `"100.0000"`); read them as either. - `lease` (object, required) - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): The current lease of a single-family property's unit, or null. - `tenants` (string[] | null, required): The tenant names on that lease, decoded from JSON, or null. - `propertyGroup` (object, required) - `propertyGroupNames` (string | null, required): The names of the property groups the property belongs to, joined with `, `; null when it is in none. - `primaryImage` (object, required) - `propertyImageID` (string, required, pattern `^-?[0-9]+$`): `1` is the shared no-image placeholder. - `filePath` (string, required): Storage key of the image. For the shared placeholder (`propertyImageID` `1`) it names the default image, not an uploaded file, and its value varies by account (`system`, `noimage`). - `fileType` (string, required): File extension of the image Example: ```json [ { "property": { "isActive": "1", "propertyID": "15", "name": "APITEST-6af027409609e", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "portfolioID": "15", "propertyTypeID": "1", "assignedToUserID": "2", "isMultiUnit": "0", "dateTimeCreated": "2026-11-08 07:39:44", "dateTimeModified": "2026-11-08 07:39:44", "dateTimeDeactivated": null, "unitCount": "1", "activeUnitCount": "1", "isVacant": "0" }, "portfolio": { "portfolioID": "15", "name": "Nolan-Erdman Portfolio", "contacts": null }, "lease": { "leaseID": "1", "tenants": [ "Pat Tenant" ] }, "propertyGroup": { "propertyGroupNames": "APITEST Group" }, "primaryImage": { "propertyImageID": "1", "filePath": "noimage", "fileType": "jpg" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Property `GET /properties/{propertyID}` Operation ID: `getProperty` Returns one property under `property`, plus one top-level key per requested include. ##### Use Cases - Show a property's details, with its unit, current lease and owners, in one request - Load a multi-unit property's units, work orders and ledger - Read the portfolio's balances or the current lease's balances for an accounting view ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets a 403 `Access Denied` for a property outside those groups' portfolios. - A well-formed ID with no property answers 400 `Property {propertyID} not found`; a value that isn't a number answers the stock 404. - Some includes apply only to one kind of property and are silently left out for the other: - multi-unit only: `units`, and property-level `workOrders` and `ledger`; - single-family only: `unit` and everything that hangs off it (`lease`, `leaseBalances`, `pastLeases`, `futureLeases`, `listing`, `appliances`, `filters`, `filterDeliveryConfiguration`, `filterDeliveryAddress`, `filterDeliverySchedule`, `propertyManager`), and unit-level `workOrders` and `ledger`. - On a single-family property every include of that second group needs `unit` as well; without it, none is sent. With `unit`, a property that has no unit row answers 400 `Unit not found`. - `leaseBalances` needs `lease` (and so `unit`) and is sent only when the unit has a current lease; `portfolioBalances` needs `portfolio`. - `lease` adds two keys, `lease` and `leaseStatus`; `listing` adds `listing` and `listingFiles`. - The `portfolios` include also reads the `search`, `isCurrent`, `portfolioID` and `orderBy` query parameters (below) to filter and sort the ownership history; they do nothing without it. - The `includes` list is split on commas without trimming: `image, portfolio` reads ` portfolio` (with the space) and silently drops it. ##### Available Includes (25) - `image` - the property's primary image - `units` - the units of a multi-unit property - `workOrders` - work orders with their vendor contact: the property's own (no unit) on a multi-unit property, the unit's on a single-family one - `ledger` - the property's ledger (multi-unit) or the unit's ledger (single-family), or null - `unit` - the unit of a single-family property - `lease` - the unit's current lease (or null) and its status as `leaseStatus` - `leaseBalances` - balances of the current lease - `pastLeases` - the unit's closed leases, newest first - `futureLeases` - the unit's pending leases - `listing` - the unit's listing (an unsaved, mostly empty one when none exists) and its files as `listingFiles` - `appliances` - the unit's appliances - `filters` - the unit's air filters - `filterDeliveryConfiguration` - whether the unit's air-filter delivery is set up - `filterDeliveryAddress` - the unit's custom filter delivery address, or `false` - `filterDeliverySchedule` - the unit's filter delivery schedule, or `false` - `propertyManager` - the unit's property manager record, or `false` - `portfolio` - the owning portfolio - `portfolioBalances` - balances of the owning portfolio's ledger - `portfolios` - the property's ownership history - `owners` - the owning portfolio's owners, with their contacts - `managementFeeSetting` - the property's management fee setting - `inspections` - the property's inspections - `associations` - the property's homeowners' associations, with their contacts - `applicationTemplate` - the property's application template, or null - `propertyShowingProvider` - the property's showing provider, or null ##### Related Endpoints - `GET /properties` - list properties - `GET /properties/search` - search properties - `POST /properties/{propertyID}` - update the property - `DELETE /properties/{propertyID}` - delete the property - `GET /properties/{propertyID}/units/{unitID}` - a unit, with its own includes Parameters: - `propertyID` (path, integer, required): The property's ID. - `includes` (query, string): Comma-separated related records to add: `image`, `units`, `workOrders`, `ledger`, `unit`, `lease`, `leaseBalances`, `pastLeases`, `futureLeases`, `listing`, `appliances`, `filters`, `filterDeliveryConfiguration`, `filterDeliveryAddress`, `filterDeliverySchedule`, `propertyManager`, `portfolio`, `portfolioBalances`, `portfolios`, `owners`, `managementFeeSetting`, `inspections`, `associations`, `applicationTemplate`, `propertyShowingProvider`. An unknown name is ignored. - `search` (query, string): With `includes=portfolios` only. Substring match on the property's name, address, address 2, city and postal code, the portfolio's name and its owners' contact names; matches `stateID` exactly. - `isCurrent` (query, integer, one of 0, 1): With `includes=portfolios` only. `1` the current ownership row only, `0` the past ones only; any other value is ignored. - `portfolioID` (query, integer): With `includes=portfolios` only. The ownership rows of this portfolio. - `orderBy` (query, string): With `includes=portfolios` only. Sort column, optionally followed by `|asc` or `|desc` (default `asc`); several are separated by commas. Without it, or when every column sent is unknown, rows come newest first (`propertyPortfolio.propertyPortfolioID|desc`). Columns: `propertyPortfolio.propertyPortfolioID`, `propertyPortfolio.isCurrent`, `property.property` (street name, street number, address 2, city, state), `property.name`, `property.address`, `property.address2`, `property.city`, `property.postalCode`, `property.streetNumber`, `property.streetName`, `property.propertyTypeID`, `property.isMultiUnit`, `portfolio.name`. Responses: - `200`: The property - `application/json`: object - `property` (`property`, required) - `image` (`property_image`): Requires the `image` include. - `units` (object[]): Multi-unit property only; requires the `units` include. - `unit` (`unit`, required) - `token` (string, pattern `^[0-9]+$`): The current Unix time; carries no meaning for clients. - `workOrders` (`work_order_row`[]): Requires the `workOrders` include (and `unit` on a single-family property). - `ledger` (one of several shapes): Requires the `ledger` include (and `unit` on a single-family property). Null when no ledger exists. - One of: - Option 1: `included_ledger` - Option 2: null - `unit` (`unit`): Single-family property only; requires the `unit` include. - `lease` (one of several shapes): The unit's current lease, or null. Requires the `unit` and `lease` includes. - One of: - Option 1: `included_lease` - Option 2: null - `leaseStatus` (one of several shapes): The current lease's status, or null. Sent with `lease`. - One of: - Option 1: combined object - All of: - Option 1: `lease_status` - Option 2: object - `primaryLeaseStatusID` (`primary_lease_statuses`, required) - Option 2: null - `leaseBalances` (`lease_balances`): Requires the `unit`, `lease` and `leaseBalances` includes, and a current lease. - `pastLeases` (`included_lease`[]): Closed leases, newest first. Requires the `unit` and `pastLeases` includes. - `futureLeases` (`included_lease`[]): Pending leases. Requires the `unit` and `futureLeases` includes. - `listing` (`listing`): Requires the `unit` and `listing` includes. - `listingFiles` (`listing_file`[]): The listing's files plus the account-wide listing files (null `propertyListingID`). Sent with `listing`. - `appliances` (`appliance`[]): Requires the `unit` and `appliances` includes. - `filters` (`filter`[]): Requires the `unit` and `filters` includes. - `filterDeliveryConfiguration` (`filter_delivery_configuration`): Requires the `unit` and `filterDeliveryConfiguration` includes. - `filterDeliveryAddress` (one of several shapes): The unit's custom delivery address, or `false` (not null) when the unit has none. Requires the `unit` and `filterDeliveryAddress` includes. - One of: - Option 1: `filter_delivery_address` - Option 2: any - `filterDeliverySchedule` (one of several shapes): The unit's delivery schedule, or `false` (not null) when the unit has none. Requires the `unit` and `filterDeliverySchedule` includes. - One of: - Option 1: `filter_delivery_schedule` - Option 2: any - `propertyManager` (one of several shapes): The unit's property manager record, or `false` (not null) when the unit has none. Requires the `unit` and `propertyManager` includes. - One of: - Option 1: `property_manager` - Option 2: any - `portfolio` (`included_portfolio`): Requires the `portfolio` include. - `portfolioBalances` (`portfolio_balances`): Requires the `portfolio` and `portfolioBalances` includes. - `portfolios` (`property_portfolio_row`[]): Ownership history. Requires the `portfolios` include. - `owners` (`owner_row`[]): Requires the `owners` include. - `managementFeeSetting` (`included_management_fee_setting`): Requires the `managementFeeSetting` include. - `inspections` (`inspection_row`[]): Requires the `inspections` include. - `associations` (`association_row`[]): Requires the `associations` include. - `applicationTemplate` (one of several shapes): Null when the property has no application template. Requires the `applicationTemplate` include. - One of: - Option 1: `included_template` - Option 2: null - `propertyShowingProvider` (one of several shapes): Null when the property has no showing provider. Requires the `propertyShowingProvider` include. - One of: - Option 1: `showing_provider` - Option 2: null Example: ```json { "property": { "propertyID": "24", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "24", "managementFeeSettingID": "24", "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2028-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Insurance Co", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:46", "dateTimeModified": "2026-11-08 07:39:46", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } } ``` - `400`: `Property {propertyID} not found` for a well-formed ID with no property; `Unit not found` when `unit` is included and the single-family property has no unit row. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Property 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Property `POST /properties/{propertyID}` Operation ID: `updateProperty` Updates the fields sent and returns the property in the `GET /properties/{propertyID}` shape (without includes). Updates take POST only: PUT on this route answers the stock 404. ##### Use Cases - Correct a property's address, name or type - Set insurance, warranty, markup or contract details - Reassign the property to another user ##### Business Rules - Requires the **Update Property** permission (`Properties` › `UpdateProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a property outside those groups' portfolios. - The body is refused with `invalid input.` when it is empty or `{}`; then a well-formed ID with no property answers 400 `Property {propertyID} not found`. - Only the keys in the schema below are read; others are ignored, so `portfolioID`, `isActive` and `isMultiUnit` can't be changed here. - Validation errors come back as a map of field to messages (`{"name": ["Name cannot exceed 100 characters"]}`). - On a single-family property the new values are then copied onto the unit, and the unit's own validators apply to them, keyed `unit.`: a `city` longer than 50 characters is refused with `{"unit.city": ["Cannot exceed 50 characters"]}`. - A single-family property whose unit has been deleted (`DELETE /properties/{propertyID}/units/{unitID}` allows it) can't be updated: every update answers 400 `{"unit": ["No unit found for single family property: "]}`. - A multi-unit property can't be switched to a type that doesn't allow multiple units (Single Family Home `1` and Mobile Home `8`). - `markupPercent` and `markupAmount` can't both be set. - `deactivationReasonID` and `deactivationNotes` are kept only while the property is inactive: on an active property they are cleared, whatever is sent. ##### Side Effects - On a single-family property, the unit's `name`, `address`, `address2`, `city`, `stateID` and `postalCode` are overwritten from the property. - A changed address (`address`, `address2`, `city`, `stateID`, `postalCode`) is geocoded again, resets `addressValidationStatusID` to `1` (Not Validated), clears `addressValidationData` and queues a new validation. - A changed `reserveAmount` recalculates the owning portfolio's reserve amount. - On a single-family property, switching `propertyTypeID` to Commercial (`9`) clears the unit's `beds`, `fullBaths` and `halfBaths`; switching away from Commercial clears its `commercialSpaceTypeID`. - A changed `assignedToUserID` sends the new user the Property Assigned To User notification and records a User Assigned activity. - Fires the `property::property::updated` webhook event; a request with the `Suppress-Webhooks: 1` header doesn't. ##### Related Endpoints - `GET /properties/{propertyID}` - read the property with includes - `POST /properties/{propertyID}/activate` and `POST /properties/{propertyID}/deactivate` - change its status Parameters: - `propertyID` (path, integer, required): The property's ID. Request body, required: - `application/json`: `property_update` Example: ```json { "name": "APITEST Cedar House", "address": "123 Main St", "maintenanceLimitAmount": "400.00", "yearBuilt": 1998, "dateWarrantyExpires": "12/31/2029", "insuranceCompany": "Example Mutual" } ``` Responses: - `200`: The updated property - `application/json`: object - `property` (`property`, required) Example: ```json { "property": { "propertyID": "33", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "36", "managementFeeSettingID": "33", "name": "APITEST Cedar House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "400.00", "yearBuilt": "1998", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2029-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Mutual", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:49", "dateTimeModified": "2026-11-08 07:39:49", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } } ``` - `400`: `{"error": "invalid input."}` for an empty body or `{}`; `{"error": "Property {propertyID} not found"}` for a well-formed ID with no property; a map of field to messages for a validation failure, keyed `unit.` when the single-family unit's copy fails; `{"unit": ["No unit found for single family property: "]}` for a single-family property with no unit; `{"error": ""}` for any other error raised while saving. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Update Property** (`Properties` › `UpdateProperty`), or the property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete Property `DELETE /properties/{propertyID}` Operation ID: `deleteProperty` Permanently deletes a property with its units and everything attached to them, and returns the deleted property as it was (a bare property object, not wrapped in `property`). Refused while any accounting, inspection, lease or application history references the property or one of its units; deactivate it instead. ##### Use Cases - Remove a property created by mistake, before it has any history ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a property outside those groups' portfolios. - A well-formed ID with no property answers 400 `Property {propertyID} not found`. - Refused with a 400 keyed by the first blocker found, checked in this order: accounting transactions (`transactions`), transaction entries (`transactionEntries`), archived transaction entries (`transactionEntryArchives`), bills (`bills`), inspections (`inspections`), inspection areas (`inspectionAreas`), leases of any status (`leases`). Voided transactions still count. - Then each unit is deleted as `DELETE /properties/{propertyID}/units/{unitID}` deletes it, and its blockers answer the same 400 with a `unit.` prefix: `unit.transactions`, `unit.transactionEntries`, `unit.inspections`, `unit.inspectionAreas`, `unit.leases`, `unit.applications`, `unit.applicants`. A unit with no ledger answers `{"unit.ledger": ["Unit ledger not found"]}`. ##### Side Effects - Deletes the property row (a hard delete: it no longer appears anywhere). - Deletes each unit with everything `DELETE /properties/{propertyID}/units/{unitID}` removes (its ledger, work orders, recurring work orders, appliances, access points, features, images, listings and leads). - Deletes the property's ledger (multi-unit), listings, ownership history rows, images, features, homeowners' associations, appliances, access points, work orders, recurring work orders, budgets and syndicated (warehouse) listings. - Deletes the property's emails, activities, notes, alerts, file attachments, reminders, watchers, object dates and custom field values. - Recalculates the owning portfolio's reserve amount and writes a Property Deleted log entry. - Fires the `property::property::deleted` webhook event, and `unit::unit::deleted` for each unit; a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `POST /properties/{propertyID}/deactivate` - deactivate the property instead - `DELETE /properties/{propertyID}/units/{unitID}` - delete one unit Parameters: - `propertyID` (path, integer, required): The property's ID. Responses: - `200`: The deleted property, as it was before the delete - `application/json`: `property` Example: ```json { "propertyID": "75", "propertyImageID": "1", "propertyTypeID": "1", "isMultiUnit": "0", "isActive": "1", "portfolioID": "86", "managementFeeSettingID": "75", "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2028-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Insurance Co", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:40:47", "dateTimeModified": "2026-11-08 07:40:47", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } ``` - `400`: `{"error": "Property {propertyID} not found"}` for a well-formed ID with no property; `{"": ["Cannot delete a property that …"]}` when the property's history blocks the delete, `{"unit.": ["Cannot delete a unit that …"]}` when a unit's does; `{"error": ""}` for any other error raised while deleting. - `application/json`: object - `error` (string) Example: ```json { "error": "Property 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Deactivate Property `POST /properties/{propertyID}/deactivate` Operation ID: `deactivateProperty` Sets the property inactive, with a reason, and returns it in the `GET /properties/{propertyID}` shape (without includes). Its units are deactivated with it. ##### Use Cases - Take a property out of management (sold, owner moved in, management ended) while keeping its history ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a property outside those groups' portfolios. - The body must not be empty: an empty body or `{}` is refused with `invalid input.`, even though both fields are optional. Then a well-formed ID with no property answers 400 `Property {propertyID} not found`. - With no `deactivationReasonID`, the reason is stored as `99` (Unknown). - A single-family property whose unit has been deleted answers 400 `{"unit": ["No unit found for single family property: "]}`. - Refused when a unit has a current lease: `{"unit.leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}`. Close the lease first. ##### Side Effects - Deactivates every unit (single-family: its one unit), each with the unit deactivation side effects: its active listing and active recurring work orders are deactivated. - Deactivates the property's active recurring work orders. - Sets `dateTimeDeactivated` and recalculates the owning portfolio's reserve amount. - Fires the `property::property::updated` webhook event, and `unit::unit::updated` for each unit whose status changes; a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `POST /properties/{propertyID}/activate` - reactivate the property - `DELETE /properties/{propertyID}` - delete a property that has no history Parameters: - `propertyID` (path, integer, required): The property's ID. Request body, required: - `application/json`: object - `deactivationReasonID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", "7", "8", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "98", "99", 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 98, 99, null): Why the property is deactivated; defaults to `99` (Unknown). * `1` - Property Sold * `2` - Owner Moved In * `3` - Property Uninhabitable / Demolished * `4` - Owner Self-Managing * `5` - Switched to Competitor * `6` - Price / Fees * `7` - Service Quality * `8` - Management Terminated by Us * `10` - Foreclosure / Bank Repossession * `11` - Owner Deceased / Estate Closed * `12` - Entered in Error / Duplicate * `13` - Lease Only * `14` - Maintenance Handling * `15` - Accounting / Financial Errors * `16` - Leasing Performance * `17` - Communication Breakdown * `18` - Relationship / Staffing Issues * `19` - Owner Terminated Management * `20` - Portfolio Consolidation * `21` - Relationship Change / Divorce * `98` - Other * `99` - Unknown - `deactivationNotes` (string | null, max length 65535): Free-text notes about the deactivation. Example: ```json { "deactivationReasonID": 1, "deactivationNotes": "Example note." } ``` Responses: - `200`: The deactivated property - `application/json`: object - `property` (`property`, required) Example: ```json { "property": { "propertyID": "47", "propertyImageID": "1", "propertyTypeID": "2", "isMultiUnit": "1", "isActive": "0", "portfolioID": "52", "managementFeeSettingID": "47", "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2028-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Insurance Co", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:54", "dateTimeModified": "2026-11-08 07:39:54", "dateTimeDeactivated": "2026-11-08 07:39:54", "deactivationReasonID": "1", "deactivationNotes": "Example note.", "isFromImport": "0", "importSourceKey": null } } ``` - `400`: `{"error": "invalid input."}` for an empty body or `{}`; `{"error": "Property {propertyID} not found"}`; `{"unit": ["No unit found for single family property: "]}` for a single-family property with no unit; `{"unit.leaseID": [...]}` when a unit has a current lease; a map of field to messages for any other validation failure. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Activate Property `POST /properties/{propertyID}/activate` Operation ID: `activateProperty` Sets the property active and returns it in the `GET /properties/{propertyID}` shape (without includes). Takes no body. ##### Use Cases - Bring a deactivated property back into service, with or without its units ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a property outside those groups' portfolios. - A well-formed ID with no property answers 400 `Property {propertyID} not found`. - Activating an already active property still answers 200. - A single-family property whose unit has been deleted answers 400 `{"unit": ["No unit found for single family property: "]}`. ##### Side Effects - Multi-unit property: with `activateUnit=1` every unit is activated too, but only when the property was inactive; on an already active property the units keep their status. Without it the units keep their status. - Single-family property: its unit is activated with it, whatever `activateUnit` says, but only when the property was inactive. - Clears `dateTimeDeactivated`, `deactivationReasonID` and `deactivationNotes`. - Recalculates the owning portfolio's reserve amount. - Fires the `property::property::updated` webhook event, and `unit::unit::updated` for each unit whose status changes; a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `POST /properties/{propertyID}/deactivate` - deactivate the property - `POST /properties/units/{unitID}/activate` - activate one unit Parameters: - `propertyID` (path, integer, required): The property's ID. - `activateUnit` (query, integer, one of 0, 1, default 0): `1` also activates every unit of a multi-unit property that was inactive (no effect when the property is already active); `0` or omitted leaves the units as they are. No effect on a single-family property, whose unit is activated with it. Responses: - `200`: The activated property - `application/json`: object - `property` (`property`, required) Example: ```json { "property": { "propertyID": "42", "propertyImageID": "1", "propertyTypeID": "2", "isMultiUnit": "1", "isActive": "1", "portfolioID": "47", "managementFeeSettingID": "42", "name": "APITEST Maple House", "countryID": "US", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "county": "Example County", "assignedToUserID": "2", "legalDescription": "Lot 4, Block 2, Example Subdivision", "maintenanceLimitAmount": "375.00", "yearBuilt": "2001", "dateInsuranceExpires": "2027-06-30", "dateWarrantyExpires": "2028-12-31", "maintenanceNotes": "Example note.", "applicationTemplateID": null, "reserveAmount": "500.00", "markupPercent": "5.0000", "markupAmount": null, "markupAmountMin": "25.00", "markupAmountMax": "150.00", "dateContractBegins": "2026-01-01", "dateContractEnds": "2027-12-31", "commercialClassTypeID": null, "salesTaxSettingID": null, "withholdingTaxAgencyID": null, "insuranceCompany": "Example Insurance Co", "insuranceAgent": "Pat Example", "insurancePolicyNumber": "POL-0001", "requiredRentersInsuranceLiabilityAmount": "100000.00", "insuranceContactDetails": "555-0100", "leaseReturnChargeAmount": "15.00", "defaultMonthToMonthPremiumSettingID": null, "defaultResidentPackageID": null, "propertyShowingProviderID": null, "dateTimeCreated": "2026-11-08 07:39:53", "dateTimeModified": "2026-11-08 07:39:53", "dateTimeDeactivated": null, "deactivationReasonID": null, "deactivationNotes": null, "isFromImport": "0", "importSourceKey": null } } ``` - `400`: `Property {propertyID} not found` for a well-formed ID with no property; `{"unit": ["No unit found for single family property: "]}` for a single-family property with no unit; `{"error": ""}` or a map of field to messages for an error raised while saving. - `application/json`: object - `error` (string) Example: ```json { "error": "Property 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ### Units A unit is one rentable space of a property, with its market rent, deposit and layout, and the lease currently on it. List, create, read, update, activate, deactivate and delete a property's units here. #### List Units `GET /properties/{propertyID}/units` Operation ID: `listUnits` Returns a page of the property's units. Each item is keyed by entity: `unit`, plus `property`, `image`, `propertyImage` and `propertyManager` when included. ##### Use Cases - List a multi-unit property's units - Load each unit with its image and property records in one request ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups only gets units of properties in those groups' portfolios (a filtered 200, never a 403). - A `propertyID` with no property answers 200 with an empty list, not an error. - `isActive` defaults to `1`: only active units. `0` returns only inactive ones; any other value returns both. - `search` is a substring match on the unit's `name`, `address` and `address2`. - Rows come sorted by street number, street name, address 2, then `unitID`, a stable order for paging; no other order can be asked for. - The page size defaults to 20 and is capped at 5000. A `pageSize` of `0` or below fails with a 500. - `propertyImage` needs `property` as well; asked for without `property` it fails with a 500, except for a user restricted to portfolio groups, for whom the property is joined anyway. ##### Available Includes (4) - `property` - the unit's property - `image` - the unit's primary image - `propertyImage` - the property's primary image (needs `property`; without it the request fails with a 500) - `propertyManager` - the unit's property manager record (every field null when it has none) ##### Related Endpoints - `GET /properties/{propertyID}/units/{unitID}` - one unit, with more includes - `POST /properties/{propertyID}/units` - add a unit - `GET /properties/{propertyID}` - the property Parameters: - `propertyID` (path, integer, required): The property's ID. - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 20): Items per page (default 20). Values above 5000 are served at 5000. `0` or a negative value fails with a 500 and no body. - `search` (query, string): Substring match on the unit's `name`, `address` and `address2`. - `isActive` (query, string, default "1"): `1` (the default) returns active units, `0` inactive ones. `true`/`false` and `yes`/`no` are read the same way; any other value returns both. - `includes` (query, string): Comma-separated related records to add to each item: `property`, `image`, `propertyImage` (needs `property`), `propertyManager`. Responses: - `200`: A page of units - `application/json`: object[] - Each item: - `unit` (`unit`, required) - `token` (string, pattern `^[0-9]+$`): The current Unix time. Sent only when no include is requested; carries no meaning for clients. - `property` (`property`): Requires the `property` include. - `image` (`property_image`): The unit's primary image. Requires the `image` include. - `propertyImage` (`property_image`): The property's primary image. Requires the `property` and `propertyImage` includes. - `propertyManager` (object): The unit's property manager record; every field is null when the unit has none. Requires the `propertyManager` include. - `propertyManagerID` (string | null, required, pattern `^-?[0-9]+$`) - `name` (string | null, required) - `email` (string | null, required) - `phone` (string | null, required) Example: ```json [ { "unit": { "unitID": "64", "propertyID": "79", "propertyImageID": "1", "isActive": "1", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:14", "dateTimeModified": "2026-11-08 07:44:14", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." }, "token": "1794123854" } ] ``` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` - `500`: A `pageSize` of `0` or below, or the `propertyImage` include without `property`, makes the query throw; production answers 500 with no body. #### Create Unit `POST /properties/{propertyID}/units` Operation ID: `createUnit` Adds a unit to the property and returns it in the `GET /properties/{propertyID}/units/{unitID}` shape (without includes). ##### Use Cases - Add a unit to a multi-unit property ##### Business Rules - Requires the **Update Property** permission (`Properties` › `UpdateProperty`). - The body is refused with `invalid input.` when it is empty or `{}`. - The unit belongs to the property in the URL; a `propertyID` in the body is ignored, as is any key not in the schema below. - `address`, `city`, `stateID` and `rent` are required. - An empty `size` is stored as null. - A single-family property already has its one unit: adding another is refused with 400 `{"propertyID": ["Unit already exists on property"]}`. - When the property doesn't exist, or is outside the API user's portfolio groups, nothing is created and the API answers 400 with an empty array `[]` as the body. ##### Side Effects - Creates the unit's ledger and an inactive listing for it. - On a multi-unit property, geocodes the unit's address and queues an address validation (`addressValidationStatusID` starts at `1`). - Fires the `unit::unit::created` webhook event; a request with the `Suppress-Webhooks: 1` header doesn't. ##### Related Endpoints - `GET /properties/{propertyID}/units` - list the property's units - `GET /properties/{propertyID}/units/{unitID}` - read the unit with includes - `DELETE /properties/{propertyID}/units/{unitID}` - delete a unit Parameters: - `propertyID` (path, integer, required): The property to add the unit to. Request body, required: - `application/json`: `unit_create` Example: ```json { "name": "Unit 1A", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "rent": "1500.00", "deposit": "800.00", "size": 1200, "beds": 3, "fullBaths": 2, "halfBaths": 1, "entryInstructions": "Use the side gate" } ``` Responses: - `200`: The created unit - `application/json`: object - `unit` (`unit`, required) Example: ```json { "unit": { "unitID": "79", "propertyID": "94", "propertyImageID": "1", "isActive": "1", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:18", "dateTimeModified": "2026-11-08 07:44:18", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": null, "entryInstructions": "Use the side gate", "vendorEntryInstructions": null, "maintenanceNotes": null } } ``` - `400`: `{"error": "invalid input."}` for an empty body or `{}`; a map of field to messages for a validation failure; `[]` (an empty array) when the property doesn't exist or is outside the API user's portfolio groups; `{"error": ""}` for any other error raised while saving. - `application/json`: one of several shapes - One of: - Option 1: object - `error` (string) - Option 2: string[] Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Update Property** (`Properties` › `UpdateProperty`). - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Get Unit `GET /properties/{propertyID}/units/{unitID}` Operation ID: `getUnit` Returns one unit under `unit`, plus one top-level key per requested include. ##### Use Cases - Show a unit with its current lease, listing and appliances - Load the unit's property, portfolio and owners in the same request ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups gets a 403 `Access Denied` for a unit of a property outside those groups' portfolios. - A well-formed `unitID` with no unit, or a unit that belongs to another property, answers 400 `Unit {unitID} not found`; a value that isn't a number answers the stock 404. - `propertyImage`, `portfolio`, `associations` and `owners` need `property` as well; `portfolioBalances` needs `property` and `portfolio`; `leaseBalances` needs `lease` and a current lease. Without what they need they are not sent. - `managementFeeSetting` is read from the property: without the `property` include it comes back as `false`. - `listing` adds two keys, `listing` and `listingFiles`. ##### Available Includes (22) - `property` - the unit's property - `propertyImage` - the property's primary image - `portfolio` - the property's owning portfolio - `portfolioBalances` - balances of the portfolio's ledger - `owners` - the portfolio's owners, with their contacts - `associations` - the property's homeowners' associations, with their contacts - `image` - the unit's primary image - `lease` - the unit's current lease, or null - `leaseBalances` - balances of the current lease - `pastLeases` - the unit's closed leases - `futureLeases` - the unit's pending leases - `listing` - the unit's listing (an unsaved, mostly empty one when none exists) and its files as `listingFiles` - `appliances` - the unit's appliances - `filters` - the unit's air filters - `filterDeliveryConfiguration` - whether the unit's air-filter delivery is set up - `filterDeliveryAddress` - the unit's custom filter delivery address, or `false` - `filterDeliverySchedule` - the unit's filter delivery schedule, or `false` - `managementFeeSetting` - the property's management fee setting (`false` without `property`) - `workOrders` - the unit's work orders, with their vendor contact - `inspections` - the unit's inspections - `propertyManager` - the unit's property manager record, or `false` - `ledger` - the unit's ledger, or null ##### Related Endpoints - `GET /properties/{propertyID}/units` - list the property's units - `POST /properties/{propertyID}/units/{unitID}` - update the unit - `DELETE /properties/{propertyID}/units/{unitID}` - delete the unit - `GET /properties/{propertyID}` - the property Parameters: - `propertyID` (path, integer, required): The unit's property. - `unitID` (path, integer, required): The unit's ID. - `includes` (query, string): Comma-separated related records to add: `property`, `propertyImage`, `portfolio`, `portfolioBalances`, `owners`, `associations`, `image`, `lease`, `leaseBalances`, `pastLeases`, `futureLeases`, `listing`, `appliances`, `filters`, `filterDeliveryConfiguration`, `filterDeliveryAddress`, `filterDeliverySchedule`, `managementFeeSetting`, `workOrders`, `inspections`, `propertyManager`, `ledger`. An unknown name is ignored. Responses: - `200`: The unit - `application/json`: object - `unit` (`unit`, required) - `property` (`property`): Requires the `property` include. - `propertyImage` (`property_image`): Requires the `property` and `propertyImage` includes. - `portfolio` (`included_portfolio`): Requires the `property` and `portfolio` includes. - `portfolioBalances` (`portfolio_balances`): Requires the `property`, `portfolio` and `portfolioBalances` includes. - `owners` (`owner_row`[]): Requires the `property` and `owners` includes. - `associations` (`association_row`[]): Requires the `property` and `associations` includes. - `image` (`property_image`): The unit's primary image. Requires the `image` include. - `lease` (one of several shapes): The unit's current lease, or null. Requires the `lease` include. - One of: - Option 1: `included_lease` - Option 2: null - `leaseBalances` (`lease_balances`): Requires the `lease` and `leaseBalances` includes, and a current lease. - `filterDeliveryConfiguration` (`filter_delivery_configuration`): Requires the `filterDeliveryConfiguration` include. - `pastLeases` (`included_lease`[]): Closed leases. Requires the `pastLeases` include. - `futureLeases` (`included_lease`[]): Pending leases. Requires the `futureLeases` include. - `listing` (`listing`): Requires the `listing` include. - `listingFiles` (`listing_file`[]): The listing's files plus the account-wide listing files (null `propertyListingID`). Sent with `listing`. - `appliances` (`appliance`[]): Requires the `appliances` include. - `filters` (`filter`[]): Requires the `filters` include. - `filterDeliveryAddress` (one of several shapes): The unit's custom delivery address, or `false` (not null) when it has none. Requires the `filterDeliveryAddress` include. - One of: - Option 1: `filter_delivery_address` - Option 2: any - `filterDeliverySchedule` (one of several shapes): The unit's delivery schedule, or `false` (not null) when it has none. Requires the `filterDeliverySchedule` include. - One of: - Option 1: `filter_delivery_schedule` - Option 2: any - `managementFeeSetting` (one of several shapes): The property's management fee setting; `false` when `property` isn't included. Requires the `managementFeeSetting` include. - One of: - Option 1: `included_management_fee_setting` - Option 2: any - `workOrders` (`work_order_row`[]): Requires the `workOrders` include. - `inspections` (`inspection_row`[]): Requires the `inspections` include. - `propertyManager` (one of several shapes): The unit's property manager record, or `false` (not null) when it has none. Requires the `propertyManager` include. - One of: - Option 1: `property_manager` - Option 2: any - `ledger` (one of several shapes): The unit's ledger, or null. Requires the `ledger` include. - One of: - Option 1: `included_ledger` - Option 2: null Example: ```json { "unit": { "unitID": "73", "propertyID": "86", "propertyImageID": "1", "isActive": "1", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:16", "dateTimeModified": "2026-11-08 07:44:16", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." } } ``` - `400`: `Unit {unitID} not found` for a well-formed ID with no unit, or a unit of another property. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Unit 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The unit's property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Access Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Unit (PUT) `PUT /properties/{propertyID}/units/{unitID}` Operation ID: `updateUnitPut` The same update as `POST /properties/{propertyID}/units/{unitID}`, sent with PUT: the same partial body, rules, side effects and responses. It is not a full replacement: keys left out keep their values. ##### Business Rules - Requires the **Update Property** permission (`Properties` › `UpdateProperty`). - Every rule of `POST /properties/{propertyID}/units/{unitID}` applies. ##### Related Endpoints - `POST /properties/{propertyID}/units/{unitID}` - the same update with POST Parameters: - `propertyID` (path, integer, required): The unit's property (not checked against the unit). - `unitID` (path, integer, required): The unit's ID. Request body, required (shared request body `unit_update`): - `application/json`: `unit_update` Example: ```json { "name": "Unit 1B", "rent": "1650.00", "size": "", "isNonRevenue": 1, "nonRevenueTypeID": 1, "nonRevenueStartDate": "04/23/2026", "isUtilityBillingEnabled": 0 } ``` Responses: - `200`: see shared response `unit_update_200` - `400`: see shared response `unit_update_400` - `401`: see shared response `error_401` - `403`: see shared response `unit_update_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Unit `POST /properties/{propertyID}/units/{unitID}` Operation ID: `updateUnit` Updates the fields sent and returns the unit in the `GET /properties/{propertyID}/units/{unitID}` shape (without includes). `PUT` on the same route does exactly the same (`updateUnitPut`). ##### Use Cases - Change a unit's rent, deposit, layout or address - Mark a unit non-revenue (renovation, model unit) - Set up air-filter delivery for the unit ##### Business Rules - Requires the **Update Property** permission (`Properties` › `UpdateProperty`). - The body is refused with `invalid input.` when it is empty or `{}`; then a well-formed `unitID` with no unit answers 400 `Unit {unitID} not found`. - The unit is looked up by `unitID` alone: the `propertyID` in the path isn't checked against it. - A user restricted to portfolio groups gets a 403 `Access Denied` for a unit of a property outside those groups' portfolios. - Only the keys in the schema below are read; others are ignored. - `propertyManagerID` can't be changed: a non-empty value other than the stored one is refused with a 400, and that check runs before every other, so it comes back alone (`{"propertyManagerID": ["Deprecated Field: …"]}`) whatever else the body gets wrong. An empty or null value clears the stored one. - `nonRevenueTypeID` is required when `isNonRevenue` is `1`; `nonRevenueTypeID` and `nonRevenueStartDate` are cleared when it is `0`. - An empty `size` (`""` or `0`) is stored as null. - Dates accept `YYYY-MM-DD` or `MM/DD/YYYY` and are returned as `YYYY-MM-DD`. ##### Side Effects - On a single-family property, the unit's `name`, `address`, `address2`, `city`, `stateID` and `postalCode` are written to the property too. - A changed address is geocoded again and resets the unit's address validation (and, on a single-family property, the property's). - A changed `filterDeliveryScheduleID`, `filterDeliveryAddressTypeID` or `filterDeliveryAddressID` re-syncs the active lease's Filter Delivery subscriptions: a pending one may start, and a live one gets the new address or schedule. - Fires the `unit::unit::updated` webhook event; a request with the `Suppress-Webhooks: 1` header doesn't. ##### Related Endpoints - `GET /properties/{propertyID}/units/{unitID}` - read the unit with includes - `POST /properties/units/{unitID}/activate` and `POST /properties/units/{unitID}/deactivate` - change its status Parameters: - `propertyID` (path, integer, required): The unit's property (not checked against the unit). - `unitID` (path, integer, required): The unit's ID. Request body, required (shared request body `unit_update`): - `application/json`: `unit_update` Example: ```json { "name": "Unit 1B", "rent": "1650.00", "size": "", "isNonRevenue": 1, "nonRevenueTypeID": 1, "nonRevenueStartDate": "04/23/2026", "isUtilityBillingEnabled": 0 } ``` Responses: - `200`: see shared response `unit_update_200` - `400`: see shared response `unit_update_400` - `401`: see shared response `error_401` - `403`: see shared response `unit_update_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete Unit `DELETE /properties/{propertyID}/units/{unitID}` Operation ID: `deleteUnit` Permanently deletes a unit and everything attached to it, and returns the deleted unit as it was (a bare unit object, not wrapped in `unit`). Refused while any accounting, lease, application or inspection history references the unit; deactivate it instead. Deleting the only unit of a single-family property is allowed, and leaves a property that can no longer be updated, activated or deactivated (400 `{"unit": ["No unit found for single family property: "]}`) and whose `GET` with `includes=unit` answers 400 `Unit not found`: delete the property instead. ##### Use Cases - Remove a unit created by mistake, before it has any history ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A well-formed `unitID` with no unit, or a unit of another property, answers 400 `Unit {unitID} not found`. - A user restricted to portfolio groups gets a 403 `Access Denied` for a unit of a property outside those groups' portfolios. - Refused with a 400 keyed by the first blocker found, checked in this order: accounting transactions (`transactions`), transaction entries (`transactionEntries`), inspections (`inspections`), inspection areas (`inspectionAreas`), leases of any status (`leases`), applications (`applications`), applicants (`applicants`). Voided and closed records still count. ##### Side Effects - Deletes the unit row (a hard delete). - Deletes the unit's ledger, work orders, recurring work orders, appliances, access points (with their credentials), features, images, listings, leads and syndicated (warehouse) listings. - Deletes the unit's emails, activities, notes, alerts, file attachments, reminders, watchers, object dates and custom field values, and writes a Unit Deleted log entry. - Fires the `unit::unit::deleted` webhook event; a request with the `Suppress-Webhooks: 1` header doesn't. ##### Related Endpoints - `POST /properties/units/{unitID}/deactivate` - deactivate the unit instead - `DELETE /properties/{propertyID}` - delete the whole property Parameters: - `propertyID` (path, integer, required): The unit's property; must match the unit. - `unitID` (path, integer, required): The unit's ID. Responses: - `200`: The deleted unit, as it was before the delete - `application/json`: `unit` Example: ```json { "unitID": "92", "propertyID": "112", "propertyImageID": "1", "isActive": "1", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:22", "dateTimeModified": "2026-11-08 07:44:22", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." } ``` - `400`: `{"error": "Unit {unitID} not found"}`; `{"": ["Cannot delete a unit that …"]}` when history blocks the delete; `{"error": ""}` for any other error raised while deleting. - `application/json`: object - `error` (string): Set when the unit is not found, or for any other error raised while deleting. Example: ```json { "error": "Unit 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the unit's property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Activate Unit `POST /properties/units/{unitID}/activate` Operation ID: `activateUnit` Sets the unit active and returns it in the `GET /properties/{propertyID}/units/{unitID}` shape (without includes). Takes no body. ##### Use Cases - Bring a unit back after a renovation or seasonal closure ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a unit of a property outside those groups' portfolios. - A well-formed ID with no unit answers 400 `Unit {unitID} not found`. - On a multi-unit property the property must be active first; otherwise 400 `{"property": ["Property is not active"]}`. ##### Side Effects - On a single-family property, the property is activated with its unit. - Clears the unit's `dateTimeDeactivated`. - Fires the `unit::unit::updated` webhook event (and `property::property::updated` when the property's status changes with it); a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `POST /properties/units/{unitID}/deactivate` - deactivate the unit - `POST /properties/{propertyID}/activate` - activate the property (and optionally all its units) - `GET /properties/{propertyID}/units/{unitID}` - read the unit Parameters: - `unitID` (path, integer, required): The unit's ID. Responses: - `200`: The activated unit - `application/json`: `unit_detail` Example: ```json { "unit": { "unitID": "96", "propertyID": "118", "propertyImageID": "1", "isActive": "1", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:24", "dateTimeModified": "2026-11-08 07:44:24", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." } } ``` - `400`: `{"error": "Unit {unitID} not found"}`; `{"property": ["Property is not active"]}` on a multi-unit property that is inactive; a map of field to messages, or `{"error": ""}`, for an error raised while saving. - `application/json`: object - `error` (string): Set when the unit is not found, or for another error raised while saving. Example: ```json { "error": "Unit 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the unit's property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Deactivate Unit `POST /properties/units/{unitID}/deactivate` Operation ID: `deactivateUnit` Sets the unit inactive and returns it in the `GET /properties/{propertyID}/units/{unitID}` shape (without includes), with `isActive` `0` and `dateTimeDeactivated` set. Takes no body. ##### Use Cases - Take a unit offline for a renovation or seasonal closure ##### Business Rules - Requires the **Change Property Status** permission (`Properties` › `ChangeStatusProperty`). - A user restricted to portfolio groups gets a 403 `Access Denied` for a unit of a property outside those groups' portfolios. - A well-formed ID with no unit answers 400 `Unit {unitID} not found`. - Refused while the unit has a current lease: 400 `{"leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}`. ##### Side Effects - Deactivates the unit's active listing and its active recurring work orders. - On a single-family property, the property is deactivated with its unit (reason `99`, Unknown), and so are the property's own active recurring work orders. - Fires the `unit::unit::updated` webhook event (and `property::property::updated` when the property's status changes with it); a request with the `Suppress-Webhooks: 1` header fires none. ##### Related Endpoints - `POST /properties/units/{unitID}/activate` - reactivate the unit - `POST /properties/{propertyID}/deactivate` - deactivate the whole property - `DELETE /properties/{propertyID}/units/{unitID}` - delete a unit that has no history Parameters: - `unitID` (path, integer, required): The unit's ID. Responses: - `200`: The deactivated unit - `application/json`: `unit_detail` Example: ```json { "unit": { "unitID": "101", "propertyID": "123", "propertyImageID": "1", "isActive": "0", "name": "Unit 1A", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1500.00", "deposit": "800.00", "size": "1200", "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "0", "nonRevenueTypeID": null, "nonRevenueStartDate": null, "isUtilityBillingEnabled": "1", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:26", "dateTimeModified": "2026-11-08 07:44:26", "dateTimeDeactivated": "2026-11-08 07:44:26", "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." } } ``` - `400`: `{"error": "Unit {unitID} not found"}`; `{"leaseID": [...]}` while the unit has a current lease; a map of field to messages, or `{"error": ""}`, for an error raised while saving. - `application/json`: object - `error` (string): Set when the unit is not found, or for another error raised while saving. Example: ```json { "error": "Unit 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: The API user's role lacks **Change Property Status** (`Properties` › `ChangeStatusProperty`), or the unit's property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ## Resident Experience ### Resident Services The account's REP (Resident Experience Package) service catalog. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service, and can be offered à la carte or bundled into a package. Per-account config — no portfolio scoping. #### List Resident Services `GET /resident/services` Operation ID: `listResidentServices` Returns the account's REP service catalog (`resident_services`). ##### Business Rules - Per-account config — no portfolio scoping. - `isActive` is omitted by default (returns active **and** inactive). Pass `isActive=1` for active only, `isActive=0` for inactive. - `search` matches against the service name. - Not paginated — the full catalog is returned as a flat array. ##### Related Endpoints - `POST /resident/services` — create a service - `GET /resident/services/{residentServiceID}` — retrieve a single service - `GET /resident/packages` — the packages these services can be bundled into Parameters: - `search` (query, string): Full-text search against the service name. - `isActive` (query, integer, one of 0, 1): Filter by active status. Pass `1` for active only, `0` for inactive. Omit for all. - `serviceTypeID` (query, integer): Filter by service type (e.g. `3` = Pest Control). Responses: - `200`: Successfully retrieved the service catalog. - `application/json`: object[] - Each item: - `service` (`service`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Resident Service `POST /resident/services` Operation ID: `createResidentService` Creates a REP service in the account catalog. ##### Business Rules - Requires the **Manage Account Settings** permission. - `name` is required for a Custom service (`serviceTypeID` = 1); a system service may omit it. - `defaultRecurringChargeAmount` must be greater than `0.00`. - `recurringChargeAccountID` must reference a charge-type GL account. Request body, required: - `application/json`: object - `serviceTypeID` (string | integer, required, pattern `^-?[0-9]+$`): Service type: `1` Custom, `2` Filter Delivery, `3` Pest Control, `4` ID Protection & Rewards, `5` Positive Credit Reporting, `6` Utility Connection, `7` Group Internet. - `name` (string): Display name (required for Custom; optional for system types). - `description` (string): Optional resident-facing description. - `recurringChargeDescription` (string): Ledger-line text for the recurring charge. - `recurringChargeAccountID` (string | integer, pattern `^-?[0-9]+$`): GL account the recurring charge posts to. - `defaultRecurringChargeAmount` (string | number, decimal): Default monthly retail amount (greater than 0). - `isActive` (string | integer, one of "0", "1", 0, 1): Whether the service is offered. Defaults to `1`. Responses: - `200`: Service created. - `application/json`: `service` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Resident Service `GET /resident/services/{residentServiceID}` Operation ID: `getResidentService` Retrieves a single REP service from the account catalog. Parameters: - `residentServiceID` (path, integer, required): ID of the resident service. Responses: - `200`: Successfully retrieved the service. - `application/json`: `service` - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Resident Service `POST /resident/services/{residentServiceID}` Operation ID: `updateResidentService` Updates a REP service. ##### Business Rules - Requires the **Manage Account Settings** permission. - `serviceTypeID` is immutable — it cannot be changed once the service exists. - `name` remains required for a Custom service. Parameters: - `residentServiceID` (path, integer, required): ID of the resident service. Request body, required: - `application/json`: object - `name` (string) - `description` (string) - `recurringChargeDescription` (string) - `recurringChargeAccountID` (string | integer, pattern `^-?[0-9]+$`) - `defaultRecurringChargeAmount` (string | number, decimal) - `isActive` (string | integer, one of "0", "1", 0, 1) Responses: - `200`: Service updated. - `application/json`: `service` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete Resident Service `DELETE /resident/services/{residentServiceID}` Operation ID: `deleteResidentService` Deletes a REP service from the catalog. ##### Business Rules - Requires the **Manage Account Settings** permission. - A **system** service cannot be deleted — deactivate it instead (`isActive = 0`). - A service **in use** cannot be deleted: it is rejected (`400`) when any lease references it or it belongs to a package. Remove it from those first. Parameters: - `residentServiceID` (path, integer, required): ID of the resident service. Responses: - `200`: Service deleted (the deleted service is returned). - `application/json`: `service` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ### Resident Packages The account's REP package catalog. A package bundles services and bills the resident a single recurring charge. Per-account config — no portfolio scoping. #### List Resident Packages `GET /resident/packages` Operation ID: `listResidentPackages` Returns the account's REP package catalog (`resident_packages`). ##### Business Rules - Per-account config — no portfolio scoping. - `isActive` is omitted by default (returns active **and** inactive). Pass `isActive=1` for active only, `isActive=0` for inactive. - `search` matches against the package name. - Not paginated — the full catalog is returned as a flat array. The member services are **not** embedded here; fetch a single package with `?includes=packageServices` for those. ##### Related Endpoints - `POST /resident/packages` — create a package - `GET /resident/packages/{residentPackageID}` — retrieve a single package (with `packageServices`) - `GET /resident/services` — the services a package bundles Parameters: - `search` (query, string): Full-text search against the package name. - `isActive` (query, integer, one of 0, 1): Filter by active status. Pass `1` for active only, `0` for inactive. Omit for all. Responses: - `200`: Successfully retrieved the package catalog. - `application/json`: object[] - Each item: - `package` (`package`) - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Create Resident Package `POST /resident/packages` Operation ID: `createResidentPackage` Creates a REP package and its service membership in one call. ##### Business Rules - Requires the **Manage Account Settings** permission. - `services` is the bundle's membership — an array of `{ residentServiceID }`. At least one service is required. - Every `residentServiceID` must reference an existing, active service in the account catalog. - `defaultRecurringChargeAmount` is the single bundled retail amount billed to the resident (greater than `0.00`); it is independent of the member services' à la carte amounts. Request body, required: - `application/json`: object - `name` (string, required): Display name of the package. - `recurringChargeDescription` (string): Ledger-line text for the bundled recurring charge. - `recurringChargeAccountID` (string | integer, pattern `^-?[0-9]+$`): GL account the bundled charge posts to. - `defaultRecurringChargeAmount` (string | number, decimal): Monthly retail amount for the bundle (greater than 0). - `isActive` (string | integer, one of "0", "1", 0, 1): Whether the package is offered. Defaults to `1`. - `services` (object[], required): The services bundled into this package. At least one is required. - `residentServiceID` (string | integer, required, pattern `^-?[0-9]+$`): ID of a service in the account catalog. Responses: - `200`: Package created. - `application/json`: object - `package` (`package`) - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Resident Package `GET /resident/packages/{residentPackageID}` Operation ID: `getResidentPackage` Retrieves a single REP package from the account catalog. Pass `includes=packageServices` to embed the bundle's membership rows alongside their joined service definitions. Parameters: - `residentPackageID` (path, integer, required): ID of the resident package. - `includes` (query, string): Comma-separated related data to embed. Supported — `packageServices`. Responses: - `200`: Successfully retrieved the package. - `application/json`: object - `package` (`package`) - `packageServices` (object[]): Present only when requested via `includes=packageServices`. Each entry pairs the membership row with its joined service. - `packageService` (`package_service`) - `service` (`service`) - `401`: see shared response `error_401` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Update Resident Package `POST /resident/packages/{residentPackageID}` Operation ID: `updateResidentPackage` Updates a REP package, including its service membership. ##### Business Rules - Requires the **Manage Account Settings** permission. - When `services` is supplied it **replaces** the package's membership: services not in the array are removed and new ones are added. At least one service must remain. - Every `residentServiceID` must reference an existing, active service in the account catalog. Parameters: - `residentPackageID` (path, integer, required): ID of the resident package. Request body, required: - `application/json`: object - `name` (string) - `recurringChargeDescription` (string) - `recurringChargeAccountID` (string | integer, pattern `^-?[0-9]+$`) - `defaultRecurringChargeAmount` (string | number, decimal) - `isActive` (string | integer, one of "0", "1", 0, 1) - `services` (object[]): Replaces the package membership when supplied. At least one service is required. - `residentServiceID` (string | integer, required, pattern `^-?[0-9]+$`) Responses: - `200`: Package updated. - `application/json`: object - `package` (`package`) - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete Resident Package `DELETE /resident/packages/{residentPackageID}` Operation ID: `deleteResidentPackage` Deletes a REP package from the catalog. ##### Business Rules - Requires the **Manage Account Settings** permission. - A package **in use** cannot be deleted: it is rejected (`400`) when any lease is enrolled in it. The membership rows (`resident_package_services`) are removed with the package. Parameters: - `residentPackageID` (path, integer, required): ID of the resident package. Responses: - `200`: Package deleted (the deleted package is returned). - `application/json`: `package` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` ## Marketing ### Listings A listing advertises one unit for rent: headline, description, pet and utility details, and the syndication flags for each listing site. Search the account's listings, with each unit's property, portfolio and primary image, and fetch property images from the CDN here. #### Search Listings `GET /properties/listings/search` Operation ID: `searchListings` Returns a filtered page of unit listings, each row denormalized: the `listing`, its `unit`, the `property`, the property's groups, its `portfolio`, the unit's property manager, and the unit's primary `image` as CDN URLs. ##### Use Cases - Build a vacancy board or a public listings page filtered by rent, beds, baths, pets and location - Feed a syndication partner the listings marked active for it (`isZillowActive`, `isZumperActive`, …) - Search a map area with a latitude/longitude box - Pull the listings changed in a time window for a sync ##### Business Rules - Requires only authentication; no permission is checked. - A user restricted to portfolio groups only gets listings of properties in those groups' portfolios (a filtered 200, never a 403). - Only listings of active units on active properties are ever returned, whatever the filters say. With no `isActive`, active and inactive listings are both returned. - A filter value the API can't read is ignored rather than refused (a boolean other than `1`/`0`/`true`/`false`/`yes`/`no`, a date it can't parse, an unknown `orderBy`). - The latitude/longitude box applies only when all four of `latitudeMin`, `latitudeMax`, `longitudeMin` and `longitudeMax` are sent. - Exclude property types with `notPropertyTypeID[]` (singular); `notPropertyTypeIDs[]` is not read and excludes nothing. - List filters (`propertyTypeIDs[]` and the others ending in `[]`) take one `name[]=value` per value; a single plain `name=value` is read as a one-item list. - The page size defaults to 25 and has no cap. `pagination-page-size` reports the page size or the number of matching items, whichever is smaller, and 15 when nothing matches. - Sorted by `orderBy` (default `unit.address`), then `propertyListingID`. - The listing's syndication flags (`isWebsiteActive`, `isZillowActive`, …) can be filtered on but are not part of the row. ##### Related Endpoints - `GET /properties/listings` (undocumented) - the plain listing list - `GET /properties/{propertyID}/units/{unitID}/listing` (undocumented) - one listing, with its syndication flags - `GET /listings/{propertyListingID}/files` (undocumented) - the photos and documents of a listing - `GET /properties/{propertyID}/units/{unitID}` - the unit, with the `listing` include Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Items per page (default 25). No cap. - `orderBy` (query, string): Sort column, optionally followed by `|asc` or `|desc` (default `asc`); several are separated by commas. An unknown column is ignored; when every column sent is unknown, the default sort is skipped too and rows come by `propertyListingID` alone. `propertyListingID` always breaks ties. Columns: `unit.address` (the default), `unit.address2`, `unit.beds`, `listing.propertyListingID`, `availabilityDate`, `date` (advertised date), `amount` (rent), `beds`, `baths` (full + half), `area` (size). - `search` (query, string): Substring match on the listing's headline and description and the unit's address, address 2, city and postal code. - `isActive` (query, string): `1` active listings only, `0` inactive ones; omitted returns both. - `isWebsiteActive` (query, string): `1` or `0`: listings published, or not, to the website. - `isZillowActive` (query, string): `1` or `0`: listings syndicated, or not, to Zillow. - `isRentalSourceActive` (query, string): `1` or `0`: listings syndicated, or not, to RentalSource. - `isRentalscomActive` (query, string): `1` or `0`: listings syndicated, or not, to Rentals.com. - `isZumperActive` (query, string): `1` or `0`: listings syndicated, or not, to Zumper. - `isApartmentsActive` (query, string): `1` or `0`: listings syndicated, or not, to Apartments.com. - `isVacant` (query, string): `1` units with no current lease, `0` units with one. - `rentMin` (query, number): Minimum unit rent, inclusive. - `rentMax` (query, number): Maximum unit rent, inclusive. - `bedsMin` (query, integer): Minimum bedrooms, inclusive. - `bedsMax` (query, integer): Maximum bedrooms, inclusive. - `bathsMin` (query, integer): Minimum bathrooms, inclusive, counting full and half baths alike (`fullBaths` + `halfBaths`). - `bathsMax` (query, integer): Maximum bathrooms, inclusive, counted the same way. - `petFilterOptionID` (query, integer, one of 1, 2, 3, 4): * `1` - Dogs allowed * `2` - Cats allowed * `3` - Dogs and cats allowed * `4` - No pets (neither dogs nor cats) - `city` (query, string): Substring match on the unit's city. - `stateID` (query, string): The unit's state code, matched exactly. - `postalCode` (query, string): Substring match on the unit's postal code. - `latitudeMin` (query, number): South edge of the map box; used only with the other three box parameters. - `latitudeMax` (query, number): North edge of the map box. - `longitudeMin` (query, number): West edge of the map box. - `longitudeMax` (query, number): East edge of the map box. - `propertyTypeIDs[]` (query, integer[]): Only these property types. One `propertyTypeIDs[]=` per value. * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot - `notPropertyTypeID[]` (query, integer[]): Leave out these property types (same values as `propertyTypeIDs[]`). One `notPropertyTypeID[]=` per value. The name is singular. - `portfolioIDs[]` (query, integer[]): Only listings of properties owned by these portfolios (from `GET /portfolios`). - `portfolioGroupIDs[]` (query, integer[]): Only listings of properties whose portfolio belongs to one of these portfolio groups. - `propertyGroupIDs[]` (query, integer[]): Only listings of properties in one of these property groups. - `propertyManagerIDs[]` (query, integer[]): Only listings of units with one of these property manager records. - `assignedToUserIDs[]` (query, integer[]): Only listings of properties assigned to one of these users. - `showingProviderID` (query, integer, one of 2, 3, 4, 5): Only listings of properties using this showing provider type. When it is the account's default provider, properties with no provider of their own match too. * `2` - Tenant Turner * `3` - Rently * `4` - ShowMojo * `5` - ShowingHero - `dateTimeModifiedMin` (query, string): Only listings modified at or after this time. Accepts `YYYY-MM-DD HH:MM:SS`, ISO 8601 or `MM/DD/YYYY`; the time is read as UTC (any offset is dropped). A value it can't parse is ignored. - `dateTimeModifiedMax` (query, string): Only listings modified at or before this time. Same forms as `dateTimeModifiedMin`. Responses: - `200`: A page of matching listings - `application/json`: `listing_search_row`[] Example: ```json [ { "listing": { "propertyListingID": "43", "isActive": "1", "propertyID": "184", "unitID": "172", "headline": "APITEST-6af02c9a8d712", "description": "Deleniti provident voluptates voluptatem. Possimus quo et officiis et. Sunt porro molestiae nihil quis et cupiditate voluptates. Quos tempore aut tempora veritatis.", "lotSize": null, "depositDescription": null, "availabilityDate": "2026-12-08", "advertisedDate": "2026-11-08", "virtualTour": null, "lockboxNumber": null, "lockboxDescription": null, "parkingSpaces": null, "parkingTypeID": null, "areaInformation": null, "schools": null, "leaseDescription": null, "name": "Jane Doe", "phone": "555-0100", "phoneExtension": null, "email": "jane.doe@example.com", "secondaryName": null, "secondaryPhone": null, "secondaryPhoneExtension": null, "secondaryEmail": null, "applicationUrl": null, "size": "1200", "isFurnished": "0", "acceptDogs": "1", "acceptCats": "1", "petDescription": null, "acceptSmoking": "0", "acceptAssistance": "1", "isGasIncluded": "0", "isElectricIncluded": "0", "isWaterIncluded": "0", "isSewageIncluded": "0", "isGarbageIncluded": "0", "isLandscapingIncluded": "0", "isCableIncluded": "0", "isInternetIncluded": "0", "isSnowRemovalIncluded": "0", "isPoolServiceIncluded": "0", "heatType": null, "dateTimeCreated": "2026-11-08 08:02:34", "dateTimeModified": "2026-11-08 08:02:34", "dateTimeDeactivated": null, "coolingSystemTypeID": null, "heatingSystemTypeID": null, "defaultApplicationUrl": null }, "unit": { "unitID": "172", "name": "Unit 1A", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "leaseID": null, "latitude": "40.71280000", "longitude": "-74.00600000", "marketRent": "1500.00", "rent": "1500.00", "marketDeposit": "800.00", "deposit": "800.00", "beds": "3", "fullBaths": "2", "halfBaths": "1", "baths": "3", "size": "1200", "propertyManagerID": null }, "property": { "propertyID": "184", "propertyTypeID": "2", "countryID": "US", "address": "123 Main St", "address2": "Apt 4", "city": "Springfield", "stateID": "FL", "postalCode": "12345", "name": "APITEST Maple House", "yearBuilt": "2001", "assignedToUserID": "2", "propertyShowingProviderID": null, "showingProviderID": null }, "propertyGroups": { "names": "APITEST Group" }, "portfolio": { "portfolioID": "209", "name": "Hayes PLC Portfolio", "contacts": null }, "propertyManager": { "propertyManagerID": null, "name": null }, "image": { "propertyImageID": "2", "small": "https://cdn.rentvinedev.com/testypm/properties/184/images/a1b2c3d4e5f6/small.jpg", "large": "https://cdn.rentvinedev.com/testypm/properties/184/images/a1b2c3d4e5f6/large.jpg" } } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### Get Property Image `GET /properties/{propertyID}/images/{imageHash}/{size}.jpeg` Operation ID: `getCdnPropertyImage` Fetches a resized property image directly from the Rentvine CDN. The URL components are provided by the `image.small` and `image.large` fields returned from `GET /properties/listings/search` and similar listing endpoints — no separate lookup is required. This endpoint does **not** use the `/api/manager` base URL and requires no authentication. Images are publicly accessible once you have the CDN URL. ##### Constructing the URL The `image` object in each listing search result contains pre-built absolute URLs: ```json { "image": { "propertyImageID": "1664", "small": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/small.jpeg", "large": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/large.jpeg" } } ``` You can use `image.small` and `image.large` directly without constructing the URL manually. Both values are `null` when no image has been uploaded for the property. ##### Size Variants | `{size}` | Dimensions | Use Case | |----------|-------------|-----------------------------------------------| | `small` | Thumbnail | List views, vacancy boards, map pins | | `large` | Full size | Detail pages, syndication feeds, lightboxes | ##### Listing Photos To retrieve all uploaded photos and media files attached to a specific listing (not just the primary property image), use: - `GET /listings/{propertyListingID}/files` (undocumented) — lists all files (photos, documents) attached to the listing - `GET /listings/files/{id}/preview` (undocumented) — returns a file inline (for browser display) - `GET /listings/files/{id}/download` (undocumented) — downloads a file as an attachment ##### Related Endpoints - `GET /properties/listings/search` - Returns `image.small` and `image.large` for each result - `GET /listings/{propertyListingID}/files` (undocumented) - All uploaded listing photos and media Parameters: - `propertyID` (path, integer, required): The `propertyID` from the listing search result. - `imageHash` (path, string, required): The image hash component from the `image.small` or `image.large` URL (the segment between `/images/` and `/small.jpeg` or `/large.jpeg`). - `size` (path, string, required, one of "small", "large"): `small` for the thumbnail version, `large` for the full-size version. Responses: - `200`: Image returned successfully as JPEG binary data - `image/jpeg`: string, binary - `404`: Image not found — the hash or path is invalid - `application/json`: object - `error` (string) Example: ```json { "error": "Not found" } ``` - `429`: see shared response `error_429` ## Messaging ### Email Conversations #### List Email Conversations `GET /contacts/conversations` Operation ID: `listEmailConversations` Returns a paginated list of email conversations for a specific object (e.g. a lease, property, or contact). Each item includes metadata about the conversation thread and a count of its messages. ##### Use Cases - Display a list of email threads associated with a lease or property in the manager portal - Show inbox-style conversation history for a contact or vendor - Sync email conversations to an external CRM or ticketing system ##### Business Rules - Both `objectTypeID` and `objectID` are required. The request will return `400` if either is missing. - Access is restricted via `verifyAccessToObjectType` — the authenticated account must have access to the given object. - Results are ordered by `dateTimeUpdated` descending (most recently active conversations first). - Default page size is 25. ##### Related Endpoints - `GET /contacts/conversations/{id}` — retrieve a single conversation with its messages - `POST /contacts/conversations` — send a new email message (creates or extends a conversation) Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `objectTypeID` (query, integer, required): The object type the conversations belong to. See the Object Types reference for valid values. Common values: * `3` - Contact * `4` - Lease * `6` - Property * `7` - Unit - `objectID` (query, integer, required): The primary key of the object identified by `objectTypeID`. Responses: - `200`: Successfully retrieved email conversations - `application/json`: object[] - Each item: - `emailConversationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the email conversation. - `objectTypeID` (string, required, pattern `^-?[0-9]+$`): Object type the conversation is associated with. - `objectID` (string, required, pattern `^-?[0-9]+$`): Primary key of the associated object. - `subject` (string | null, required): Subject line of the email conversation thread. - `dateTimeCreated` (string, required, read-only): When the conversation was first created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeUpdated` (string, required, read-only): When the conversation was last updated (e.g. a new message was sent or received). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `emailMessageCount` (integer, required, read-only): Number of email messages within the conversation thread. Example: ```json [ { "emailConversationID": "301", "objectTypeID": "4", "objectID": "1050", "subject": "Lease renewal - Unit 4B", "dateTimeCreated": "2024-08-15 10:30:00", "dateTimeUpdated": "2024-09-02 14:45:00", "emailMessageCount": 5 }, { "emailConversationID": "287", "objectTypeID": "4", "objectID": "1050", "subject": "Move-in inspection follow up", "dateTimeCreated": "2024-07-01 09:00:00", "dateTimeUpdated": "2024-07-03 11:20:00", "emailMessageCount": 2 } ] ``` - `400`: Bad request — objectTypeID and objectID are required - `application/json`: object - `error` (string) Example: ```json { "error": "objectTypeID and objectID are both required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Send Email `POST /contacts/conversations` Operation ID: `sendEmailConversation` Sends an outbound email message, creating a new conversation thread or adding a reply to an existing one. On success, the response is the created or updated conversation record (identical to `GET /contacts/conversations/{id}` without includes). Supply `objectTypeID` + `objectID` to start a new conversation, or `emailConversationID` to reply within an existing thread. ##### Use Cases - Send a move-in welcome email to all tenants on a lease - Reply to an existing email thread with additional documentation - Send a templated email to an owner using an email template ##### Business Rules - Requires the `Contacts: Send Messages` permission. - At least one entry in `recipients` is required. Addresses matching the system mail domain or `noreply` are silently filtered out. - When creating a new conversation, both `objectTypeID` and `objectID` are required. Omitting either returns a `400`. - `emailTemplateID` (in the `email` object) causes the system to look up the template and populate `templateObjectTypeID` automatically. - `copySender: "1"` sends a copy of the email to the authenticated user. - File IDs supplied in `attachments` must already exist in the system. ##### Related Endpoints - `GET /contacts/conversations` — list conversations for an object - `GET /contacts/conversations/{id}` — retrieve a conversation with its message history Request body, required: - `application/json`: object - `recipients` (string, email[], required): Primary To recipients — array of email address strings. - `additionalRecipients` (string, email[]): Additional To recipients to include alongside `recipients`. - `bcc` (string, email[]): BCC recipients — array of email address strings. - `message` (string, required): HTML body of the email. - `subject` (string, required, max length 300): Email subject line. Required when creating a new conversation. - `email` (object): Email template options. `emailTemplateID` causes the system to resolve `templateObjectTypeID` automatically. - `message` (string): Optional override message for the template wrapper. - `emailTemplateID` (string | integer, pattern `^-?[0-9]+$`): ID of the email template to apply when rendering the email. - `attachments` (integer[]): Array of `fileID` integers for files to attach to the email. - `copySender` (string | integer, one of "0", "1", 0, 1): Pass `"1"` to send a copy of the email to the authenticated manager user. - `inputs` (object): Optional key/value pairs passed to template rendering. - `templateObjectTypeID` (string | integer, pattern `^-?[0-9]+$`): Template object type used when rendering template variables in the email body. - `objectTypeID` (string | integer, required, pattern `^-?[0-9]+$`): Object type the conversation belongs to. Required when creating a new conversation. Common values: * `3` - Contact * `4` - Lease * `6` - Property * `7` - Unit - `objectID` (string | integer, required, pattern `^-?[0-9]+$`): Primary key of the object identified by `objectTypeID`. Required when creating a new conversation. - `emailConversationID` (string | integer, pattern `^-?[0-9]+$`): Supply to reply within an existing conversation thread. If omitted, a new conversation is created. Example: ```json { "additionalRecipients": [ "test@gmail.com" ], "bcc": [ "test@gmail.com" ], "message": "

Hi Tenants,

Mackenzie Walker

We are excited to welcome you as new tenants!

", "subject": "Your Florida Lease Template", "email": { "message": "", "emailTemplateID": "8" }, "attachments": [], "copySender": "1", "inputs": {}, "recipients": [ "mackenzie.walker@rentvine.com", "adriano@rentvine.com" ], "templateObjectTypeID": 2, "objectTypeID": 4, "objectID": "2982" } ``` Responses: - `200`: Email sent successfully. Response is the email conversation record (identical to `GET /contacts/conversations/{id}` without includes). - `application/json`: object - `emailConversation` (object, required) - `emailConversationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the email conversation. - `templateObjectTypeID` (string | null, pattern `^-?[0-9]+$`): Template object type if the conversation was created from a template. - `objectTypeID` (string, required, pattern `^-?[0-9]+$`): Object type the conversation is associated with. - `objectID` (string, required, pattern `^-?[0-9]+$`): Primary key of the associated object. - `subject` (string | null, required, max length 300): Subject line of the email conversation. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeUpdated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json { "emailConversation": { "emailConversationID": "301", "templateObjectTypeID": "2", "objectTypeID": "4", "objectID": "2982", "subject": "Your Florida Lease Template", "dateTimeCreated": "2024-10-22 14:00:00", "dateTimeUpdated": "2024-10-22 14:00:00" } } ``` - `400`: Bad request — validation failure or missing required fields - `application/json`: object - `error` (string) Example: ```json { "error": "objectTypeID and objectID are both required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Email Conversation `GET /contacts/conversations/{id}` Operation ID: `getEmailConversation` Retrieves a single email conversation by its ID. When the `messages` include is requested, the response also contains the full message history, all recipients, and any file attachments on each message. ##### Use Cases - Render a full email thread view in the manager portal for a lease or property - Export a conversation with attachments for compliance or record-keeping - Load recipient list and message history before composing a reply ##### Business Rules - Returns `400` if the conversation is not found. - Access is restricted via `verifyAccessToObjectType` using the conversation's `objectTypeID` and `objectID` — the authenticated account must have access to the associated object. - Without the `messages` include, only the base conversation record is returned. - With `messages`, all email messages in the thread are returned in descending order (most recent first). Each message includes an `isPrimary` flag (`true` for the first/latest message). ##### Available Includes (1) - `messages` — full message history with sender recipient details and file attachments per message. Also adds `recipients` (all conversation participants) to the response. ##### Related Endpoints - `GET /contacts/conversations` — list all conversations for an object - `POST /contacts/conversations` — send a new email message / create a conversation Parameters: - `id` (path, integer, required): The unique identifier of the email conversation (`emailConversationID`). - `includes` (query, string): Comma-separated list of related data to include in the response. Available values: `messages` Responses: - `200`: Successfully retrieved email conversation - `application/json`: object - `emailConversation` (object, required) - `emailConversationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the email conversation. - `templateObjectTypeID` (string | null, pattern `^-?[0-9]+$`): Template object type used when the conversation was created from a template. - `objectTypeID` (string, required, pattern `^-?[0-9]+$`): Object type the conversation is associated with. - `objectID` (string, required, pattern `^-?[0-9]+$`): Primary key of the associated object. - `subject` (string | null, required, max length 300): Subject line of the email conversation thread. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeUpdated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `recipients` (object[]): All participants in this conversation (if includes=messages). - `emailConversationRecipientID` (string, required, read-only, pattern `^-?[0-9]+$`) - `emailConversationID` (string, required, pattern `^-?[0-9]+$`) - `recipientTypeID` (string | null, pattern `^-?[0-9]+$`): Type of recipient (e.g. To, CC, BCC). - `recipient` (string, email, required): Email address of the recipient. - `name` (string | null): Display name of the recipient. - `isDeleted` (string, one of "0", "1"): Whether the recipient has been removed from the conversation (0 or 1). - `messages` (object[]): Full message history (if includes=messages), ordered most recent first. - `message` (object, required) - `emailMessageID` (string, required, read-only, pattern `^-?[0-9]+$`) - `repliedToEmailMessageID` (integer | null): ID of the message this is a reply to, if any. - `isInbound` (string, required, one of "0", "1"): Whether the message was received (1) or sent (0) by the manager. - `isSent` (string, required, one of "0", "1"): Whether the message has been sent (1) or is still queued (0). - `fromEmailConversationRecipientID` (string | null, pattern `^-?[0-9]+$`): Recipient ID of the sender. - `from` (string, email, required): Sender email address. - `to` (string | null): Comma-separated To recipients. - `cc` (string | null): Comma-separated CC recipients. - `bcc` (string | null): Comma-separated BCC recipients. - `subject` (string | null, required) - `sentByUserID` (string | null, pattern `^-?[0-9]+$`): ID of the user who sent the message (if sent by a manager). - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isPrimary` (boolean, required): True for the most recent (first returned) message in the thread. - `html` (string | null): HTML body of the email message. - `fromRecipient` (object, required): Recipient record for the message sender. - `emailConversationRecipientID` (string, pattern `^-?[0-9]+$`) - `emailConversationID` (string, pattern `^-?[0-9]+$`) - `recipientTypeID` (string | null, pattern `^-?[0-9]+$`) - `recipient` (string, email) - `name` (string | null) - `isDeleted` (string, one of "0", "1") - `attachments` (object[] | null, required): File attachments on this specific message. - `fileAttachment` (object) - `fileAttachmentID` (string, pattern `^-?[0-9]+$`) - `fileID` (string, pattern `^-?[0-9]+$`) - `objectTypeID` (string, pattern `^-?[0-9]+$`) - `objectID` (string, pattern `^-?[0-9]+$`) Example: ```json { "emailConversation": { "emailConversationID": "301", "templateObjectTypeID": null, "objectTypeID": "4", "objectID": "1050", "subject": "Lease renewal - Unit 4B", "dateTimeCreated": "2024-08-15 10:30:00", "dateTimeUpdated": "2024-09-02 14:45:00" } } ``` - `400`: Bad request — conversation not found - `application/json`: object - `error` (string) Example: ```json { "error": "Email Conversation Not Found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Chat Messages #### List Chat Messages `GET /chat/messages` Operation ID: `listChatMessages` Returns a paginated list of chat messages. Messages are returned in descending order (most recent first) and are automatically marked as read by the manager role upon retrieval. Chat messages are associated with a specific object via `chatObjectTypeID` and `objectID`. The `chatObjectTypeID` identifies the type of object the chat thread belongs to (e.g. a Work Order, Lease, Portfolio, or Vendor). ##### Use Cases - Render the chat thread for a specific lease or work order in the manager portal - List all recent messages across a portfolio for an owner communication view - Filter messages shared with a specific party (tenant, vendor, owner) for audit or compliance purposes ##### Business Rules - For accounts with access restrictions, both `chatObjectTypeID` and `objectID` are required. Restricted accounts that omit these will receive a `400` error. - Unrestricted accounts may omit `chatObjectTypeID` and `objectID` to retrieve messages across all objects. - Messages are marked as read by the manager role automatically upon retrieval. - Default page size is 20. - `search` performs a full-text match against the message body. - Each result row is structured as a flat dot-notation object with `message.*`, `user.*`, and `contact.*` keys. ##### chatObjectTypeID Values * `1` - Work Order * `2` - Lease * `3` - Portfolio * `4` - Vendor * `5` - Applicant ##### Related Endpoints - `GET /chat/messages/{id}` — retrieve a single message with file attachments - `POST /chat/messages` — create a new chat message - `GET /chat/messages/stats` — get unread message count for a specific object Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 20): Number of results per page. Defaults to 20. - `chatObjectTypeID` (query, integer, one of 1, 2, 3, 4, 5): The chat object type identifying what kind of object the chat thread belongs to. Required for restricted accounts. * `1` - Work Order * `2` - Lease * `3` - Portfolio * `4` - Vendor * `5` - Applicant - `objectID` (query, integer): Primary key of the object identified by `chatObjectTypeID`. Required for restricted accounts. - `search` (query, string): Full-text search against the message body. - `isSharedWithTenant` (query, integer, one of 0, 1): Filter by whether messages are shared with the tenant. Pass `1` for shared, `0` for not shared. - `isSharedWithCosigner` (query, integer, one of 0, 1): Filter by whether messages are shared with the cosigner. - `isSharedWithVendor` (query, integer, one of 0, 1): Filter by whether messages are shared with the vendor. - `isSharedWithOwner` (query, integer, one of 0, 1): Filter by whether messages are shared with the owner. Responses: - `200`: Successfully retrieved chat messages - `application/json`: object[] - Each item: - `message.messageID` (integer, required, read-only): Unique identifier of the chat message. - `message.chatObjectTypeID` (integer, required): Chat object type identifier (1=Work Order, 2=Lease, 3=Portfolio, 4=Vendor, 5=Applicant). - `message.objectID` (integer, required): Primary key of the associated object. - `message.roleTypeID` (integer, required): Role type of the message sender (1=Manager, 2=Tenant, etc.). - `message.userID` (integer | null): ID of the user who sent the message (manager-originated messages). - `message.contactID` (integer | null): ID of the contact who sent the message (tenant/vendor/owner-originated messages). - `message.message` (string, required): Text body of the chat message. - `message.messageLinkPreviewMeta` (object | null): Parsed JSON metadata for a URL link preview embedded in the message, if any. - `message.isSharedWithTenant` (integer): Whether the message is visible to the tenant (0 or 1). - `message.isSharedWithCosigner` (integer): Whether the message is visible to the cosigner (0 or 1). - `message.isSharedWithVendor` (integer): Whether the message is visible to the vendor (0 or 1). - `message.isSharedWithOwner` (integer): Whether the message is visible to the owner (0 or 1). - `message.isReadByManager` (integer): Whether the message has been read by the manager (0 or 1). - `message.isReadByTenant` (integer): Whether the message has been read by the tenant (0 or 1). - `message.isReadByVendor` (integer): Whether the message has been read by the vendor (0 or 1). - `message.isReadByOwner` (integer): Whether the message has been read by the owner (0 or 1). - `message.isRead` (integer): Whether the message has been read by the requesting role (derived). Always `1` for manager after this endpoint is called (messages are marked read on retrieval). - `message.dateTimeCreated` (string, date-time, required, read-only): When the message was created. - `message.fileAttachments` (object[]): File attachments on the message. - `fileAttachmentID` (integer) - `fileID` (integer) - `title` (string) - `fileName` (string) - `fileType` (string) - `previewFileName` (string | null) - `user.userID` (integer | null): User ID of the sender (populated for manager-originated messages). - `user.firstName` (string | null): First name of the sending user. - `user.lastName` (string | null): Last name of the sending user. - `user.email` (string | null, email): Email address of the sending user. - `contact.contactID` (integer | null): Contact ID of the sender (populated for tenant/vendor/owner-originated messages). - `contact.contactTypeID` (integer | null): Type of the sending contact. - `contact.name` (string | null): Display name of the sending contact. Example: ```json [ { "message.messageID": 4201, "message.chatObjectTypeID": 2, "message.objectID": 1050, "message.roleTypeID": 1, "message.userID": 42, "message.contactID": null, "message.message": "Lease renewal documents have been sent to your email.", "message.messageLinkPreviewMeta": null, "message.isSharedWithTenant": 1, "message.isSharedWithCosigner": 0, "message.isSharedWithVendor": 0, "message.isSharedWithOwner": 0, "message.isReadByManager": 1, "message.isReadByTenant": 0, "message.isReadByVendor": 0, "message.isReadByOwner": 0, "message.isRead": 1, "message.dateTimeCreated": "2024-09-02T14:45:00Z", "message.fileAttachments": [], "user.userID": 42, "user.firstName": "Alex", "user.lastName": "Johnson", "user.email": "alex.johnson@123pm.com", "contact.contactID": null, "contact.contactTypeID": null, "contact.name": null }, { "message.messageID": 4185, "message.chatObjectTypeID": 2, "message.objectID": 1050, "message.roleTypeID": 2, "message.userID": null, "message.contactID": 620, "message.message": "Hi, I would like to renew for another 12 months.", "message.messageLinkPreviewMeta": null, "message.isSharedWithTenant": 1, "message.isSharedWithCosigner": 0, "message.isSharedWithVendor": 0, "message.isSharedWithOwner": 0, "message.isReadByManager": 1, "message.isReadByTenant": 1, "message.isReadByVendor": 0, "message.isReadByOwner": 0, "message.isRead": 1, "message.dateTimeCreated": "2024-09-01T09:10:00Z", "message.fileAttachments": [ { "fileAttachmentID": 550, "fileID": 320, "title": "Signed Lease Draft.pdf", "fileName": "signed_lease_draft.pdf", "fileType": "application/pdf", "previewFileName": null } ], "user.userID": null, "user.firstName": null, "user.lastName": null, "user.email": null, "contact.contactID": 620, "contact.contactTypeID": 2, "contact.name": "Jane Smith" } ] ``` - `400`: Bad request — chatObjectTypeID and objectID required for restricted accounts - `application/json`: object - `error` (string) Example: ```json { "error": "ChatObjectTypeID and ObjectID are required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Chat Message `POST /chat/messages` Operation ID: `createChatMessage` Creates a new chat message on a specific object (lease, work order, portfolio, vendor, or applicant). On success, the response is identical to `GET /chat/messages/{id}` — the full message record with file attachments. ##### Use Cases - Post a manager note on a lease that the tenant can see in the resident portal - Send an internal-only note on a work order - Attach a file to a chat thread for a vendor ##### Business Rules - `roleTypeID` is always set to Manager (1) server-side and cannot be overridden by the client. - The authenticated account must have access to the object identified by `chatObjectTypeID` and `objectID`. - `attachments` is an array of `fileID` integers referencing files that already exist in the system. - Sharing flags (`isSharedWithTenant`, `isSharedWithVendor`, `isSharedWithOwner`, `isSharedWithCosigner`) default to `0` if omitted. ##### Related Endpoints - `GET /chat/messages` — list messages for an object - `GET /chat/messages/{id}` — retrieve a single message Request body, required: - `application/json`: object - `chatObjectTypeID` (string | integer, required, one of "1", "2", "3", "4", "5", 1, 2, 3, 4, 5): The chat object type identifying what kind of object the message belongs to. * `1` - Work Order * `2` - Lease * `3` - Portfolio * `4` - Vendor * `5` - Applicant - `objectID` (string | integer, required, pattern `^-?[0-9]+$`): Primary key of the object identified by `chatObjectTypeID`. - `message` (string, required): HTML body of the chat message. - `isSharedWithTenant` (string | integer, one of "0", "1", 0, 1, default "0"): Whether the message is visible to the tenant (0 or 1). - `isSharedWithVendor` (string | integer, one of "0", "1", 0, 1, default "0"): Whether the message is visible to the vendor (0 or 1). - `isSharedWithOwner` (string | integer, one of "0", "1", 0, 1, default "0"): Whether the message is visible to the owner (0 or 1). - `isSharedWithCosigner` (string | integer, one of "0", "1", 0, 1, default "0"): Whether the message is visible to the cosigner (0 or 1). - `attachments` (integer[]): Array of `fileID` integers for files to attach to the message. Example: ```json { "attachments": [], "message": "

test

", "chatObjectTypeID": 2, "objectID": 2982, "isSharedWithTenant": "1", "isSharedWithCosigner": "1" } ``` Responses: - `200`: Chat message created successfully. Response is identical to `GET /chat/messages/{id}`. - `application/json`: object - `message` (object, required) - `messageID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the created chat message. - `chatObjectTypeID` (string, required, pattern `^-?[0-9]+$`): Chat object type identifier. - `objectID` (string, required, pattern `^-?[0-9]+$`): Primary key of the associated object. - `roleTypeID` (string, required, pattern `^-?[0-9]+$`): Role type of the sender (always 1 for Manager). - `userID` (string | null, pattern `^-?[0-9]+$`): ID of the manager user who sent the message. - `contactID` (string | null, pattern `^-?[0-9]+$`): Always null for manager-created messages. - `shortUrlID` (string | null, pattern `^-?[0-9]+$`): ID of the short URL generated for this message, if any. - `message` (string, required): HTML body of the chat message. - `messageLinkPreviewMeta` (object | null): Parsed JSON metadata for a URL link preview embedded in the message, if any. - `isSharedWithTenant` (string, one of "0", "1"): Whether the message is visible to the tenant (0 or 1). - `isSharedWithCosigner` (string, one of "0", "1"): Whether the message is visible to the cosigner (0 or 1). - `isSharedWithVendor` (string, one of "0", "1"): Whether the message is visible to the vendor (0 or 1). - `isSharedWithOwner` (string, one of "0", "1"): Whether the message is visible to the owner (0 or 1). - `isSharedWithApplicant` (string, one of "0", "1"): Whether the message is visible to the applicant (0 or 1). - `isReadByManager` (string, one of "0", "1"): Whether the message has been read by the manager (0 or 1). - `isReadByTenant` (string, one of "0", "1"): Whether the message has been read by the tenant (0 or 1). - `isReadByCosigner` (string, one of "0", "1"): Whether the message has been read by the cosigner (0 or 1). - `isReadByVendor` (string, one of "0", "1"): Whether the message has been read by the vendor (0 or 1). - `isReadByOwner` (string, one of "0", "1"): Whether the message has been read by the owner (0 or 1). - `isReadByApplicant` (string, one of "0", "1"): Whether the message has been read by the applicant (0 or 1). - `dateTimeCreated` (string, required, read-only): When the message was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `fileAttachments` (object[], required): File attachments on the created message (empty if none were supplied). - `fileAttachmentID` (string, pattern `^-?[0-9]+$`) - `fileID` (string, pattern `^-?[0-9]+$`) - `title` (string) - `fileName` (string) - `fileType` (string) - `previewFileName` (string | null) Example: ```json { "message": { "messageID": "1026", "chatObjectTypeID": "2", "objectID": "2982", "roleTypeID": "1", "userID": "501195", "contactID": null, "shortUrlID": "808166", "message": "

test

", "messageLinkPreviewMeta": null, "isSharedWithTenant": "1", "isSharedWithCosigner": "0", "isSharedWithVendor": "0", "isSharedWithOwner": "0", "isSharedWithApplicant": "0", "isReadByManager": "1", "isReadByTenant": "0", "isReadByCosigner": "0", "isReadByVendor": "0", "isReadByOwner": "0", "isReadByApplicant": "0", "dateTimeCreated": "2026-04-27 12:50:14" }, "fileAttachments": [] } ``` - `400`: Bad request — validation failure or access denied - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ### Text Messages #### Send Text Message `POST /messages/texts/send` Operation ID: `sendTextMessage` Sends an outbound SMS text message to a phone number. On success, the response returns the created text message record (identical to `GET /messages/texts/{id}`). ##### Use Cases - Send a reminder text to a tenant about an upcoming payment - Notify a vendor of a new work order via SMS - Send a quick update to a contact from the manager portal ##### Business Rules - Requires the `Contacts: Send Messages` permission. - `to` must be a valid phone number in E.164 format (e.g. `+14436420607`). - `attachments` is an optional array of `fileID` integers referencing files that already exist in the system (MMS attachments). - `contactID` is accepted in the payload but is not stored on the text message record — it is used for UI context only. ##### Related Endpoints - `GET /messages/texts/phone/{phoneNumber}` — list the full thread for a phone number - `GET /messages/texts/{id}` — retrieve a single text message Request body, required: - `application/json`: object - `to` (string, required): Recipient phone number in E.164 format. - `message` (string, required): Text body of the SMS message. - `attachments` (integer[]): Optional array of `fileID` integers for MMS file attachments. - `contactID` (string | integer, pattern `^-?[0-9]+$`): Optional contact ID for UI context. Not stored on the text message record. Example: ```json { "contactID": "3816", "to": "+14436420607", "message": "test" } ``` Responses: - `200`: Text message sent successfully. Response is identical to `GET /messages/texts/{id}`. - `application/json`: object - `textMessage` (object, required) - `textMessageID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the sent text message. - `isInbound` (string, required, one of "0", "1"): Always `0` for outbound messages created via this endpoint. - `from` (string, required): Sender phone number in E.164 format (the account's outbound number). - `to` (string, required): Recipient phone number in E.164 format. - `message` (string | null, required): Text body of the message. - `fileAttachments` (string | null): JSON-encoded MMS attachment metadata, if any were sent. - `sentByUserID` (string | null, pattern `^-?[0-9]+$`): ID of the manager user who sent the message. - `dateTimeSent` (string, required, read-only): When the message was sent. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json { "textMessage": { "textMessageID": "914", "isInbound": "0", "from": "+12393606531", "to": "+14436420607", "message": "\"test\"", "fileAttachments": null, "sentByUserID": "501195", "dateTimeSent": "2026-04-27 12:54:12" } } ``` - `400`: Bad request — validation failure - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Text Messages by Phone `GET /messages/texts/phone/{phoneNumber}` Operation ID: `listTextMessagesByPhone` Returns a paginated list of text messages (both inbound and outbound) for a given phone number. Messages are ordered by `dateTimeSent` descending (most recent first). The `phoneNumber` path parameter should contain only the digits of the phone number including country code (e.g. `14436420607` for `+1 443-642-0607`). The system automatically prepends `+` before querying. ##### Use Cases - Display a full SMS conversation thread with a tenant or vendor - Retrieve message history for a specific phone number for audit or compliance - Load messages before a known message ID for infinite-scroll pagination (use `load` endpoint instead) ##### Business Rules - `phoneNumber` must be provided as digits only (no `+`, dashes, or spaces). - Both inbound and outbound messages for the phone number are returned. - Default page size is 15. ##### Related Endpoints - `POST /messages/texts/send` — send a new text message - `GET /messages/texts/{id}` — retrieve a single text message Parameters: - `phoneNumber` (path, integer, required): Phone number digits including country code, without `+` prefix (e.g. `14436420607`). - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 15): Number of results per page. Defaults to 15. - `search` (query, string): Filter results to messages whose body contains this string. Responses: - `200`: Successfully retrieved text messages for the phone number - `application/json`: object[] - Each item: - `textMessageID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the text message. - `isInbound` (string, required, one of "0", "1"): Whether the message was received (1) or sent (0) by the manager. - `from` (string, required): Sender phone number in E.164 format. - `to` (string, required): Recipient phone number in E.164 format. - `message` (string | null, required): Text body of the message. - `fileAttachments` (string | null): JSON-encoded array of file attachment metadata stored with the message, if any. - `sentByUserID` (string | null, pattern `^-?[0-9]+$`): ID of the manager user who sent the message (null for inbound messages). - `dateTimeSent` (string, required, read-only): When the message was sent or received. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Example: ```json [ { "textMessageID": "8801", "isInbound": "0", "from": "+19995550100", "to": "+14436420607", "message": "test", "fileAttachments": null, "sentByUserID": "42", "dateTimeSent": "2024-10-22 14:00:00" }, { "textMessageID": "8798", "isInbound": "1", "from": "+14436420607", "to": "+19995550100", "message": "Got it, thanks!", "fileAttachments": null, "sentByUserID": null, "dateTimeSent": "2024-10-22 13:55:00" } ] ``` - `400`: Bad request — phone number query failed - `application/json`: object - `error` (string) Example: ```json { "error": "Must provider a phoneNumber to run this query" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ## Screening ### Screening #### Get Screening Settings `GET /screening/settings` Operation ID: `getScreeningSettings` Returns the screening and application settings configured for the account. This includes whether online applications are enabled, which application template is used by default, and automation preferences. ##### Use Cases - Determine whether the application portal is active before directing prospects to apply - Check which generic application template is assigned for use in portals that do not have a property-specific template - Inspect automation flags to understand when confirmation emails and auto-assignment are triggered ##### Business Rules - Returns a single settings object scoped to the authenticated account — there is no pagination. - `isApplicationEnabled` controls whether the resident-facing application portal is accessible. - `isGenericApplicationEnabled` controls whether a generic (non-property-specific) application link is active. - `isAvailableUnitsOnly` restricts the application portal to units that are marked as available. - `autoAssignApplicationFromProperty` causes incoming applications to automatically inherit the assigned manager from the property. - `autoSendProspectConfirmationEmail` sends a confirmation email to the applicant upon submission. ##### Related Endpoints - `GET /screening/applications` — list submitted applications - `GET /screening/applications/{applicationID}` — retrieve a single application Responses: - `200`: Successfully retrieved screening settings - `application/json`: object - `screeningSettingID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the screening settings record. - `applicationProviderID` (string, required, pattern `^-?[0-9]+$`): ID of the third-party screening provider integrated with this account. - `isApplicationEnabled` (string, required, one of "0", "1"): Whether the resident-facing application portal is enabled. `1` = enabled, `0` = disabled. - `applicationUrl` (string | null): Custom application URL override. Empty string if not set. - `isGenericApplicationEnabled` (string, required, one of "0", "1"): Whether a generic (non-property-specific) application link is active. `1` = enabled, `0` = disabled. - `genericApplicationTemplateID` (string | null, pattern `^-?[0-9]+$`): ID of the application template used for generic (non-property-specific) applications. - `isAvailableUnitsOnly` (string, required, one of "0", "1"): Restricts the application portal to units marked as available. `1` = available units only, `0` = all units. - `autoAssignApplicationFromProperty` (string, required, one of "0", "1"): Automatically assigns the property's manager to incoming applications. `1` = enabled, `0` = disabled. - `autoSendProspectConfirmationEmail` (string, required, one of "0", "1"): Sends a confirmation email to applicants upon submission. `1` = enabled, `0` = disabled. - `genericApplicationTemplateName` (string | null): Display name of the generic application template. Example: ```json { "screeningSettingID": "1", "applicationProviderID": "1", "isApplicationEnabled": "1", "applicationUrl": "", "isGenericApplicationEnabled": "1", "genericApplicationTemplateID": "2", "isAvailableUnitsOnly": "1", "autoAssignApplicationFromProperty": "1", "autoSendProspectConfirmationEmail": "1", "genericApplicationTemplateName": "Commercial Application" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### List Application Templates `GET /screening/templates` Operation ID: `listScreeningTemplates` Lists the account's application templates, active and inactive, sorted by ID, one page at a time. Each item wraps the template under `template`, beside a `token` the list adds. A template's `templateID` is what `POST /screening/applications` takes. ##### Use Cases - Find the template to create an application with - Show which templates are active and which is the default ##### Business Rules - Requires only authentication; no permission is checked. - `search` matches any part of the template's name, in any case. Its `&`, `<`, `>`, `'` and `"` are HTML-escaped first, so a search holding one of them matches no name that has it. Without `search` every template is listed. - Inactive templates are listed too; `isActive` tells them apart. - Sorted by `templateID`, oldest first. ##### Related Endpoints - `POST /screening/applications` - create an application from a template Parameters: - `search` (query, string): Part of the template's name, matched anywhere in it and in any case. - `page` (query, integer, default 1, minimum 1): Page number, from 1 (default 1). - `pageSize` (query, integer, default 15, minimum 1): Items per page, from 1 (default 15). Values above 5000 are served at 5000. Responses: - `200`: One page of application templates - `application/json`: object[] - Each item: - `template` (`included_template`, required) - `token` (string, required, pattern `^[0-9]+$`): The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the template. Example: ```json [ { "template": { "templateID": "1", "name": "Contract check Standard Template", "isActive": "1", "applicationFeeAmount": "50.00", "processingFeeTypeID": "2", "isLockRentAmount": "1", "isLockDepositAmount": "1", "isShowPendingApplicationMessage": "1", "pendingApplicationMessage": "We review applications within two business days.", "dateTimeCreated": "2026-11-14 02:45:13", "isDefault": "1", "addendumTemplateID": "3" }, "token": "1794624313" } ] ``` - `401`: see shared response `error_401` - `429`: see shared response `error_429` #### List Applications `GET /screening/applications` Operation ID: `listScreeningApplications` Returns a paginated list of rental applications submitted to the account. Each item includes the application record, current status, associated unit and property details, and linked lease information when a lease has been created. ##### Use Cases - Display a queue of pending applications for review - Filter applications by status or unit to find relevant submissions - Sync application data with an external leasing workflow ##### Business Rules - Results are scoped to the portfolios accessible to the authenticated account. - Default page size is 25. Use `page` and `pageSize` to paginate through results. - Applications are returned in descending order by `applicationID` (most recent first). - The `lease` object will have null values when no lease has been created from the application yet. ##### Related Endpoints - `GET /screening/applications/{applicationID}` — retrieve a single application's details - `GET /screening/applications/{applicationID}/summary` — retrieve a full summary with applicant data - `POST /screening/applications/{applicationID}/status` — update an application's status Parameters: - `page` (query, integer, default 1): The page number for pagination - `pageSize` (query, integer, default 25): Number of items per page - `search` (query, string): Search against applicant names, address, or application number. - `applicationStatusID` (query, integer): Filter by application status ID. - `unitID` (query, integer): Filter applications by a specific unit ID. Responses: - `200`: Successfully retrieved applications - `application/json`: object[] - Each item: - `application` (object, required) - `applicationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the application. - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`): User ID of the manager assigned to review this application. - `number` (string, required, pattern `^-?[0-9]+$`): Human-readable application reference number. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): ID of the unit the applicant is applying for. - `countryID` (string | null, required): Two-letter country code for the unit address. - `address` (string | null, required): Street address of the unit being applied for. - `address2` (string | null): Secondary address line (unit/apt number). - `city` (string | null, required) - `stateID` (string | null, required): Two-letter state/province code. - `postalCode` (string | null, required) - `applicants` (string, required): Comma-separated list of applicant names. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `status` (object, required) - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the current application status (may be a custom sub-status). - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the primary (system-level) status. - `isSystemStatus` (string, required, one of "0", "1"): Whether this is a built-in system status (`1`) or a custom status (`0`). - `name` (string, required): Display name of the status. - `unit` (object, required) - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `property` (object, required) - `propertyID` (string, pattern `^-?[0-9]+$`) - `name` (string | null) - `address` (string) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `portfolioID` (string, pattern `^-?[0-9]+$`) - `lease` (object, required) - `leaseID` (string | null, pattern `^-?[0-9]+$`): ID of the lease created from this application, if any. - `startDate` (string | null, date) - `endDate` (string | null, date) - `tenants` (string[] | null): Names of tenants on the created lease. Example: ```json [ { "application": { "applicationID": "1702", "assignedToUserID": null, "number": "101653", "unitID": "709", "countryID": "US", "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "applicants": "Walter DeVeas", "dateTimeCreated": "2026-04-20 13:59:38", "dateTimeModified": "2026-04-25 19:07:46" }, "status": { "applicationStatusID": "6", "primaryApplicationStatusID": "6", "isSystemStatus": "1", "name": "Approved" }, "unit": { "propertyID": "730", "name": null, "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928" }, "property": { "propertyID": "730", "name": null, "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "portfolioID": "450" }, "lease": { "leaseID": "2997", "startDate": "2026-04-20", "endDate": "2027-04-30", "tenants": [ "Walter William DeVeas" ] } }, { "application": { "applicationID": "1701", "assignedToUserID": null, "number": "101652", "unitID": "624", "countryID": "US", "address": "10201 Arcos Avenue", "address2": null, "city": "Estero", "stateID": "FL", "postalCode": "33928", "applicants": "Jane Smith", "dateTimeCreated": "2026-04-20 13:37:52", "dateTimeModified": "2026-04-20 13:37:52" }, "status": { "applicationStatusID": "2", "primaryApplicationStatusID": "2", "isSystemStatus": "1", "name": "Submitted" }, "unit": { "propertyID": "649", "name": null, "address": "10201 Arcos Avenue", "address2": null, "city": "Estero", "stateID": "FL", "postalCode": "33928" }, "property": { "propertyID": "649", "name": null, "address": "10201 Arcos Avenue", "address2": null, "city": "Estero", "stateID": "FL", "postalCode": "33928", "portfolioID": "377" }, "lease": { "leaseID": null, "startDate": null, "endDate": null, "tenants": [] } } ] ``` - `400`: see shared response `error_400` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Application `POST /screening/applications` Operation ID: `createScreeningApplication` Creates a rental application on behalf of an applicant, from one of the account's application templates, as the manager app's "Add Application" does. It creates the application, the applicant on it and the applicant's contact, and **returns the applicant, not the application**: the new application's ID is the applicant's `applicationID`. ##### Use Cases - Enter a paper or emailed application into Rentvine - Create an application from another leasing system's applicant data ##### Business Rules - Requires the **Modify Applications** permission (`Screening` › `ModifyApplications`), checked before anything else: a key without it gets the 403 whatever the body or ID. - `templateID` names the template, from `GET /screening/templates`. An inactive template is accepted too. Its sections decide which parts of `application` are read; `GET /screening/templates/{templateID}/submission` (undocumented) lists the sections a template has on, each by its key in `application`, with their fields and labels. - The body is checked in this order, answering 400 at the first stage that fails: 1. an empty body or `{}` (`invalid input.`); 2. a missing `templateID` (`TemplateID is required`), then a `templateID` with no template (`Application Template not found`); 3. every field of `application` at once, the messages nested by section and field as the body is (a list section's under `items`, by position); 4. a `unitID` with no unit (`Failed to find unit with unitID {unitID}`); 5. the applicant, application and contact records' own checks (a text longer than its column, an animal-photo file that doesn't exist), the messages keyed `applicant.`, `application.`, `contact.` or `animalPhotos.fileID`. - Only the fields marked required in `application` are required, in the sections the template has on: a manager doesn't have to meet the template's own "required" choices or minimum item counts, except on a dropdown field: a dropdown the template marks required and the body leaves out answers 400 `:field not valid for the defined list` (the message as sent). A field the template turned off isn't checked, but its value is still saved. - A message names the field by the template's label for it, which a template can rename. - With a `unitID`, the application is for that unit and the address applied for is the unit's. The `application.applyingFor` address fields are still required, and are then not used. - Without a `unitID`, the application is for the address sent under `application.applyingFor`. - With a key limited to some portfolio groups, send a `unitID` from a property in those portfolios. - No application fee is charged, whatever the template's fee. - This API has no operation that deletes the application, the applicant or the contact the create makes. - Values the response takes from `unitID` and `application` keep the JSON type they were sent in (a `rent` sent as `1650` comes back as `1650`, not `"1650.00"`). Top-level dates come back as `YYYY-MM-DD` whichever accepted form was sent; dates inside a list section (an occupant's `birthDate`) come back as sent. Read the application back with `GET /screening/applications/{applicationID}` for the stored values. - An `application` that isn't an object, an array where a required field expects text, or a question or term whose `variableFieldID` is missing or isn't any template's fails with an empty 500. ##### Side Effects - Creates the application and the applicant, and the applicant's contact from their name, email and the valid phone numbers sent. - Stores the Social Security or taxpayer number encrypted; the response gives only its last four digits. - Attaches each file in an animal's `photos` (`{"fileID": …}` entries) to the applicant as an animal photo. - Writes an "Application Created" log entry and a "created" activity on the application. - Raises application-created and applicant-created events, which send the account's webhooks for them. - Records an "application submitted" analytics event. ##### Related Endpoints - `GET /screening/templates` - the templates, for `templateID` - `GET /screening/applications/{applicationID}` - the application created - `GET /properties/{propertyID}/units` - the units of a property, for `unitID` Request body, required: - `application/json`: object - `templateID` (string | integer, required, pattern `^[0-9]+$`): The application template, from `GET /screening/templates`. - `unitID` (string | integer | null, pattern `^[0-9]+$`): The unit applied for, from `GET /properties/{propertyID}/units`. Leave it out (or null) for an application to the address under `application.applyingFor`. - `application` (`application_submission`, required) Example: ```json { "templateID": "16", "unitID": "47", "application": { "applyingFor": { "address": "123 Test St", "city": "Estero", "stateID": "FL", "postalCode": "33928", "countryID": "US" }, "leaseInfo": { "rent": "1650.00", "deposit": "1650.00", "moveInDate": "2026-12-01", "leaseMonths": "12" }, "personalInfo": { "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com", "cellPhone": "+12395551234", "birthDate": "1990-01-15", "ssn": "123456789", "middleName": "Marie", "homePhone": "+12395550100", "workPhone": "+12395550101" }, "currentAddress": { "primaryAddress": "456 Applicant St", "primaryCity": "Estero", "primaryStateID": "FL", "primaryPostalCode": "33928", "primaryCountryID": "US" }, "vehicles": { "items": [ { "make": "Honda", "model": "Civic", "yearBuilt": "2019", "color": "Silver" } ] }, "occupants": { "items": [ { "name": "Sam Doe", "birthDate": "2015-04-02", "relationship": "Son" } ] }, "pets": { "items": [ { "name": "Biscuit", "type": "Dog", "age": 4, "weight": 45, "gender": "Male", "neutered": "Yes" } ] }, "employmentHistory": { "items": [ { "isCurrentEmployer": "Yes", "name": "Gulf Coast Clinic", "position": "Nurse", "monthlySalary": "5200", "startDate": "2020-03-01" } ] } } } ``` Responses: - `200`: The applicant created, with its `applicationID` - `application/json`: `applicant` Example: ```json { "applicantID": "4", "applicationID": "4", "number": 100001, "templateID": "16", "userID": null, "applicantContactID": "49", "unitID": "47", "countryID": "US", "address": "8207 Littel Mountains Suite 105", "address2": null, "city": "Nevachester", "stateID": "HI", "postalCode": "98941", "rent": "1650.00", "deposit": "1650.00", "moveInDate": "2026-12-01", "leaseMonths": "12", "agentName": null, "agentContactInformation": null, "firstName": "Jane", "middleName": "Marie", "lastName": "Doe", "email": "jane.doe@example.com", "homePhone": "+12395550100", "cellPhone": "+12395551234", "workPhone": "+12395550101", "birthDate": "1990-01-15", "birthPlace": null, "ssnCiphertextID": "4", "ssnTruncated": "6789", "licenseNumber": null, "licenseState": null, "passportID": null, "studentID": null, "maidenName": null, "height": null, "weight": null, "eyeColor": null, "hairColor": null, "maritalStatus": null, "citizenship": null, "referredBy": null, "assistanceAgency": null, "assistanceCounty": null, "assistanceTechnician": null, "assistancePhone": null, "assistanceAmount": null, "assistanceUtility": null, "assistanceBeds": null, "applicantType": null, "primaryAddress": "456 Applicant St", "primaryAddress2": null, "primaryCity": "Estero", "primaryStateID": "FL", "primaryPostalCode": "33928", "primaryCountryID": "US", "primaryRentOwn": null, "primaryMonthlyPayment": null, "primaryMoveInDate": null, "primaryManagerName": null, "primaryManagerPhone": null, "primaryManagerEmail": null, "primaryReasonForLeaving": null, "signature": null, "addressHistory": null, "bankAccounts": null, "creditCards": null, "emergencyContacts": null, "employmentHistory": { "items": [ { "isCurrentEmployer": "Yes", "name": "Gulf Coast Clinic", "position": "Nurse", "monthlySalary": "5200", "startDate": "2020-03-01", "_id": 1 } ], "maxID": 1 }, "income": null, "occupants": { "items": [ { "name": "Sam Doe", "birthDate": "2015-04-02", "relationship": "Son", "_id": 1 } ], "maxID": 1 }, "pets": { "items": [ { "name": "Biscuit", "type": "Dog", "age": 4, "weight": 45, "gender": "Male", "neutered": "Yes", "_id": 1 } ], "maxID": 1 }, "references": null, "vehicles": { "items": [ { "make": "Honda", "model": "Civic", "yearBuilt": "2019", "color": "Silver", "_id": 1 } ], "maxID": 1 }, "questions": null, "terms": null, "addendumSignature": null, "addendumInitials": null, "incomeVerificationReportToken": null, "incomeVerificationReportStatusID": null, "incomeVerificationReportData": null, "incomeVerificationReportError": null, "identityVerificationReportStatusID": null, "identityVerificationReportData": null, "identityVerificationReportToken": null, "identityVerificationPlaidTemplate": null, "dateTimeCreated": "2026-11-14 02:46:17", "dateTimeModified": "2026-11-14 02:46:17", "startedApplicationID": null, "creditReportDocumentID": null, "criminalReportDocumentID": null, "evictionReportDocumentID": null } ``` - `400`: The request was refused; the Business Rules give the order of the checks. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - Application messages: object - Record messages: object Example: ```json { "error": "invalid input." } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` - `500`: The `application` isn't an object, an array was sent where a required field expects text, or a question or term has no `variableFieldID` or one that isn't any template's. No body. #### Get Application `GET /screening/applications/{applicationID}` Operation ID: `getScreeningApplication` Returns the core details of a single rental application by its ID, including the application record and its current status. ##### Use Cases - Retrieve the current status and metadata of a specific application - Display application details in a manager review view ##### Business Rules - Returns a `404` if the application does not exist or is not accessible to the authenticated account. - The `status` object reflects both the custom sub-status (`applicationStatusID`) and the underlying system-level status (`primaryApplicationStatusID`). ##### Related Endpoints - `GET /screening/applications` — list all applications - `GET /screening/applications/{applicationID}/summary` — full summary with applicant details and screening data - `POST /screening/applications/{applicationID}/status` — update the application status Parameters: - `applicationID` (path, integer, required): The unique identifier of the application. Responses: - `200`: Successfully retrieved the application - `application/json`: object - `application` (object, required) - `applicationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the application. - `number` (string, required, pattern `^-?[0-9]+$`): Human-readable application reference number. - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the primary (system-level) status. - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the current status (may be a custom sub-status). - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`): User ID of the manager assigned to review this application. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): ID of the unit being applied for. - `countryID` (string | null, required): Two-letter country code for the unit address. - `address` (string | null, required) - `address2` (string | null) - `city` (string | null, required) - `stateID` (string | null, required): Two-letter state/province code. - `postalCode` (string | null, required) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `status` (object, required) - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `isSystemStatus` (string, required, one of "0", "1"): Whether this is a built-in system status. - `name` (string, required) - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort order of this status in the status pipeline. Example: ```json { "application": { "applicationID": "1702", "number": "101653", "primaryApplicationStatusID": "6", "applicationStatusID": "6", "assignedToUserID": null, "unitID": "709", "countryID": "US", "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "dateTimeCreated": "2026-04-20 13:59:38", "dateTimeModified": "2026-04-25 19:07:46" }, "status": { "applicationStatusID": "6", "primaryApplicationStatusID": "6", "isSystemStatus": "1", "name": "Approved", "orderIndex": "5" } } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Application not found - `application/json`: object - `error` (string) Example: ```json { "error": "Application 1702 not found" } ``` - `429`: see shared response `error_429` #### Get Application Summary `GET /screening/applications/{applicationID}/summary` Operation ID: `getScreeningApplicationSummary` Returns an enriched summary of a rental application, including applicant qualification data (income ratio, combined income, occupants, animals), individual applicant records with screening field statuses, pending applicant slots, legacy screening reports, and the screening report mode. This endpoint provides significantly more detail than `GET /screening/applications/{applicationID}` and is intended for the application review screen. ##### Use Cases - Render the full application review page with income ratios, bedroom counts, and applicant screening statuses - Display individual applicant data tabs (credit, criminal, eviction, income, identity, rental history) - Determine whether legacy screening reports are available for an application ##### Business Rules - Returns a `404` if the application does not exist or is not accessible to the authenticated account. - `summary.incomeRatio` is calculated as `combinedIncome / rent`. A ratio meeting or exceeding `expectedRatio` indicates the applicant qualifies by income. - `applicants[].data` is an array of screening field status objects, one per field type (application, animals, identity, income, credit, criminal, eviction, landlord). - `screeningReportModeID` is the account's screening report mode (`\Rentvine\Screening\Report\Modes`): `0` = Disabled, `1` = Package, `2` = Dynamic. - `pendingApplicants` contains applicant slots that have been invited but have not yet submitted their portion of the application. ##### Related Endpoints - `GET /screening/applications/{applicationID}` — lightweight application record without summary data - `GET /screening/applicants/{applicantID}/tab/application` — full applicant form data for a specific applicant - `POST /screening/reports` — order screening reports for applicants - `POST /screening/applications/{applicationID}/status` — update the application status Parameters: - `applicationID` (path, integer, required): The unique identifier of the application. Responses: - `200`: Successfully retrieved the application summary - `application/json`: object - `application` (object, required) - `applicationID` (string, required, read-only, pattern `^-?[0-9]+$`) - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `summary` (object, required): Aggregate qualification data for the application. - `applicantNames` (string): Full names of all applicants, comma-separated. - `rent` (string | null, decimal): Monthly rent for the unit being applied for. - `incomeRatio` (string): Ratio of combined monthly income to monthly rent. - `availableBy` (string | null): Date the unit is available, if set. - `combinedIncome` (number): Total monthly income across all applicants. - `applicants` (integer): Number of applicants on the application. - `occupants` (integer): Number of additional occupants (non-applicants). Counted in PHP, so a JSON integer. - `animals` (integer): Number of animals declared by applicants. - `requestedMoveIn` (string): Requested move-in date, or `--` if not provided. - `numberOfBedrooms` (string) - `numberOfBathrooms` (string) - `numberOfHalfBathrooms` (string) - `expectedRatio` (number): Minimum income-to-rent ratio required to qualify. - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `countryID` (string | null) - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `number` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string, pattern `^-?[0-9]+$`) - `prospectID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`): ID of the lease created from this application, if any. - `paymentCount` (integer) - `messageCount` (integer) - `fileCount` (integer) - `noteCount` (integer) - `letterCount` (integer) - `applicants` (object[], required): List of applicant records with screening field statuses. - `applicantID` (string | null, read-only, pattern `^-?[0-9]+$`) - `name` (string) - `email` (string | null, email) - `phone` (string | null) - `dob` (string): Date of birth in M-D-YYYY format. - `ssn` (string): Last 4 digits of the applicant's SSN (masked). - `templateID` (string, pattern `^-?[0-9]+$`) - `applicantType` (string | null) - `isApiUser` (boolean) - `isManagerSubmitted` (boolean): Whether the application was submitted on behalf of the applicant by a manager. - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `data` (object[]): Array of screening field status objects, one per field type. - `field` (string): Field identifier (e.g. `application`, `credit`, `criminal`, `eviction`, `income`, `identity`, `animals`, `landlord`). - `label` (string | null): Display label for this field. - `icon` (string) - `status` (string | null) - `value` (string): Human-readable status value. - `BadgeLabel` (string | null) - `BadgeStatus` (integer | null) - `showIcon` (boolean) - `pendingApplicants` (object[], required): Applicant slots that have been invited but not yet submitted. - `legacyReports` (object[], required): Legacy screening report records from a prior provider integration. - `legacyReportsLogo` (string, uri, required): URL of the logo for the legacy screening provider. - `screeningReportModeID` (string | integer, required, one of "0", "1", "2", 0): The account's screening report mode: * `0` - Disabled * `1` - Package * `2` - Dynamic Read from the account's screening settings, so a string like any column. An account with no screening settings gets the in-memory default, the JSON integer `0`. Example: ```json { "application": { "applicationID": "1702", "applicationStatusID": "6", "assignedToUserID": null, "primaryApplicationStatusID": "6", "summary": { "applicantNames": "Walter William DeVeas", "rent": "1000", "incomeRatio": "4.00", "availableBy": null, "combinedIncome": 4000, "applicants": 1, "occupants": 0, "animals": 0, "requestedMoveIn": "--", "numberOfBedrooms": "0", "numberOfBathrooms": "0", "numberOfHalfBathrooms": "0", "expectedRatio": 2.5, "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "countryID": "US", "dateTimeCreated": "2026-04-20 13:59:38", "dateTimeModified": "2026-04-25 19:07:46", "number": "101653", "propertyID": "730", "prospectID": null, "unitID": "709", "leaseID": "2997", "paymentCount": 0, "messageCount": 1, "fileCount": 0, "noteCount": 0, "letterCount": 0 }, "applicants": [ { "applicantID": "1664", "name": "Walter William DeVeas", "email": "applicant@example.com", "phone": null, "dob": "1-1-2001", "ssn": "3333", "templateID": "1", "applicantType": null, "isApiUser": false, "isManagerSubmitted": true, "dateTimeCreated": "2026-04-20 09:59:38", "data": [ { "field": "application", "label": "Application", "icon": "newspaper", "status": "complete", "value": "Submitted", "BadgeLabel": "Apr 20, 2026", "BadgeStatus": 1, "showIcon": false }, { "field": "credit", "label": "Credit", "icon": "credit-card", "screeningReportModeID": null, "value": "Error", "showIcon": true, "BadgeLabel": "Error", "BadgeStatus": 2 } ] } ], "pendingApplicants": [], "legacyReports": [], "legacyReportsLogo": "https://cdn.rentvine.com/_resources/crs-logo.png", "screeningReportModeID": "2" } } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Application not found - `application/json`: object - `error` (string) Example: ```json { "error": "Application 1702 not found" } ``` - `429`: see shared response `error_429` #### Update Application Status `POST /screening/applications/{applicationID}/status` Operation ID: `updateApplicationStatus` Updates the status of a rental application and optionally sends a notification email to the applicant and/or additional recipients. This is the primary action used to move an application through the review pipeline (e.g. from Submitted → Under Review → Approved or Declined). ##### Use Cases - Approve or decline an application after review - Move an application to a custom sub-status (e.g. "Contingent", "Pending Documents") - Send a templated notification email to the applicant upon status change - BCC additional recipients (e.g. owner, team member) on the notification ##### Business Rules - `applicationStatusID` must reference a valid system or custom status ID. - When `sendEmail` is `true`, the `email` object is required and must include at least one entry in `recipients`. - `emailTemplateID` references an email template configured in the account. The template may include Liquid variables such as `{{ application.applicantNames | list }}` and `{{ application.address }}`. - `bcc` and `additionalRecipients` accept arrays of email address strings. - `attachments` accepts an array of file attachment references (empty array if none). - `copySender` is treated as a string boolean: `"1"` = copy the sending user, `"0"` = do not copy. - Returns a `400` if `applicationStatusID` is missing or invalid. - Returns a `404` if the application does not exist or is not accessible. ##### Related Endpoints - `GET /screening/applications/{applicationID}` — retrieve current application status - `GET /screening/applications/{applicationID}/summary` — full application review data Parameters: - `applicationID` (path, integer, required): The unique identifier of the application. Request body, required: - `application/json`: object - `applicationStatusID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the status to set on the application. Common system status IDs: * `1` - Incomplete * `2` - Submitted * `3` - In Progress * `4` - On Hold * `5` - In Review * `6` - Approved * `7` - Declined - `sendEmail` (boolean, default false): Whether to send a notification email to the applicant on status change. - `email` (object): Email configuration. Required when `sendEmail` is `true`. - `emailTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): ID of the email template to use. The template may contain Liquid variables. - `copySender` (string | integer, one of "0", "1", 0, 1): Whether to send a copy to the sending user. `"1"` = yes, `"0"` = no. - `bcc` (string, email[]): List of email addresses to BCC on the notification. - `additionalRecipients` (string, email[]): Additional email addresses to send the notification to. - `subject` (string): Email subject line. - `message` (string): HTML body of the email. Supports Liquid template variables. - `attachments` (object[]): File attachments to include with the email. - `recipients` (string, email[]): Primary email recipients. Should include the applicant's email address. Example: ```json { "applicationStatusID": "6", "sendEmail": true, "email": { "emailTemplateID": "22", "copySender": "0", "bcc": [ "manager@example.com" ], "additionalRecipients": [ "owner@example.com" ], "subject": "Your application is approved!", "message": "

Hello {{ application.applicantNames | list }},

Your application has been approved for {{ application.address }}. Please keep an eye out for an email to activate your tenant portal where you will be able to enter a payment to secure the unit.

Thanks!

", "attachments": [], "recipients": [ "applicant@example.com" ] } } ``` Responses: - `200`: Application status successfully updated - `application/json`: object - `application` (object, required): The updated application record. - `applicationID` (string, required, read-only, pattern `^-?[0-9]+$`) - `number` (string, required, read-only, pattern `^-?[0-9]+$`) - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`) - `unitID` (string | null, required, pattern `^-?[0-9]+$`) - `countryID` (string | null, required) - `address` (string | null, required) - `address2` (string | null) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `status` (object, required): The application status record set by this action. - `applicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `primaryApplicationStatusID` (string, required, pattern `^-?[0-9]+$`) - `isSystemStatus` (string, required, one of "0", "1") - `name` (string, required) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) Example: ```json { "application": { "applicationID": "1702", "number": "101653", "primaryApplicationStatusID": "1", "applicationStatusID": "1", "assignedToUserID": "45", "unitID": "709", "countryID": "US", "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "dateTimeCreated": "2026-04-20 13:59:38", "dateTimeModified": "2026-04-27 12:57:59" }, "status": { "applicationStatusID": "1", "primaryApplicationStatusID": "1", "isSystemStatus": "1", "name": "Pending", "orderIndex": "1" } } ``` - `400`: Invalid request payload - `application/json`: object - `error` (string) Example: ```json { "error": "applicationStatusID is required" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Application not found - `application/json`: object - `error` (string) Example: ```json { "error": "Application 1702 not found" } ``` - `429`: see shared response `error_429` #### Get Applicant Application Tab `GET /screening/applicants/{applicantID}/tab/application` Operation ID: `getApplicantApplicationTab` Returns the full application form data for a specific applicant, including personal details, employment history, address history, vehicles, occupants, SSN (last 4 digits), and the dynamic form builder structure used to render the application. This endpoint powers the applicant detail tab in the application review screen. ##### Use Cases - Render a read-only view of a specific applicant's submitted application form - Extract structured employment and address history for underwriting review - Access the dynamic `builder` field structure to display custom application sections and fields ##### Business Rules - Returns a `404` if the applicant does not exist or is not accessible to the authenticated account. - `ssn` returns only the last 4 digits of the social security number — the full value is never exposed via the API. - `builder.sections` contains the dynamic form structure including all active sections and field definitions. `includedForView` = `1` means the section is visible in the review view. - `employmentHistory` and `vehicles` use an `items` + `maxID` structure where `maxID` tracks the highest auto-incremented ID for client-side additions. - `addressHistory` may be `null` if the applicant did not provide prior addresses. ##### Related Endpoints - `GET /screening/applications/{applicationID}/summary` — application-level summary with all applicants - `GET /screening/applications/{applicationID}` — application core record - `POST /screening/reports` — order screening reports for this applicant Parameters: - `applicantID` (path, integer, required): The unique identifier of the applicant. Responses: - `200`: Successfully retrieved the applicant application tab data - `application/json`: object - `applicantID` (string, required, read-only, pattern `^-?[0-9]+$`) - `applicationID` (string, required, pattern `^-?[0-9]+$`) - `number` (string | null, required, pattern `^-?[0-9]+$`): Application reference number. - `userID` (string | null, pattern `^-?[0-9]+$`): Linked Rentvine user account ID, if the applicant has a portal account. - `applicantContactID` (string | null, pattern `^-?[0-9]+$`): ID of the contact record created for this applicant. - `unitID` (string | null, required, pattern `^-?[0-9]+$`) - `countryID` (string | null, required) - `address` (string | null, required) - `address2` (string | null) - `city` (string | null, required) - `stateID` (string | null, required) - `postalCode` (string | null, required) - `moveInDate` (string | null, date): Requested move-in date. - `leaseMonths` (string | null): Requested lease duration as a human-readable string. - `firstName` (string | null, required) - `middleName` (string | null) - `lastName` (string | null, required) - `email` (string | null, email, required) - `homePhone` (string | null) - `cellPhone` (string | null) - `workPhone` (string | null) - `birthDate` (string | null, date) - `licenseNumber` (string | null) - `licenseState` (string | null) - `applicantType` (string | null): Type of applicant (e.g. primary, co-applicant). Null when not specified. - `ssn` (string | null): Last 4 digits of the applicant's Social Security Number. - `addressHistory` (object | null): Prior address history entries in `items` + `maxID` structure. - `employmentHistory` (object | null): Employment history entries. - `items` (object[]) - `_id` (integer) - `name` (string): Employer name. - `phone` (string | null) - `position` (string | null) - `monthlySalary` (string): Monthly gross salary as a decimal string. - `isCurrentEmployer` (string, one of "Yes", "No") - `maxID` (integer): Highest auto-incremented ID for client-side tracking. - `occupants` (object | null): Additional occupants in `items` + `maxID` structure. - `vehicles` (object | null): Vehicle information entries. - `items` (object[]) - `_id` (integer) - `make` (string) - `model` (string | null) - `color` (string | null) - `yearBuilt` (string | null) - `maxID` (integer) - `builder` (object): Dynamic form builder structure defining the application sections and fields. - `sections` (object[]): Ordered list of form sections. - `name` (string) - `label` (string) - `id` (integer) - `isSystemRequired` (boolean) - `isActive` (boolean) - `isMulti` (boolean) - `isPrintable` (boolean) - `includedForView` (integer): Whether the section is visible in the review view. `1` = visible. - `groups` (object[]) - `fields` (object[]) Example: ```json { "applicantID": "1664", "applicationID": "1702", "number": "101635", "userID": null, "applicantContactID": "5231", "unitID": "709", "countryID": "US", "address": "9470 Corkscrew Palms Circle", "address2": "315", "city": "Estero", "stateID": "FL", "postalCode": "33928", "moveInDate": null, "leaseMonths": "1 year", "firstName": "Walter", "middleName": "William", "lastName": "DeVeas", "email": "applicant@example.com", "homePhone": null, "cellPhone": null, "workPhone": null, "birthDate": "2001-01-01", "licenseNumber": null, "licenseState": null, "applicantType": null, "ssn": "3333", "addressHistory": null, "employmentHistory": { "items": [ { "_id": 1, "name": "Acme Property Management", "phone": "+12395550188", "position": "Property Manager", "monthlySalary": "4000.00", "isCurrentEmployer": "Yes" } ], "maxID": 1 }, "occupants": null, "vehicles": { "items": [ { "_id": 1, "make": "Nissan", "model": "Altima", "color": "Gray", "yearBuilt": "2017" } ], "maxID": 1 } } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Applicant not found - `application/json`: object - `error` (string) Example: ```json { "error": "Applicant 1664 not found" } ``` - `429`: see shared response `error_429` #### Order Screening Reports `POST /screening/reports` Operation ID: `orderScreeningReports` Orders one or more screening reports (credit, criminal, eviction) for specified applicants on a rental application. Reports are requested from the integrated screening provider and results are associated with the applicant records. ##### Use Cases - Trigger credit, criminal, and/or eviction checks for all applicants on an application - Order only specific report types (e.g. eviction only) for a subset of applicants - Re-run screening reports after an initial error ##### Business Rules - `applicationID` must reference an existing, accessible application. - `applicantIDs` must contain at least one applicant ID. All provided applicants must belong to the specified application. - `reportTypeIDs` must contain at least one valid report type. Supported report type IDs: * `1` — Credit * `2` — Criminal * `3` — Eviction - The account must have an active screening provider integration configured (`applicationProviderID` in screening settings). - Returns a `400` if any applicant ID does not belong to the specified application or if `reportTypeIDs` is empty. - Report results are returned asynchronously by the provider — this endpoint initiates the request but does not return the report data. Poll `GET /screening/applications/{applicationID}/summary` to check report status. ##### Related Endpoints - `GET /screening/settings` — verify screening provider is configured - `GET /screening/applications/{applicationID}/summary` — check report status after ordering - `GET /screening/applicants/{applicantID}/tab/application` — view applicant details before ordering Request body, required: - `application/json`: object - `applicationID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the application to order reports for. - `applicantIDs` (integer[], required): List of applicant IDs to run reports for. All must belong to the specified application. - `reportTypeIDs` (integer[], required): List of report type IDs to order. * `1` — Credit * `2` — Criminal * `3` — Eviction Example: ```json { "applicationID": "1702", "applicantIDs": [ 1664 ], "reportTypeIDs": [ 1, 2, 3 ] } ``` Responses: - `200`: Screening reports successfully ordered - `application/json`: object Example: ```json { "success": true, "message": "Screening reports have been ordered" } ``` - `400`: Invalid request payload - `application/json`: object - `error` (string) Example: ```json { "error": "applicantIDs is required and must not be empty" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: Application not found - `application/json`: object - `error` (string) Example: ```json { "error": "Application 1702 not found" } ``` - `429`: see shared response `error_429` ## Custom Fields ### Custom Fields #### List Custom Field Object Types `GET /custom-field-category-object-types` Operation ID: `listCustomFieldCategoryObjectTypes` Returns all available custom field category object types. Each entry represents a distinct type of object in the system (e.g., Owner, Lease, Property) that can have custom field categories and fields assigned to it. Object types are static and preset — they cannot be created or deleted via the API. ##### Use Cases - Enumerate all object types before populating a dropdown for selecting which object type a new custom field category should apply to - Display a summary of how many custom field categories and fields are configured per object type - Determine valid `customFieldCategoryObjectTypeID` values for use in `POST /custom-field-categories` and `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` ##### Business Rules - Object types are system-defined and static — this list does not change between requests - `categoryCount` reflects the total number of custom field categories assigned to this object type - `fieldCount` reflects the total number of individual custom fields across all categories for this object type - No pagination — the full list is returned in a single response ##### Related Endpoints - `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` — list all categories and fields for a specific object type - `POST /custom-field-categories` — create a new custom field category under one of these object types - `GET /custom-fields/values/{objectTypeID}/{objectID}` — retrieve field values for an object Responses: - `200`: Successfully retrieved all custom field category object types - `application/json`: object[] - Each item: - `customFieldCategoryObjectTypeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the object type. Use this value as `customFieldCategoryObjectTypeID` when creating categories or fetching fields. - `categoryCount` (string, required): Total number of custom field categories configured for this object type. - `fieldCount` (string, required): Total number of individual custom fields across all categories for this object type. Example: ```json [ { "customFieldCategoryObjectTypeID": "1", "categoryCount": "17", "fieldCount": "20" }, { "customFieldCategoryObjectTypeID": "2", "categoryCount": "13", "fieldCount": "12" }, { "customFieldCategoryObjectTypeID": "3", "categoryCount": "9", "fieldCount": "10" }, { "customFieldCategoryObjectTypeID": "4", "categoryCount": "55", "fieldCount": "73" }, { "customFieldCategoryObjectTypeID": "5", "categoryCount": "121", "fieldCount": "185" }, { "customFieldCategoryObjectTypeID": "6", "categoryCount": "18", "fieldCount": "27" }, { "customFieldCategoryObjectTypeID": "8", "categoryCount": "9", "fieldCount": "22" }, { "customFieldCategoryObjectTypeID": "9", "categoryCount": "3", "fieldCount": "2" }, { "customFieldCategoryObjectTypeID": "10", "categoryCount": "4", "fieldCount": "7" }, { "customFieldCategoryObjectTypeID": "11", "categoryCount": "3", "fieldCount": "6" }, { "customFieldCategoryObjectTypeID": "12", "categoryCount": "1", "fieldCount": "3" }, { "customFieldCategoryObjectTypeID": "13", "categoryCount": "1", "fieldCount": "0" } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Get Custom Field Categories by Object Type `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` Operation ID: `getCustomFieldCategoriesByObjectType` Returns all custom field categories and their associated fields for a given object type. Unlike `GET /custom-fields/values/{objectTypeID}/{objectID}`, this endpoint returns the field definitions only — it does not include any values saved for a specific object. Use this endpoint to discover which categories and fields exist for an object type before reading or writing values via the values endpoints. ##### Use Cases - Build a custom field editor UI by first loading all available categories and fields for a given object type - Determine valid `customFieldID` keys when constructing a payload for `POST /custom-fields/values/{objectTypeID}/{objectID}` - Inspect field settings (e.g., dropdown options) to render appropriate input controls ##### Business Rules - `customFieldCategoryObjectTypeID` must be a valid ID from `GET /custom-field-category-object-types` - Categories are returned ordered by `orderIndex` - Each category includes a `customFields` array listing all fields in that category, ordered by their own `orderIndex` - The `settings` property is a JSON-encoded string that may contain a `description` and an `options` array for dropdown (`fieldTypeID: 3`) fields - This endpoint does not return current field values — use `GET /custom-fields/values/{objectTypeID}/{objectID}` for that ##### Related Endpoints - `GET /custom-field-category-object-types` — list all available object types - `GET /custom-fields/values/{objectTypeID}/{objectID}` — retrieve field values for a specific object - `POST /custom-fields/values/{objectTypeID}/{objectID}` — save field values for a specific object - `POST /custom-field-categories` — create a new category under this object type Parameters: - `customFieldCategoryObjectTypeID` (path, integer, required): The ID of the object type whose categories and fields should be returned. Obtain valid IDs from `GET /custom-field-category-object-types`. Responses: - `200`: Successfully retrieved custom field categories and fields for the object type - `application/json`: object[] - Each item: - `customFieldCategoryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field category. - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this category belongs to. - `name` (string, required): Display name of the category. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort position of the category relative to others for this object type. - `customFields` (object[], required): Ordered list of custom field definitions in this category. Empty array if no fields have been added yet. - `customFieldID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field. Use as the key when posting values. - `customFieldCategoryID` (string, required, pattern `^-?[0-9]+$`): The category this field belongs to. - `name` (string, required): Display label for the field. - `fieldTypeID` (string, required, one of "1", "2", "3", "4", "5", "6", "7", "8"): Controls the input type rendered for this field. * `1` - Short Text * `2` - Paragraph * `3` - Dropdown * `4` - Toggle * `5` - Date * `6` - Number * `7` - Decimal * `8` - Integer - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this field is scoped to. - `settings` (string | null, required): JSON-encoded metadata for this field. May include a `description` string and an `options` array for dropdown fields. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort position of the field within its category. - `valueColumn` (string | null, required): Internal database column used to store this field's value. Example: ```json [ { "customFieldCategoryID": "43", "customFieldCategoryObjectTypeID": "1", "name": "Owner Birthday", "orderIndex": "0", "customFields": [ { "customFieldID": "402", "customFieldCategoryID": "43", "name": "Rentvine Test", "fieldTypeID": "2", "customFieldCategoryObjectTypeID": "1", "settings": "{\"description\":null}", "orderIndex": "0", "valueColumn": "paragraph_2" }, { "customFieldID": "72", "customFieldCategoryID": "43", "name": "Owner Birthdayy", "fieldTypeID": "5", "customFieldCategoryObjectTypeID": "1", "settings": "{\"description\":null}", "orderIndex": "3", "valueColumn": "date_3" } ] }, { "customFieldCategoryID": "31", "customFieldCategoryObjectTypeID": "1", "name": "Insurance", "orderIndex": "2", "customFields": [ { "customFieldID": "55", "customFieldCategoryID": "31", "name": "Insurance Carrier", "fieldTypeID": "1", "customFieldCategoryObjectTypeID": "1", "settings": "{\"description\":null}", "orderIndex": "0", "valueColumn": "text_1" }, { "customFieldID": "56", "customFieldCategoryID": "31", "name": "Cancellation Date", "fieldTypeID": "5", "customFieldCategoryObjectTypeID": "1", "settings": "{\"description\":null}", "orderIndex": "1", "valueColumn": "date_2" } ] }, { "customFieldCategoryID": "184", "customFieldCategoryObjectTypeID": "1", "name": "Trash List", "orderIndex": "5", "customFields": [] } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Create Custom Field Category `POST /custom-field-categories` Operation ID: `createCustomFieldCategory` Creates a new custom field category under the specified object type. A category acts as a named grouping for related custom fields. After creating a category, custom fields can be added to it via the Rentvine UI or subsequent API calls. ##### Use Cases - Programmatically provision a new group of custom fields for a specific object type during account setup - Create a structured category (e.g., "Lease Terms", "Inspection Details") before adding fields to it ##### Business Rules - `name` and `customFieldCategoryObjectTypeID` together must be unique — a category with the same name cannot be created more than once for the same object type - `customFieldCategoryObjectTypeID` must reference a valid object type from `GET /custom-field-category-object-types` - The new category is created with no custom fields; fields must be added separately via the Rentvine interface ##### Related Endpoints - `GET /custom-field-category-object-types` — list available object types to find a valid `customFieldCategoryObjectTypeID` - `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` — verify the new category appears in the list after creation - `GET /custom-fields/values/{objectTypeID}/{objectID}` — retrieve field values for objects in this category's object type Request body, required: - `application/json`: object - `name` (string, required): Display name for the new custom field. Must be unique within the given category. - `fieldTypeID` (string | integer, required, one of "1", "2", "3", "4", "5", "6", "7", "8", 1, 2, 3, 4, 5, 6, 7, 8): Controls the input type rendered for this field. * `1` - Short Text * `2` - Paragraph * `3` - Dropdown * `4` - Toggle * `5` - Date * `6` - Number * `7` - Decimal * `8` - Integer - `options` (string): JSON-encoded array of options for Dropdown fields. Use `"[]"` for non-dropdown field types. - `customFieldCategoryID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the category this field will be added to. - `customFieldCategoryObjectTypeID` (string | integer, required, pattern `^-?[0-9]+$`): ID of the object type this category belongs to. Obtain valid values from `GET /custom-field-category-object-types`. Example: ```json { "name": "test-docs", "fieldTypeID": 1, "options": "[]", "customFieldCategoryID": "43", "customFieldCategoryObjectTypeID": "1" } ``` Responses: - `200`: Custom field created successfully. Returns the newly created custom field object. - `application/json`: object - `customField` (object, required) - `customFieldID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the newly created custom field. - `customFieldCategoryID` (string, required, pattern `^-?[0-9]+$`): The category this field was created under. - `name` (string, required): Display name of the custom field. - `fieldTypeID` (string, required, one of "1", "2", "3", "4", "5", "6", "7", "8"): The input type for this field (1=Short Text, 2=Paragraph, 3=Dropdown, 4=Toggle, 5=Date, 6=Number, 7=Decimal, 8=Integer). - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this field is scoped to. - `settings` (string | null, required): JSON-encoded string containing field metadata such as description and dropdown options. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort position of the field within its category. New fields are appended at the end. - `valueColumn` (string | null, required): Internal database column name used to store this field's value. Example: ```json { "customField": { "customFieldID": "610", "customFieldCategoryID": "43", "name": "test-docs", "fieldTypeID": "1", "customFieldCategoryObjectTypeID": "1", "settings": "{\"description\":null}", "orderIndex": "7", "valueColumn": "text_12" } } ``` - `400`: Validation error — category name already exists for this object type - `application/json`: object Example: ```json { "customFieldCategoryObjectTypeID": [ "This name and type already exists" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Delete Custom Field Category `DELETE /custom-field-categories/{customFieldCategoryID}` Operation ID: `deleteCustomFieldCategory` Deletes a custom field category with every custom field in it, and clears those fields' values on every record of the category's record type. Returns the deleted category. ##### Use Cases - Remove a group of custom fields the account no longer uses, in one call ##### Business Rules - Requires the **Manage Custom Fields** permission (`Administration` › `ManageCustomFields`), checked before anything else: a key without it gets the 403 whatever the body or ID. - A well-formed `customFieldCategoryID` with no category answers 400 `Custom Field Category {customFieldCategoryID} not found`; one that isn't all digits (`abc`, `-1`) answers the stock 404. - A category with no fields is deleted the same way. - The delete can't be undone, and the cleared values can't be recovered. ##### Side Effects - Every custom field in the category is deleted. - Those fields' values are cleared (set to null) on every record of the category's record type; values of fields in other categories are kept. - On each record whose values change, an "Updated" log entry is written, and an update event is raised where the record type sends webhooks. ##### Related Endpoints - `GET /custom-field-categories` (undocumented) - the account's categories - `DELETE /custom-fields/{customFieldID}` - delete one field Parameters: - `customFieldCategoryID` (path, integer, required): The category, from `GET /custom-field-categories` (undocumented). Responses: - `200`: The deleted category - `application/json`: `custom_field_category` Example: ```json { "customFieldCategoryID": "7", "customFieldCategoryObjectTypeID": "5", "name": "Access details", "orderIndex": "0" } ``` - `400`: No category has this `customFieldCategoryID`. - `application/json`: object - `error` (string, required): Why the request was refused. Example: ```json { "error": "Custom Field Category 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Delete Custom Field `DELETE /custom-fields/{customFieldID}` Operation ID: `deleteCustomField` Deletes a custom field and clears its value on every record of its record type. Returns the deleted field. ##### Use Cases - Retire a custom field the account no longer uses ##### Business Rules - Requires the **Manage Custom Fields** permission (`Administration` › `ManageCustomFields`), checked before anything else: a key without it gets the 403 whatever the body or ID. - A well-formed `customFieldID` with no field answers 400 `Custom Field {customFieldID} not found`; one that isn't all digits (`abc`, `-1`) answers the stock 404. - The delete can't be undone, and the cleared values can't be recovered. ##### Side Effects - The field's value is cleared (set to null) on every record of its record type; the record's other custom field values are kept. - On each record whose value changes, an "Updated" log entry is written, and an update event is raised where the record type sends webhooks. ##### Related Endpoints - `GET /custom-fields/values/{objectTypeID}/{objectID}` - a record's custom field values - `DELETE /custom-field-categories/{customFieldCategoryID}` - delete a whole category and its fields Parameters: - `customFieldID` (path, integer, required): The custom field, from `GET /custom-fields` (undocumented). Responses: - `200`: The deleted custom field - `application/json`: `custom_field` Example: ```json { "customFieldID": "21", "customFieldCategoryID": "27", "name": "Gate code", "fieldTypeID": "1", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":\"Side gate code\"}", "orderIndex": "0", "valueColumn": "text_1" } ``` - `400`: No custom field has this `customFieldID`. - `application/json`: object - `error` (string, required): Why the request was refused. Example: ```json { "error": "Custom Field 999999999 not found" } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `404`: see shared response `error_404` - `429`: see shared response `error_429` #### Get Custom Field Values `GET /custom-fields/values/{objectTypeID}/{objectID}` Operation ID: `getCustomFieldValues` Returns all custom field categories and their field values for a given object type and object. Each category contains an ordered list of fields with their current values for the specified object. ##### Use Cases - Display custom field data on a property, lease, owner, tenant, or vendor detail page - Retrieve all custom fields associated with an applicant or screening record before displaying them - Audit which custom field values have been filled in for a specific object ##### Business Rules - `objectTypeID` identifies the type of object (e.g., `1` = Owner, `2` = Lease, `5` = Property) - `objectID` is the unique identifier of the specific object within that type - Fields with no value saved will return `null` for the `value` property - Fields are grouped by `customFieldCategoryID` and ordered by `orderIndex` - The `settings` property is a JSON-encoded string containing field metadata such as dropdown options and description ##### Related Endpoints - `POST /custom-fields/values/{objectTypeID}/{objectID}` — save or update field values for the object - `GET /custom-field-category-object-types` — list all object types and their category counts - `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` — list categories and fields for an object type Parameters: - `objectTypeID` (path, integer, required): The ID of the object type (e.g., `1` = Owner, `2` = Lease, `5` = Property). - `objectID` (path, integer, required): The unique ID of the specific object whose custom field values are being retrieved. Responses: - `200`: Successfully retrieved custom field values for the object - `application/json`: object[] - Each item: - `customFieldCategoryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field category. - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this category belongs to. - `name` (string, required): Display name of the custom field category. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort order of the category relative to other categories for this object type. - `fields` (object[], required): Ordered list of custom fields within this category, each including the current value for the object. - `customFieldID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field. - `customFieldCategoryID` (string, required, pattern `^-?[0-9]+$`): The category this field belongs to. - `name` (string, required): Display label for the field. - `fieldTypeID` (string, required, one of "1", "2", "3", "4", "5", "6", "7", "8"): Controls the input type rendered for this field. * `1` - Short Text * `2` - Paragraph * `3` - Dropdown * `4` - Toggle * `5` - Date * `6` - Number * `7` - Decimal * `8` - Integer - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this field is scoped to. - `settings` (string | null, required): JSON-encoded string containing field metadata. May include a `description` and an `options` array for dropdown fields. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort position of the field within its category. - `valueColumn` (string | null, required): Internal database column name used to store this field's value. - `value` (string | null): The current saved value for this field on the specified object. `null` if no value has been saved. Example: ```json [ { "customFieldCategoryID": "12", "customFieldCategoryObjectTypeID": "5", "name": "Alarm System", "orderIndex": "1", "fields": [ { "customFieldID": "25", "customFieldCategoryID": "12", "name": "Numeric Alarm Pad", "fieldTypeID": "8", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":null}", "orderIndex": "0", "valueColumn": "integer_2", "value": "123" }, { "customFieldID": "50", "customFieldCategoryID": "12", "name": "Alarm Provider", "fieldTypeID": "3", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":null,\"options\":\"[\\\"Simply Safe\\\",\\\"Tyco\\\",\\\"ADT\\\"]\"}", "orderIndex": "1", "valueColumn": "text_7", "value": null } ] }, { "customFieldCategoryID": "26", "customFieldCategoryObjectTypeID": "5", "name": "WiFi Code", "orderIndex": "2", "fields": [ { "customFieldID": "40", "customFieldCategoryID": "26", "name": "Code", "fieldTypeID": "1", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":null}", "orderIndex": "0", "valueColumn": "text_3", "value": null } ] } ] ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` #### Save Custom Field Values `POST /custom-fields/values/{objectTypeID}/{objectID}` Operation ID: `saveCustomFieldValues` Saves or updates the custom field values for a specific object. The request body is a flat map where each key is a `customFieldID` (as a string) and the value is the new value to save. A `customFieldCategoryID` key must be included to scope the update to the correct category. Only the fields provided in the payload are updated. Fields not included in the payload retain their existing values. ##### Use Cases - Save filled-in custom field data after a user edits a property, lease, or contact record - Programmatically populate custom fields during an import or onboarding flow - Clear a field value by setting it to `null` ##### Business Rules - `objectTypeID` and `objectID` in the path must match a valid object - Keys in the request body are `customFieldID` values cast to strings - `customFieldCategoryID` is required in the payload to scope the write to the correct category - Setting a field value to `null` clears any previously stored value - The response returns the full updated set of categories and fields for the object (same shape as `GET /custom-fields/values/{objectTypeID}/{objectID}`) ##### Related Endpoints - `GET /custom-fields/values/{objectTypeID}/{objectID}` — retrieve current field values for the object - `GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}` — list categories and fields to know which `customFieldID` keys are valid Parameters: - `objectTypeID` (path, integer, required): The ID of the object type (e.g., `1` = Owner, `2` = Lease, `5` = Property). - `objectID` (path, integer, required): The unique ID of the specific object whose custom field values are being saved. Request body, required: - `application/json`: object - `customFieldCategoryID` (string | integer, required, pattern `^-?[0-9]+$`): The ID of the category being updated. All field IDs in the payload must belong to this category. Example: ```json { "364": null, "469": "test", "customFieldCategoryID": "96" } ``` Responses: - `200`: Custom field values saved successfully. Returns the full updated list of categories and field values for the object. - `application/json`: object[] - Each item: - `customFieldCategoryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field category. - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this category belongs to. - `name` (string, required): Display name of the custom field category. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort order of the category. - `fields` (object[], required): Updated list of custom fields with their latest values. - `customFieldID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the custom field. - `customFieldCategoryID` (string, required, pattern `^-?[0-9]+$`): The category this field belongs to. - `name` (string, required): Display label for the field. - `fieldTypeID` (string, required, one of "1", "2", "3", "4", "5", "6", "7", "8"): Field input type (1=Short Text, 2=Paragraph, 3=Dropdown, 4=Toggle, 5=Date, 6=Number, 7=Decimal, 8=Integer). - `customFieldCategoryObjectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type this field is scoped to. - `settings` (string | null, required): JSON-encoded field metadata string. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): Sort position within the category. - `valueColumn` (string | null, required): Internal database column used to store this field's value. - `value` (string | null): The newly saved value for this field. `null` if the field was cleared. Example: ```json [ { "customFieldCategoryID": "12", "customFieldCategoryObjectTypeID": "5", "name": "Alarm System", "orderIndex": "1", "fields": [ { "customFieldID": "25", "customFieldCategoryID": "12", "name": "Numeric Alarm Pad", "fieldTypeID": "8", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":null}", "orderIndex": "0", "valueColumn": "integer_2", "value": "123" }, { "customFieldID": "50", "customFieldCategoryID": "12", "name": "Alarm Provider", "fieldTypeID": "3", "customFieldCategoryObjectTypeID": "5", "settings": "{\"description\":null,\"options\":\"[\\\"Simply Safe\\\",\\\"Tyco\\\",\\\"ADT\\\"]\"}", "orderIndex": "1", "valueColumn": "text_7", "value": null } ] } ] ``` - `400`: Validation error - `application/json`: object Example: ```json { "customFieldCategoryID": [ "The category does not exist or does not belong to this object type" ] } ``` - `401`: see shared response `error_401` - `403`: see shared response `error_403` - `429`: see shared response `error_429` ## Shared responses ### TooManyRequests ### error_401 Unauthorized — missing or invalid API credentials. - `application/json`: object - `code` (integer, required, one of 401): Always the JSON integer `401`. Note the inconsistency with `404` responses, whose `code` is the string `'404'`. - `error` (string, required): `Access Denied`, or the authentication failure's own message. Example: ```json { "code": 401, "error": "Access Denied" } ``` ### error_400 Bad request: the request was refused. The operations that use this response send one of two shapes: - **One message**, `{"error": ""}`: an empty or malformed body, a record the path or a field names that doesn't exist (`Work Order 123 not found`), or a business rule that refused the request. A few also send `message` with a longer explanation. - **Validation messages**, a map from each field that failed to the list of its messages. Keys vary with the request: a field's name, often prefixed with the object it belongs to (`workOrder.priorityID`), sometimes an object name alone (`workOrder`) or a deeper path. An operation that answers a 400 with another shape (a bare string, a list) documents its own 400 instead. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - `message` (string): A longer explanation, sent by a few refusals alongside `error`. - Validation messages: object Example: ```json { "error": "invalid input." } ``` ### error_403 Forbidden: the API key signed in, but this request was refused. `error` says which check refused it; the same message can come from different checks, so read it with the operation's own description: - `Permission Denied`: usually the key's role lacks a permission this operation needs (set per role in Settings › Users, Roles and API). Some operations send it to every API key whatever its role (account-administration operations such as managing API keys) or admit only Rentvine staff; no role change helps there. - `Access denied`, with a lowercase `d`: a few operations' own permission checks (managing users, roles and portal invitations); give the role that permission. - `Access Denied`, or a message naming what was refused: the key's user is restricted to some portfolios and the record isn't in them. Where the check runs before the record is read, a restricted key gets this for a record that doesn't exist too, instead of a 400 or 404. Some operations refuse any portfolio-restricted key whatever the record (for example `You don't have access to view withholdings.`), and a few refuse for another reason the message names. - A message naming a feature (`Workflows are not enabled for your account.`): the feature isn't enabled for the account. - `ELEVATION_REQUIRED`: the operation needs a recently re-authenticated session, which an API key can't hold, so it answers this to an API key unless Rentvine has turned on API elevation for the account; `elevatedUntil` is `null` for an API key. Some operations, a few feature gates among them, refuse with an empty body that isn't JSON (no `Content-Type: application/json`), and the reason is dropped: don't assume every 403 has a body. - `application/json`: object - `error` (string, required): Which check refused the request (see the response description). - `elevatedUntil` (integer | null): Sent only with `ELEVATION_REQUIRED`: when the session's last elevation expired, as a Unix timestamp, or `null` when it has none, which is always the case for an API key. Example: ```json { "error": "Permission Denied" } ``` ### account_create_400 The account wasn't created. An empty body (or one that isn't JSON), a missing or unknown account type, and an unexpected error each send one `error`; everything else sends a map of validation messages, keyed `bankAccount.` for a bank account's numbers (checked first) or `account.` for the account's own fields. A rule that spans two fields is keyed by both field names joined by a comma: a number already used under the same parent is keyed `account.number,parentAccountID`. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - Validation messages: object Example: ```json { "error": "invalid input." } ``` ### error_404 Not found — the requested resource doesn't exist or isn't accessible to the authenticated account. - `application/json`: object - `code` (string, required, one of "404"): Always the string `'404'`. Note the inconsistency with `401` responses, whose `code` is the JSON integer `401`. - `error` (string, required, one of "Not Found") - `message` (string, required, one of "Requested Resource could not be found."): The same text for every resource; the response doesn't say which record was missing. Example: ```json { "code": "404", "error": "Not Found", "message": "Requested Resource could not be found." } ``` ### account_update_200 The account was changed. The body is the account as `GET /accounting/accounts/{accountID}` reads it, with the includes the request's `includes` asked for. - `application/json`: `account_detail` Example: ```json { "account": { "accountID": "173", "parentAccountID": null, "accountTypeID": "7", "accountCategoryID": null, "number": "4962", "name": "Application Fees", "isActive": "1", "isSubjectToManagementFees": "1", "isSubjectToLateFees": "0", "isDeposit": "0", "depositTypeID": null, "isEscrow": "0", "isRent": "0", "isSubsidized": "0", "isTaxable": "1", "isSubjectToSalesTax": "0", "isSubjectToMarkup": "1", "isPrepayment": "0", "isManagementFee": "0", "isBudgetEnabled": "0", "isHeld": "0", "bankName": null, "bankAccountTypeID": null, "bankAccountCiphertextID": null, "bankAccountNumberTruncated": null, "bankAccountAddress": null, "bankAccountAddress2": null, "bankAccountCity": null, "bankAccountStateID": null, "bankAccountPostalCode": null, "bankAccountCountryID": null, "isCheckingEnabled": "0", "checkCompanyName": null, "checkSignatory": null, "checkAddress": null, "checkAddress2": null, "checkCity": null, "checkStateID": null, "checkPostalCode": null, "checkCountryID": null, "bankAccountNextCheckNumber": null, "bankAccountNextDepositNumber": null, "checkTemplateID": null, "creditCardGatewayID": null, "achGatewayID": null, "cashCardGatewayID": null, "remoteCheckGatewayID": null, "isFromImport": "0", "importSourceKey": null, "isNachaEnabled": "0", "isNachaFileBalanced": "0", "nachaOriginName": null, "nachaOriginNumber": null, "nachaDestinationName": null, "nachaDestinationNumber": null, "nachaCompanyIdentification": null, "nachaCompanyName": null, "nachaOriginatingFinancialInstitutionID": null, "nachaAdapterID": null, "isBillApprovalExempt": "0", "exportInvoiceServiceName": null, "dateTimeCreated": "2026-11-12 23:22:56", "dateTimeModified": "2026-11-12 23:22:56", "dateTimeDeactivated": null } } ``` ### account_update_400 The account wasn't changed. An empty body, an account that doesn't exist and an unexpected error each send one `error`; a refused field sends a map of validation messages keyed by the field's name. - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - Validation messages: object Example: ```json { "error": "invalid input." } ``` ### deposit_update_200 Deposit updated successfully. Returns the updated deposit detail. - `application/json`: object - `deposit` (`deposit`, required) Example: ```json { "deposit": { "depositID": "74", "bankAccountID": "220", "reconciliationID": null, "previousReconciliationID": "23", "depositNumber": "29", "description": "October rent deposits (revised)", "amount": "5045.71", "isVoided": "0", "dateDeposited": "2024-10-23", "dateTimeCreated": "2026-11-12 07:48:39" } } ``` ### deposit_update_400 Deposit not found, invalid input, or model validation failure. - `application/json`: one of several shapes - One of: - Option 1: object - `error` (string, required) - Option 2: object Example: ```json { "error": "Deposit 9999 not found" } ``` ### lease_transaction_modify_403 Forbidden. The API key's role lacks the **Modify Lease Transactions** permission (`Accounting` › `ModifyLeaseTransactions`), or the API user is restricted to portfolio groups and the lease isn't in one of them. - `application/json`: object - `error` (string, required, one of "Permission Denied", "Access Denied"): * `Permission Denied` - the role lacks the permission * `Access Denied` - the lease is outside the API user's portfolio groups Example: ```json { "error": "Permission Denied" } ``` ### lease_transaction_void_403 Forbidden. The API key's role lacks the **Void Lease Transactions** permission (`Accounting` › `VoidLeaseTransactions`), or the API user is restricted to portfolio groups and the lease isn't in one of them. - `application/json`: object - `error` (string, required, one of "Permission Denied", "Access Denied"): * `Permission Denied` - the role lacks the permission * `Access Denied` - the lease is outside the API user's portfolio groups Example: ```json { "error": "Permission Denied" } ``` ### journal_entry_400 The journal entry wasn't saved. Three shapes: one `error` (an empty body, an unexpected error); a bare `ledgerID` message when the ledger is missing or doesn't exist; or a map of validation messages, keyed by the field (`transactionID` for the lines as a whole, `entries[].accountID` for one line (`` counts from 0), `journalEntry.` for the entry, `debitEntry.` or `creditEntry.` for a line's account). - `application/json`: any of several shapes - Any of: - One message: object - `error` (string, required): Why the request was refused. - Ledger message: object - `ledgerID` (string, required, one of "Ledger is Required", "Ledger is Invalid"): The `ledgerID` is missing (`Ledger is Required`) or names no ledger (`Ledger is Invalid`). - Validation messages: object Example: ```json { "error": "invalid input." } ``` ### unit_update_200 The updated unit - `application/json`: `unit_detail` Example: ```json { "unit": { "unitID": "82", "propertyID": "101", "propertyImageID": "1", "isActive": "1", "name": "Unit 1B", "address": "123 Main St", "streetNumber": "123", "streetName": "Main St", "address2": "Apt 4", "stateID": "FL", "city": "Springfield", "postalCode": "12345", "latitude": "40.71280000", "longitude": "-74.00600000", "addressValidationStatusID": "1", "addressValidationData": null, "rent": "1650.00", "deposit": "800.00", "size": null, "beds": "3", "fullBaths": "2", "halfBaths": "1", "leaseID": null, "propertyManagerID": null, "commercialSpaceTypeID": null, "isNonRevenue": "1", "nonRevenueTypeID": "1", "nonRevenueStartDate": "2026-04-23", "isUtilityBillingEnabled": "0", "filterDeliveryScheduleID": null, "filterDeliveryAddressTypeID": null, "filterDeliveryAddressID": null, "dateTimeCreated": "2026-11-08 07:44:20", "dateTimeModified": "2026-11-08 07:44:20", "dateTimeDeactivated": null, "isFromImport": "0", "importSourceKey": null, "leaseNotes": "Example note.", "entryInstructions": "Use the side gate", "vendorEntryInstructions": "Call ahead", "maintenanceNotes": "Example note." } } ``` ### unit_update_400 `{"error": "invalid input."}` for an empty body or `{}`; `{"error": "Unit {unitID} not found"}`; a map of field to messages for a validation failure; `{"propertyManagerID": [...]}` alone when the deprecated `propertyManagerID` is changed, since that check runs before the others; `{"error": ""}` for any other error raised while saving. - `application/json`: object - `error` (string) Example: ```json { "error": "invalid input." } ``` ### unit_update_403 The API user's role lacks **Update Property** (`Properties` › `UpdateProperty`), or the unit's property is outside the API user's portfolio groups. - `application/json`: object - `error` (string, required) Example: ```json { "error": "Permission Denied" } ``` ### lease_pet_400 Bad request: the request was refused. The body is one message, `{"error": ""}`, or a map of validation messages by field (each value a list), with the shapes of the shared 400. - `application/json`: `schema` Example: ```json { "error": "Pet 999999999 not found" } ``` ### error_429 Too Many Requests: a rate limit refused the request ([Rate Limits](https://docs.rentvine.com/#tag/Rate-Limits)). The request wasn't run. Wait the `Retry-After` seconds, then send it again. Recognise the response by its status and `Retry-After`. - `application/json`: object - `code` (string, required, one of "429"): Always the string `'429'`. - `error` (string, required, one of "Too Many Requests") - `message` (string, required, one of "Rate limit exceeded."): The same text for every limit; the headers say which limit refused the request. Example: ```json { "code": "429", "error": "Too Many Requests", "message": "Rate limit exceeded." } ``` ## Schemas ### ledger_types * `1` - Manager * `2` - Portfolio * `3` - Property * `4` - Unit ### ledger - `ledgerID` (string, required, read-only, pattern `^-?[0-9]+$`): The ledger's ID. - `ledgerTypeID` (`ledger_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): The record the ledger belongs to, by `ledgerTypeID`: the portfolio ID (`2`), the property ID (`3`) or the unit ID (`4`). For the manager ledger (`1`) it doesn't name a record you can look up. - `name` (string, required): The ledger's name, as the search matches it. - `isActive` (string, required, one of "1"): Always `"1"` here, since only active ledgers are listed. ### account - `accountID` (string, required, read-only, pattern `^-?[0-9]+$`) - `parentAccountID` (string | null, pattern `^-?[0-9]+$`) - `accountTypeID` (string, required, pattern `^-?[0-9]+$`) - `accountCategoryID` (string | null, pattern `^-?[0-9]+$`) - `number` (string, required) - `name` (string, required) - `isActive` (string, required, one of "0", "1") - `isSubjectToManagementFees` (string, required, one of "0", "1") - `isSubjectToLateFees` (string, required, one of "0", "1") - `isDeposit` (string, required, one of "0", "1") - `isEscrow` (string, required, one of "0", "1") - `isRent` (string, required, one of "0", "1") - `isTaxable` (string, required, one of "0", "1") - `isSubjectToSalesTax` (string, required, one of "0", "1") - `isPrepayment` (string, required, one of "0", "1") - `isManagementFee` (string, required, one of "0", "1") - `isBudgetEnabled` (string, required, one of "0", "1") - `isHeld` (string, required, one of "0", "1") - `bankName` (string | null) - `bankAccountTypeID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountCiphertextID` (string | null, pattern `^-?[0-9]+$`) - `bankAccountNumberTruncated` (string | null) - `bankAccountAddress` (string | null) - `bankAccountAddress2` (string | null) - `bankAccountCity` (string | null) - `bankAccountStateID` (string | null) - `bankAccountPostalCode` (string | null) - `bankAccountCountryID` (string | null) - `isCheckingEnabled` (string, required, one of "0", "1") - `checkCompanyName` (string | null) - `checkSignatory` (string | null) - `checkAddress` (string | null) - `checkAddress2` (string | null) - `checkCity` (string | null) - `checkStateID` (string | null) - `checkPostalCode` (string | null) - `checkCountryID` (string | null) - `bankAccountNextCheckNumber` (string | null) - `bankAccountNextDepositNumber` (string | null) - `checkTemplateID` (string | null, pattern `^-?[0-9]+$`) - `creditCardGatewayID` (string | null, pattern `^-?[0-9]+$`) - `achGatewayID` (string | null, pattern `^-?[0-9]+$`) - `cashCardGatewayID` (string | null, pattern `^-?[0-9]+$`) - `remoteCheckGatewayID` (string | null, pattern `^-?[0-9]+$`) - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null) - `isNachaEnabled` (string, required, one of "0", "1") - `isNachaFileBalanced` (string | null, one of "0", "1", null) - `nachaOriginName` (string | null) - `nachaOriginNumber` (string | null) - `nachaDestinationName` (string | null) - `nachaDestinationNumber` (string | null) - `nachaCompanyIdentification` (string | null) - `nachaCompanyName` (string | null) - `nachaOriginatingFinancialInstitutionID` (string | null) - `nachaAdapterID` (string | null, pattern `^-?[0-9]+$`) - `isBillApprovalExempt` (string, one of "0", "1"): `0` = not exempt, `1` = exempt from bill approval. - `exportInvoiceServiceName` (string | null): Name of the external service used for invoice export, if any. - `isSubjectToMarkup` (string, one of "0", "1"): `0` = not subject to markup, `1` = subject to markup. - `isSubsidized` (string, one of "0", "1"): `0` = not subsidized, `1` = subsidized. - `depositTypeID` (string | null, pattern `^-?[0-9]+$`): Deposit type classification ID, or null if not applicable. - `dateTimeCreated` (string, read-only): Timestamp when the account record was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Timestamp when the account record was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Timestamp when the account was deactivated, or null if still active. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### account_types_request * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense ### account_flag_request A yes/no flag, `1` for yes and `0` for no. ### deposit_types_request * `1` - General * `2` - Pet * `3` - Cleaning * `4` - Key * `200` - Other ### bank_account_types_request * `1` - Savings * `2` - Checking ### account_create A new chart-of-accounts account: the fields to send. The create has no allow-list, so a key matching another account column is stored too (`isActive` and the timestamps are overwritten; send nothing else). Fields the account's type doesn't keep are cleared when it saves, whatever the request sends, and flags left out take their default (see Business Rules). `{}` counts as an empty body. - `accountTypeID` (`account_types_request`, required): The account type. It can't be changed later, and it decides which other fields the account keeps. * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `parentAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Parent account, for a sub-account: an account of the same type, from `GET /accounting/accounts`. - `accountCategoryID` (string | integer | null, pattern `^-?[0-9]+$`): Account category, one of the same account type, from `GET /accounting/account-categories` (undocumented). - `number` (string, required, max length 10): Chart-of-accounts number, unique among accounts with the same parent. - `name` (string, required, max length 100): Display name. - `isSubjectToManagementFees` (`account_flag_request`): Whether charges posted to the account are subject to management fees. Default `0`. - `isSubjectToLateFees` (`account_flag_request`): Whether charges posted to the account are subject to late fees. Default `0`. - `isDeposit` (`account_flag_request`): Whether the account tracks security deposits. Can't be combined with `isPrepayment`. Default `0`. - `depositTypeID` (one of several shapes): Deposit type, for a deposit account. When `isDeposit` is `1` and no type is set, `1` (General). Turning `isDeposit` off doesn't clear it. * `1` - General * `2` - Pet * `3` - Cleaning * `4` - Key * `200` - Other - One of: - Option 1: `deposit_types_request` - Option 2: null - `isEscrow` (`account_flag_request`): Whether the account holds escrow funds. Default `0`. - `isRent` (`account_flag_request`): Whether the account is classified as rent. Default `0`. - `isSubsidized` (`account_flag_request`): Whether the account is subsidized. Default `0`. - `isTaxable` (`account_flag_request`): Whether charges to the account are taxable. Default `0`. - `isSubjectToSalesTax` (`account_flag_request`): Whether charges to the account are subject to sales tax. Default `0`. - `isSubjectToMarkup` (`account_flag_request`): Whether charges to the account can be marked up. Default `1`. - `isPrepayment` (`account_flag_request`): Whether the account holds prepayments. Can't be combined with `isDeposit`. Default `0`. - `isManagementFee` (`account_flag_request`): Whether the account represents a management fee. Default `0`. - `isBudgetEnabled` (`account_flag_request`): Whether budget tracking is on for the account. Default `0`. - `isHeld` (`account_flag_request`): Whether funds in the account are held. Default `1` where the account's type keeps it. - `bankName` (string | null, max length 100): Bank name (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountTypeID` (one of several shapes): Savings or checking (bank accounts). Required when `isCheckingEnabled` is `1`. * `1` - Savings * `2` - Checking - One of: - Option 1: `bank_account_types_request` - Option 2: null - `bankAccountAddress` (string | null, max length 100): Bank's address, line 1 (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountAddress2` (string | null, max length 100): Bank's address, line 2 (bank accounts). - `bankAccountCity` (string | null, max length 100): Bank's city (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountStateID` (string | null): Bank's state or province code (bank accounts), as `GET /states` (undocumented) lists it for the country. Required when `isCheckingEnabled` is `1`. - `bankAccountPostalCode` (string | null, max length 20): Bank's postal code (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountCountryID` (string | null): Bank's country code, from `GET /countries` (undocumented). `US` when a state is sent without a country, and cleared when no state is sent. - `bankAccountNextDepositNumber` (string | null, max length 25): Next deposit number (bank accounts). - `bankAccountNextCheckNumber` (string | null, max length 25): Next check number (bank accounts). - `isCheckingEnabled` (`account_flag_request`): Whether the account prints checks (bank accounts). Makes the bank and check fields required. Default `0`. - `checkCompanyName` (string | null, max length 100): Name printed on checks. Required when `isCheckingEnabled` is `1`. - `checkSignatory` (string | null, max length 100): Signatory printed on checks. See Side Effects for what a change does to remote check printing. - `checkAddress` (string | null, max length 100): Address printed on checks, line 1. Required when `isCheckingEnabled` is `1`. - `checkAddress2` (string | null, max length 100): Address printed on checks, line 2. - `checkCity` (string | null, max length 100): City printed on checks. Required when `isCheckingEnabled` is `1`. - `checkStateID` (string | null): State printed on checks, as `GET /states` (undocumented) lists it. Required when `isCheckingEnabled` is `1`. - `checkPostalCode` (string | null, max length 20): Postal code printed on checks. Required when `isCheckingEnabled` is `1`. - `checkCountryID` (string | null): Country printed on checks; `US` when a state is sent without a country, cleared when no state is sent. - `checkTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): Check template, from `GET /checks/templates` (undocumented). Required when `isCheckingEnabled` is `1`. - `isNachaEnabled` (`account_flag_request`): Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. Default `0`. - `isNachaFileBalanced` (`account_flag_request`): Whether the account's NACHA files are balanced. Default `1`; set to `0` when NACHA is off. - `nachaOriginName` (string | null, max length 100): NACHA immediate origin name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaOriginNumber` (string | null, max length 20): NACHA immediate origin number. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaDestinationName` (string | null, max length 100): NACHA immediate destination name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaDestinationNumber` (string | null, max length 20): NACHA immediate destination number. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaCompanyIdentification` (string | null, max length 20): NACHA company identification. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaCompanyName` (string | null, max length 100): NACHA company name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaOriginatingFinancialInstitutionID` (string | null, max length 20): NACHA originating financial institution. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaAdapterID` (string | integer | null, pattern `^-?[0-9]+$`): NACHA file format: `1` Standard, `2` Chase, `3` Owner Funds. Not validated: any other value is stored and read as `1`. - `isBillApprovalExempt` (`account_flag_request`): Whether bills posted to the account skip bill approval. Default `0`. - `exportInvoiceServiceName` (string | null, max length 100): Service name used when exporting invoices for the account. - `isFromImport` (`account_flag_request`): Whether the account came from an import. Default `0`. Send `importSourceKey` with it; the API doesn't require it. - `importSourceKey` (string | null): The import's key for the account, unique among imported accounts. Kept only when `isFromImport` is `1`; with `isFromImport` `1` and no key, the account is created with a null key. - `creditCardGatewayID` (string | integer | null, pattern `^-?[0-9]+$`): Credit card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. - `achGatewayID` (string | integer | null, pattern `^-?[0-9]+$`): ACH gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. - `cashCardGatewayID` (string | integer | null, pattern `^-?[0-9]+$`): Cash card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. - `remoteCheckGatewayID` (string | integer | null, pattern `^-?[0-9]+$`): Remote check printing gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. - `bankAccount` (object): The bank account's routing and account numbers. Required when `accountTypeID` is `3` (Bank), and ignored for every other type. They are stored encrypted; responses carry only `bankAccountNumberTruncated` (the account number's last 4 digits). - `routingNumber` (string, required): The routing number: digits only, checked by the routing-number rule of the property manager's country. For the US that is the 3-7-1 checksum alone, not the length (`123` passes); for Canada, 9 digits starting with `0`. - `accountNumber` (string, required): The account number. ### account_types * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense ### deposit_types * `1` - General * `2` - Pet * `3` - Cleaning * `4` - Key * `200` - Other ### bank_account_types * `1` - Savings * `2` - Checking ### account-2 A chart-of-accounts account: every column of the account row. Accounts define how money is categorized across the accounting system (income, expense, deposits, escrow, bank accounts); every charge, bill and journal entry line posts against one. The bank, check-printing and NACHA fields are filled only on bank accounts: every other account type clears them when it is saved. - `accountID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the account. - `parentAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the parent account for sub-accounts, if any. - `accountTypeID` (`account_types`, required): The account type. It decides which other fields the account keeps: see each operation's Business Rules. * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `accountCategoryID` (string | null, required, pattern `^-?[0-9]+$`): ID of the account category, if assigned. - `number` (string, required, max length 10): Chart-of-accounts number. - `name` (string, required, max length 100): Display name of the account. - `isActive` (string, required, one of "0", "1"): Whether the account is active (`1` = active, `0` = inactive). - `isSubjectToManagementFees` (string, required, one of "0", "1"): Whether charges posted to this account are subject to management fees (`1` = yes, `0` = no). - `isSubjectToLateFees` (string, required, one of "0", "1"): Whether charges posted to this account are subject to late fees (`1` = yes, `0` = no). - `isDeposit` (string, required, one of "0", "1"): Whether this account is a deposit account (`1` = yes, `0` = no). - `depositTypeID` (one of several shapes, required): Deposit type: set when `isDeposit` is `1` (General when none is sent), null on types that clear `isDeposit`. An update that turns `isDeposit` off leaves it as it was. * `1` - General * `2` - Pet * `3` - Cleaning * `4` - Key * `200` - Other - One of: - Option 1: `deposit_types` - Option 2: null - `isEscrow` (string, required, one of "0", "1"): Whether this account holds escrow funds (`1` = yes, `0` = no). - `isRent` (string, required, one of "0", "1"): Whether this account is classified as rent (`1` = yes, `0` = no). - `isSubsidized` (string, required, one of "0", "1"): Whether this account is subsidized (`1` = yes, `0` = no). - `isTaxable` (string, required, one of "0", "1"): Whether charges to this account are taxable (`1` = yes, `0` = no). - `isSubjectToSalesTax` (string, required, one of "0", "1"): Whether charges are subject to sales tax (`1` = yes, `0` = no). - `isSubjectToMarkup` (string, required, one of "0", "1"): Whether charges to this account can be marked up (`1` = yes, `0` = no). - `isPrepayment` (string, required, one of "0", "1"): Whether this account is for prepayments (`1` = yes, `0` = no). - `isManagementFee` (string, required, one of "0", "1"): Whether this account represents a management fee (`1` = yes, `0` = no). - `isBudgetEnabled` (string, required, one of "0", "1"): Whether budget tracking is enabled for this account (`1` = yes, `0` = no). - `isHeld` (string, required, one of "0", "1"): Whether funds in this account are held (`1` = yes, `0` = no). - `bankName` (string | null, required, max length 100): Bank name for bank-type accounts, otherwise null. - `bankAccountTypeID` (one of several shapes, required): Savings or checking, for a bank account; otherwise null. * `1` - Savings * `2` - Checking - One of: - Option 1: `bank_account_types` - Option 2: null - `bankAccountCiphertextID` (string | null, required, read-only, pattern `^-?[0-9]+$`): ID of the stored, encrypted copy of a bank account's routing and account numbers, or null when none is stored. The numbers themselves never appear in this response. - `bankAccountNumberTruncated` (string | null, required, read-only, max length 4): Last 4 digits of a bank account's account number, or null when none is stored. - `bankAccountAddress` (string | null, required, max length 100): Bank account mailing address line 1. - `bankAccountAddress2` (string | null, required, max length 100): Bank account mailing address line 2. - `bankAccountCity` (string | null, required, max length 100): Bank account mailing city. - `bankAccountStateID` (string | null, required, max length 3): Bank account mailing state code. - `bankAccountPostalCode` (string | null, required, max length 20): Bank account mailing postal code. - `bankAccountCountryID` (string | null, required, max length 3): Bank account mailing country code. - `isCheckingEnabled` (string, required, one of "0", "1"): Whether check printing is enabled for this account (`1` = yes, `0` = no). - `checkCompanyName` (string | null, required, max length 100): Company name printed on checks, if check printing is enabled. - `checkSignatory` (string | null, required, max length 100): Signatory name printed on checks. - `checkAddress` (string | null, required, max length 100): Check mailing address line 1. - `checkAddress2` (string | null, required, max length 100): Check mailing address line 2. - `checkCity` (string | null, required, max length 100): Check mailing city. - `checkStateID` (string | null, required, max length 3): Check mailing state code. - `checkPostalCode` (string | null, required, max length 20): Check mailing postal code. - `checkCountryID` (string | null, required, max length 3): Check mailing country code. - `bankAccountNextCheckNumber` (string | null, required, max length 25): Next check number for this bank account. - `bankAccountNextDepositNumber` (string | null, required, max length 25): Next deposit number for this bank account. - `checkTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the check template assigned to this account. - `creditCardGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the credit card payment gateway associated with this account. - `achGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the ACH payment gateway associated with this account. - `cashCardGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the cash card gateway associated with this account. - `remoteCheckGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the remote check gateway associated with this account. - `isFromImport` (string, required, one of "0", "1"): Whether this account was created via import (`1` = yes, `0` = no). - `importSourceKey` (string | null, required, max length 100): Import source key if the account came from an import, otherwise null. - `isNachaEnabled` (string, required, one of "0", "1"): Whether NACHA (ACH) is enabled for this account (`1` = yes, `0` = no). - `isNachaFileBalanced` (string | null, required, one of "0", "1", null): Whether the account's NACHA files are balanced (`1` = yes, `0` = no); `0` when NACHA is off. - `nachaOriginName` (string | null, required, max length 100): NACHA origination company name. - `nachaOriginNumber` (string | null, required, max length 20): NACHA origination routing/transit number. - `nachaDestinationName` (string | null, required, max length 100): NACHA destination institution name. - `nachaDestinationNumber` (string | null, required, max length 20): NACHA destination routing/transit number. - `nachaCompanyIdentification` (string | null, required, max length 20): NACHA company identification number. - `nachaCompanyName` (string | null, required, max length 100): NACHA company name in batch headers. - `nachaOriginatingFinancialInstitutionID` (string | null, required, max length 20): ID of the originating financial institution for NACHA. - `nachaAdapterID` (string | null, required, pattern `^-?[0-9]+$`): NACHA file format the account's payout files use, or null for the standard format. Not validated: a value other than these is stored and read as `1`. * `1` - Standard * `2` - Chase * `3` - Owner Funds - `isBillApprovalExempt` (string, required, one of "0", "1"): Whether bills posted to this account are exempt from approval (`1` = yes, `0` = no). - `exportInvoiceServiceName` (string | null, required, max length 100): Service name used when exporting invoices for this account. - `dateTimeCreated` (string, required, read-only): Timestamp when the account was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the account was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): Timestamp when the account was deactivated, or null if still active. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### account_category An account category: a named group of chart-of-accounts accounts of one account type, used to group accounts on reports. - `accountCategoryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the account category. - `accountTypeID` (`account_types`, required): The account type of every account in the category. * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `name` (string, required, max length 100): Display name of the category. ### check_stock_types * `1` - Top * `2` - Middle * `3` - Bottom * `4` - Three Per Page ### check_detail_print_types * `1` - Truncated * `2` - Print All ### check_template A check template: the check stock layout a bank account prints its checks with (where the check sits on the page, print offsets, and how much payment detail the stub prints). - `checkTemplateID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the check template. - `name` (string, required, max length 100): Display name of the template. - `printOffsetX` (string, decimal, required): Horizontal offset the template applies when printing. - `printOffsetY` (string, decimal, required): Vertical offset the template applies when printing. - `checkStockTypeID` (`check_stock_types`, required): Where the check sits on the page of check stock. * `1` - Top * `2` - Middle * `3` - Bottom * `4` - Three Per Page - `checkDetailPrintTypeID` (`check_detail_print_types`, required): Whether the stub prints every paid item or a truncated list. * `1` - Truncated * `2` - Print All - `elements` (string | null, required): The template's element layout, as a JSON string (not decoded). ### reconciliation_versions * `1` - All Time Adjusted Balance * `2` - Period Adjusted Balance ### included_reconciliation A bank reconciliation, as an include returns it: every column of the reconciliation row. A reconciliation matches a bank account's entries against one bank statement; its totals are decimal strings. - `reconciliationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the reconciliation record. - `reconciliationVersionID` (`reconciliation_versions`, required): Version identifier for the reconciliation. * `1` - All Time Adjusted Balance * `2` - Period Adjusted Balance - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The bank account this reconciliation belongs to. - `statementStartDate` (string, date, required): Start date of the bank statement period. - `statementEndDate` (string, date, required): End date of the bank statement period. - `statementEndingBalance` (string, decimal, required): Ending balance from the bank statement. - `isCurrent` (string, required, one of "0", "1"): `1` = this is the current active reconciliation, `0` = historical. - `isVoided` (string, required, one of "0", "1"): `1` = reconciliation has been voided. - `previousStatementEndingBalance` (string, decimal, required): Ending balance from the previous statement period. - `moneyInTotal` (string, decimal, required): Total money-in (credits) for the period. - `moneyOutTotal` (string, decimal, required): Total money-out (debits) for the period. - `reconciledMoneyInTotal` (string, decimal, required): Total reconciled credits for the period. - `reconciledMoneyOutTotal` (string, decimal, required): Total reconciled debits for the period. - `unreconciledMoneyInTotal` (string, decimal, required): Total unreconciled credits remaining. - `unreconciledMoneyOutTotal` (string, decimal, required): Total unreconciled debits remaining. - `reconciledBalance` (string, decimal, required): Net reconciled balance (credits minus debits). - `adjustedCashBalance` (string, decimal, required): Adjusted cash balance after reconciliation adjustments. - `bankAccountBalance` (string, decimal, required): Current bank account balance as of the statement end date. - `undepositedPaymentsBalance` (string, decimal, required): Total value of payments not yet deposited. - `paymentsDepositedAfterStatementEndDateBalance` (string, decimal, required): Payments deposited after the statement end date. - `unsettledElectronicTransactionsBalance` (string, decimal, required): Balance of electronic transactions not yet settled. - `electronicTransactionsSettledAfterStatementEndDateBalance` (string, decimal, required): Electronic transactions settled after the statement end date. - `adjustmentsTotal` (string, decimal, required): Total value of all reconciliation adjustments. - `reconciledAdjustmentsTotal` (string, decimal, required): Total value of reconciled adjustments. - `unreconciledAdjustmentsTotal` (string, decimal, required): Total value of unreconciled adjustments. - `bankAdjustmentBalance` (string, decimal, required): Net bank adjustment balance. - `bankAccountUndepositedBalance` (string, decimal, required): Undeposited balance in the bank account. - `unsettledPaymentBalance` (string, decimal, required): Balance of unsettled incoming payments. - `unsettledPaymentReturnBalance` (string, decimal, required): Balance of unsettled returned payments. - `unsettledPayoutBalance` (string, decimal, required): Balance of unsettled outgoing payouts. - `unsettledPayoutReturnBalance` (string, decimal, required): Balance of unsettled returned payouts. - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user who created this reconciliation (`GET /users` (undocumented) lists the account's users). - `dateTimeCreated` (string, required, read-only): When the reconciliation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### reconciliation_placeholder The placeholder an account with no current reconciliation gets: never saved, so `reconciliationID` and every other key but `bankAccountID` and `statementEndingBalance` is null. - `reconciliationID` (null, required): Always null (the placeholder was never saved). - `reconciliationVersionID` (null, required): Always null (the placeholder was never saved). - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The account's ID. - `statementStartDate` (null, required): Always null (the placeholder was never saved). - `statementEndDate` (null, required): Always null (the placeholder was never saved). - `statementEndingBalance` (number, required, one of 0): Always `0`, as a JSON number. - `isCurrent` (null, required, one of null): Always null (the placeholder was never saved). - `isVoided` (null, required, one of null): Always null (the placeholder was never saved). - `previousStatementEndingBalance` (null, required): Always null (the placeholder was never saved). - `moneyInTotal` (null, required): Always null (the placeholder was never saved). - `moneyOutTotal` (null, required): Always null (the placeholder was never saved). - `reconciledMoneyInTotal` (null, required): Always null (the placeholder was never saved). - `reconciledMoneyOutTotal` (null, required): Always null (the placeholder was never saved). - `unreconciledMoneyInTotal` (null, required): Always null (the placeholder was never saved). - `unreconciledMoneyOutTotal` (null, required): Always null (the placeholder was never saved). - `reconciledBalance` (null, required): Always null (the placeholder was never saved). - `adjustedCashBalance` (null, required): Always null (the placeholder was never saved). - `bankAccountBalance` (null, required): Always null (the placeholder was never saved). - `undepositedPaymentsBalance` (null, required): Always null (the placeholder was never saved). - `paymentsDepositedAfterStatementEndDateBalance` (null, required): Always null (the placeholder was never saved). - `unsettledElectronicTransactionsBalance` (null, required): Always null (the placeholder was never saved). - `electronicTransactionsSettledAfterStatementEndDateBalance` (null, required): Always null (the placeholder was never saved). - `adjustmentsTotal` (null, required): Always null (the placeholder was never saved). - `reconciledAdjustmentsTotal` (null, required): Always null (the placeholder was never saved). - `unreconciledAdjustmentsTotal` (null, required): Always null (the placeholder was never saved). - `bankAdjustmentBalance` (null, required): Always null (the placeholder was never saved). - `bankAccountUndepositedBalance` (null, required): Always null (the placeholder was never saved). - `unsettledPaymentBalance` (null, required): Always null (the placeholder was never saved). - `unsettledPaymentReturnBalance` (null, required): Always null (the placeholder was never saved). - `unsettledPayoutBalance` (null, required): Always null (the placeholder was never saved). - `unsettledPayoutReturnBalance` (null, required): Always null (the placeholder was never saved). - `createdByUserID` (null, required): Always null (the placeholder was never saved). - `dateTimeCreated` (null, required): Always null (the placeholder was never saved). ### account_detail One chart-of-accounts account, with the includes the request asked for. `GET /accounting/accounts/{accountID}` answers with it, and so do the account create and update, which read the account back the same way. - `account` (`account-2`, required) - `accountCategory` (one of several shapes): The account's category, or null when it has none. Requires the `accountCategory` include. - One of: - Option 1: `account_category` - Option 2: null - `checkTemplate` (one of several shapes): The check template the account prints checks with, or null when it has none (or the template no longer exists). Requires the `checkTemplate` include. - One of: - Option 1: `check_template` - Option 2: null - `currentReconciliation` (one of several shapes): The account's current reconciliation: the one marked current that isn't voided (the latest by statement end date if there are several). An account with none (any account that isn't a reconciled bank account) gets a placeholder that was never saved: `bankAccountID` and a `statementEndingBalance` of `0` (a JSON number), every other key `null`. Requires the `currentReconciliation` include. - One of: - Option 1: `included_reconciliation` - Option 2: `reconciliation_placeholder` - `unprintedCheckCount` (integer, minimum 0): How many check payouts from this account still wait to be printed: not voided, never printed, in an approved payout batch (the checks the Print Checks screen lists). A JSON number. Requires the `unprintedCheckCount` include. - `positivePayGateway` (one of several shapes): The account's positive pay gateway (the service the bank checks issued checks against), or null when it has none. Its IDs and flags are JSON numbers, unlike the rest of the response. Requires the `positivePayGateway` include. - One of: - Option 1: object - `gatewayID` (integer, required, one of 1): The positive pay provider. * `1` - Enterprise - `positivePayGatewayID` (integer, required): Unique identifier for the gateway. - `bankAccountID` (integer, required): The bank account (the account in this response). - `name` (string, required, max length 100): Display name of the gateway. - `isActive` (integer, required, one of 0, 1): Whether the gateway is active (`1` = yes, `0` = no). - `dateTimeCreated` (string, required): When the gateway was set up. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required): When the gateway was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - Option 2: null ### account_update The account fields an update may change. Every field is optional: send only what changes. Keys outside this list (`accountID`, `isActive`, `isFromImport`, `importSourceKey`, the gateway IDs, the stored bank numbers) are ignored; `accountTypeID` is listed because the API reads it, but any change to it is refused. `{}` counts as an empty body. Fields the account's type doesn't keep are cleared when it saves, whatever the request sends (see Business Rules). - `accountTypeID` (`account_types_request`): The account's current type. Another type is refused (`Cannot change the account type`); a value that isn't an account type answers 400 with an `error` (`State class not defined for this account type`), and `null` with `Account type is required to create the account state`. * `1` - Accounts Receivable * `2` - Accounts Payable * `3` - Bank * `4` - Asset * `5` - Liability * `6` - Equity * `7` - Income * `8` - Other Income * `9` - Expense * `10` - Other Expense - `parentAccountID` (string | integer | null, pattern `^-?[0-9]+$`): Parent account, for a sub-account, from `GET /accounting/accounts`: not the account itself, and not one of its own sub-accounts. Use one of the same type: the create checks it, the update doesn't. - `accountCategoryID` (string | integer | null, pattern `^-?[0-9]+$`): Account category, one of the same account type, from `GET /accounting/account-categories` (undocumented). - `number` (string, max length 10): Chart-of-accounts number, unique among accounts with the same parent. - `name` (string, max length 100): Display name. - `isSubjectToManagementFees` (`account_flag_request`): Whether charges posted to the account are subject to management fees. - `isSubjectToLateFees` (`account_flag_request`): Whether charges posted to the account are subject to late fees. - `isDeposit` (`account_flag_request`): Whether the account tracks security deposits. Can't be combined with `isPrepayment`. - `depositTypeID` (one of several shapes): Deposit type, for a deposit account. When `isDeposit` is `1` and no type is set, `1` (General). Turning `isDeposit` off doesn't clear it. * `1` - General * `2` - Pet * `3` - Cleaning * `4` - Key * `200` - Other - One of: - Option 1: `deposit_types_request` - Option 2: null - `isEscrow` (`account_flag_request`): Whether the account holds escrow funds. - `isRent` (`account_flag_request`): Whether the account is classified as rent. - `isSubsidized` (`account_flag_request`): Whether the account is subsidized. - `isTaxable` (`account_flag_request`): Whether charges to the account are taxable. - `isSubjectToSalesTax` (`account_flag_request`): Whether charges to the account are subject to sales tax. - `isSubjectToMarkup` (`account_flag_request`): Whether charges to the account can be marked up. - `isPrepayment` (`account_flag_request`): Whether the account holds prepayments. Can't be combined with `isDeposit`. - `isManagementFee` (`account_flag_request`): Whether the account represents a management fee. - `isBudgetEnabled` (`account_flag_request`): Whether budget tracking is on for the account. - `isHeld` (`account_flag_request`): Whether funds in the account are held. - `bankName` (string | null, max length 100): Bank name (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountTypeID` (one of several shapes): Savings or checking (bank accounts). Required when `isCheckingEnabled` is `1`. * `1` - Savings * `2` - Checking - One of: - Option 1: `bank_account_types_request` - Option 2: null - `bankAccountAddress` (string | null, max length 100): Bank's address, line 1 (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountAddress2` (string | null, max length 100): Bank's address, line 2 (bank accounts). - `bankAccountCity` (string | null, max length 100): Bank's city (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountStateID` (string | null): Bank's state or province code (bank accounts), as `GET /states` (undocumented) lists it for the country. Required when `isCheckingEnabled` is `1`. - `bankAccountPostalCode` (string | null, max length 20): Bank's postal code (bank accounts). Required when `isCheckingEnabled` is `1`. - `bankAccountCountryID` (string | null): Bank's country code, from `GET /countries` (undocumented). `US` when a state is sent without a country. - `bankAccountNextDepositNumber` (string | null, max length 25): Next deposit number (bank accounts). - `bankAccountNextCheckNumber` (string | null, max length 25): Next check number (bank accounts). - `isCheckingEnabled` (`account_flag_request`): Whether the account prints checks (bank accounts). Makes the bank and check fields required. - `checkCompanyName` (string | null, max length 100): Name printed on checks. Required when `isCheckingEnabled` is `1`. - `checkSignatory` (string | null, max length 100): Signatory printed on checks. See Side Effects for what a change does to remote check printing. - `checkAddress` (string | null, max length 100): Address printed on checks, line 1. Required when `isCheckingEnabled` is `1`. - `checkAddress2` (string | null, max length 100): Address printed on checks, line 2. - `checkCity` (string | null, max length 100): City printed on checks. Required when `isCheckingEnabled` is `1`. - `checkStateID` (string | null): State printed on checks, as `GET /states` (undocumented) lists it. Required when `isCheckingEnabled` is `1`. - `checkPostalCode` (string | null, max length 20): Postal code printed on checks. Required when `isCheckingEnabled` is `1`. - `checkCountryID` (string | null): Country printed on checks; `US` when a state is sent without a country. - `checkTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): Check template, from `GET /checks/templates` (undocumented). Required when `isCheckingEnabled` is `1`. - `isNachaEnabled` (`account_flag_request`): Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. - `isNachaFileBalanced` (`account_flag_request`): Whether the account's NACHA files are balanced. Set to `0` when NACHA is off. - `nachaOriginName` (string | null, max length 100): NACHA immediate origin name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaOriginNumber` (string | null, max length 20): NACHA immediate origin number. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaDestinationName` (string | null, max length 100): NACHA immediate destination name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaDestinationNumber` (string | null, max length 20): NACHA immediate destination number. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaCompanyIdentification` (string | null, max length 20): NACHA company identification. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaCompanyName` (string | null, max length 100): NACHA company name. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaOriginatingFinancialInstitutionID` (string | null, max length 20): NACHA originating financial institution. Required when `isNachaEnabled` is `1`; cleared when it is `0`. - `nachaAdapterID` (string | integer | null, pattern `^-?[0-9]+$`): NACHA file format: `1` Standard, `2` Chase, `3` Owner Funds. Not validated: any other value is stored and read as `1`. - `isBillApprovalExempt` (`account_flag_request`): Whether bills posted to the account skip bill approval. - `exportInvoiceServiceName` (string | null, max length 100): Service name used when exporting invoices for the account. ### bill_base - `billBatchID` (string | integer | null, pattern `^-?[0-9]+$`) - `parentBillID` (string | integer | null, pattern `^-?[0-9]+$`) - `payeeContactID` (string | integer, required, pattern `^-?[0-9]+$`) - `billDate` (string, date, required) - `dateDue` (string, date, required) - `reference` (string | null) - `paymentMemo` (string | null) - `description` (string | null) - `workOrderID` (string | integer | null, pattern `^-?[0-9]+$`): The ID of a work order to associate with this bill. To tie a bill to a work order, first create the work order, then pass its `workOrderID` here. - `bankAccountID` (string | integer | null, pattern `^-?[0-9]+$`): The bank account to use for this bill. Only applicable when `overrideBankAccount` is `true`. - `serviceAccountNumber` (string | null) - `utilityPeriodStartDate` (string | null, date) - `utilityPeriodEndDate` (string | null, date) - `discountPercent` (string | number | null, decimal) - `markupPercent` (string | number | null, decimal) ### bill - All of: - Option 1: `bill_base` - Option 2: object - `billID` (string, required, read-only, pattern `^-?[0-9]+$`) - `billTypeID` (string, required, pattern `^-?[0-9]+$`) - `isVoided` (string, required, one of "0", "1"): `0` = not voided, `1` = voided. - `isApproved` (string, required, one of "0", "1"): `0` = pending approval, `1` = approved. - `approvedByUserID` (string | null, pattern `^-?[0-9]+$`): The user who approved the bill. - `managementFeeBatchID` (string | null, pattern `^-?[0-9]+$`) - `isDiscount` (string, required, one of "0", "1"): `0` = no discount, `1` = discount bill. - `isMarkup` (string, required, one of "0", "1"): `0` = no markup, `1` = markup bill. - `managementFeeMode` (string, required, pattern `^-?[0-9]+$`) - `propertyID` (string | null, pattern `^-?[0-9]+$`): The property associated with this bill, if any. - `utilityID` (string | null, pattern `^-?[0-9]+$`): The utility associated with this bill, if any. - `importAccountCommitID` (string | null, pattern `^-?[0-9]+$`): The import commit that created this bill, if applicable. ### bill_create - All of: - Option 1: `bill_base` - Option 2: object - `charges` (object[]): Line-item charges applied to ledger accounts. - `ledgerID` (string | integer, required, pattern `^-?[0-9]+$`): The ledger (property or owner) to charge. - `description` (string | null) - `chargeAccountID` (string | integer, required, pattern `^-?[0-9]+$`): The GL account for this charge line. - `amount` (string | number, decimal, required): Total amount for this charge line (decimal string). - `fromPayer` (number | null): Dollar amount charged from the payer. - `toPayee` (number | null): Dollar amount paid out to the payee. - `markupAmount` (string | number | null, decimal): Markup dollar amount applied to this charge. - `discountAmount` (string | number | null, decimal): Discount dollar amount applied to this charge. - `salesTaxAmount` (string | number, decimal): Sales tax amount (decimal string). - `leaseID` (string | integer | null, pattern `^-?[0-9]+$`): Lease to associate with this charge line, if any. - `leaseCharges` (object[]): Charges posted directly to lease ledgers (tenant-responsible amounts). - `leaseID` (string | integer, required, pattern `^-?[0-9]+$`): The lease to post this charge against. - `chargeAccountID` (string | integer, required, pattern `^-?[0-9]+$`): The GL account for this lease charge. - `datePosted` (string, date): Date the charge is posted to the lease ledger. - `amount` (string | number, decimal, required): Amount to post to the lease (decimal string). - `description` (string | null) - `tenantAmount` (number | null): The portion of the bill to be collected from the tenant. - `workOrderStatusID` (string | integer | null, pattern `^-?[0-9]+$`): The status to set on the linked work order when the bill is created. - `markupOverridePercentage` (string | null): Overrides the default markup percentage for this bill (decimal string). - `overrideBankAccount` (boolean): When `true`, the bill will be paid from the `bankAccountID` specified on this request. When `false` (or omitted), the bank account is determined by the payer's posting settings. ### bill_update Request body for updating an existing bill. All fields are optional — only the fields provided will be changed. Charges are identified by `transactionID`. - `payeeContactID` (string | integer, pattern `^-?[0-9]+$`): The ID of the payee contact (vendor) for this bill. - `billDate` (string, date): The date of the bill. - `dateDue` (string, date): The date the bill is due. - `amount` (string | number, decimal): Total bill amount. - `discountPercent` (string | number, decimal): Discount percentage applied to the bill. - `markupPercent` (string | number, decimal): Markup percentage applied to the bill. - `bankAccountID` (string | integer, pattern `^-?[0-9]+$`): The bank account used to pay this bill. - `reference` (string | null): External reference number (e.g. invoice number, check number). - `paymentMemo` (string | null): Memo to include with the payment. - `description` (string | null): Internal description for the bill. - `workOrderID` (string | integer | null, pattern `^-?[0-9]+$`): The ID of the work order to link to this bill. - `charges` (object[]): Charge lines to update on this bill. Each entry must include `transactionID` to identify the charge being updated. - `transactionID` (string | integer, required, pattern `^-?[0-9]+$`): The ID of the existing transaction to update. - `amount` (string | number, decimal, required): Updated charge amount (decimal string). - `discountAmount` (string | number, decimal): Discount amount for this charge line (decimal string). - `markupAmount` (string | number, decimal): Markup amount for this charge line (decimal string). - `ledgerID` (string | integer, pattern `^-?[0-9]+$`): The ledger (property or owner) to post this charge to. - `chargeAccountID` (string | integer, pattern `^-?[0-9]+$`): The GL account for this charge line. - `description` (string | null): Description for this charge line. - `serviceAccountNumber` (string | null): Utility service account number, if applicable. - `utilityPeriodStartDate` (string | null, date): Start date of the utility billing period. - `utilityPeriodEndDate` (string | null, date): End date of the utility billing period. ### deposit A bank deposit groups one or more payment transactions (and bulk payments) into a single deposited amount that can be reconciled against a bank statement. Deposits belong to a bank account and track their reconciliation state via `reconciliationID`. - `depositID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the deposit. - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The bank account this deposit belongs to. - `reconciliationID` (string | null, pattern `^-?[0-9]+$`): The reconciliation this deposit is linked to, or null if unreconciled. - `previousReconciliationID` (string | null, pattern `^-?[0-9]+$`): The previous reconciliation ID if the deposit was moved, or null. - `depositNumber` (string | null): A user-assigned reference number for the deposit. - `description` (string | null): Optional free-text description. - `amount` (string, decimal, required): Total deposited amount as a decimal string. - `isVoided` (string, required, one of "0", "1"): `0` = active, `1` = voided. - `dateDeposited` (string, date, required): The date the deposit was made. - `dateTimeCreated` (string, required, read-only): Timestamp when the deposit record was created (MySQL datetime format, e.g. "2021-04-14 13:40:48"). UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### reconciliation A bank reconciliation record that tracks the process of matching a bank account's ledger entries against a bank statement. All monetary totals are decimal strings. All fields are nullable because the reconciliation object is omitted or null when a deposit has not yet been reconciled. - `reconciliationID` (string | null, read-only, pattern `^-?[0-9]+$`): Unique identifier for the reconciliation record. - `reconciliationVersionID` (string | null, pattern `^-?[0-9]+$`): Version identifier for the reconciliation. - `bankAccountID` (string | null, pattern `^-?[0-9]+$`): The bank account this reconciliation belongs to. - `statementStartDate` (string | null, date): Start date of the bank statement period. - `statementEndDate` (string | null, date): End date of the bank statement period. - `statementEndingBalance` (string | null, decimal): Ending balance from the bank statement. - `isCurrent` (string | null, one of "0", "1", null): `1` = this is the current active reconciliation, `0` = historical. - `isVoided` (string | null, one of "0", "1", null): `1` = reconciliation has been voided. - `previousStatementEndingBalance` (string | null, decimal): Ending balance from the previous statement period. - `moneyInTotal` (string | null, decimal): Total money-in (credits) for the period. - `moneyOutTotal` (string | null, decimal): Total money-out (debits) for the period. - `reconciledMoneyInTotal` (string | null, decimal): Total reconciled credits for the period. - `reconciledMoneyOutTotal` (string | null, decimal): Total reconciled debits for the period. - `unreconciledMoneyInTotal` (string | null, decimal): Total unreconciled credits remaining. - `unreconciledMoneyOutTotal` (string | null, decimal): Total unreconciled debits remaining. - `reconciledBalance` (string | null, decimal): Net reconciled balance (credits minus debits). - `adjustedCashBalance` (string | null, decimal): Adjusted cash balance after reconciliation adjustments. - `bankAccountBalance` (string | null, decimal): Current bank account balance as of the statement end date. - `undepositedPaymentsBalance` (string | null, decimal): Total value of payments not yet deposited. - `paymentsDepositedAfterStatementEndDateBalance` (string | null, decimal): Payments deposited after the statement end date. - `unsettledElectronicTransactionsBalance` (string | null, decimal): Balance of electronic transactions not yet settled. - `electronicTransactionsSettledAfterStatementEndDateBalance` (string | null, decimal): Electronic transactions settled after the statement end date. - `adjustmentsTotal` (string | null, decimal): Total value of all reconciliation adjustments. - `reconciledAdjustmentsTotal` (string | null, decimal): Total value of reconciled adjustments. - `unreconciledAdjustmentsTotal` (string | null, decimal): Total value of unreconciled adjustments. - `bankAdjustmentBalance` (string | null, decimal): Net bank adjustment balance. - `bankAccountUndepositedBalance` (string | null, decimal): Undeposited balance in the bank account. - `unsettledPaymentBalance` (string | null, decimal): Balance of unsettled incoming payments. - `unsettledPaymentReturnBalance` (string | null, decimal): Balance of unsettled returned payments. - `unsettledPayoutBalance` (string | null, decimal): Balance of unsettled outgoing payouts. - `unsettledPayoutReturnBalance` (string | null, decimal): Balance of unsettled returned payouts. - `createdByUserID` (string | null, pattern `^-?[0-9]+$`): ID of the user who created this reconciliation. - `dateTimeCreated` (string | null, read-only): Timestamp when the reconciliation was created (MySQL datetime format, e.g. "2021-06-30 00:00:00"). UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### reconciliation_list_item A reconciliation as `GET /accounting/reconciliations` lists it: every column of the reconciliation row, as stored, plus the net of the single-transaction changes made to it since it was completed. - `reconciliationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the reconciliation record. - `reconciliationVersionID` (`reconciliation_versions`, required): Version identifier for the reconciliation. * `1` - All Time Adjusted Balance * `2` - Period Adjusted Balance - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The bank account this reconciliation belongs to. - `statementStartDate` (string, date, required): Start date of the bank statement period. - `statementEndDate` (string, date, required): End date of the bank statement period. - `statementEndingBalance` (string, decimal, required): Ending balance from the bank statement. - `isCurrent` (string, required, one of "0", "1"): `1` = this is the current active reconciliation, `0` = historical. - `isVoided` (string, required, one of "0", "1"): `1` = reconciliation has been voided. - `previousStatementEndingBalance` (string, decimal, required): Ending balance from the previous statement period. - `moneyInTotal` (string, decimal, required): Total money-in (credits) for the period. - `moneyOutTotal` (string, decimal, required): Total money-out (debits) for the period. - `reconciledMoneyInTotal` (string, decimal, required): Total reconciled credits for the period. - `reconciledMoneyOutTotal` (string, decimal, required): Total reconciled debits for the period. - `unreconciledMoneyInTotal` (string, decimal, required): Total unreconciled credits remaining. - `unreconciledMoneyOutTotal` (string, decimal, required): Total unreconciled debits remaining. - `reconciledBalance` (string, decimal, required): Net reconciled balance (credits minus debits). - `adjustedCashBalance` (string, decimal, required): Adjusted cash balance after reconciliation adjustments. - `bankAccountBalance` (string, decimal, required): Current bank account balance as of the statement end date. - `undepositedPaymentsBalance` (string, decimal, required): Total value of payments not yet deposited. - `paymentsDepositedAfterStatementEndDateBalance` (string, decimal, required): Payments deposited after the statement end date. - `unsettledElectronicTransactionsBalance` (string, decimal, required): Balance of electronic transactions not yet settled. - `electronicTransactionsSettledAfterStatementEndDateBalance` (string, decimal, required): Electronic transactions settled after the statement end date. - `adjustmentsTotal` (string, decimal, required): Total value of all reconciliation adjustments. - `reconciledAdjustmentsTotal` (string, decimal, required): Total value of reconciled adjustments. - `unreconciledAdjustmentsTotal` (string, decimal, required): Total value of unreconciled adjustments. - `bankAdjustmentBalance` (string, decimal, required): Net bank adjustment balance. - `bankAccountUndepositedBalance` (string, decimal, required): Undeposited balance in the bank account. - `unsettledPaymentBalance` (string, decimal, required): Balance of unsettled incoming payments. - `unsettledPaymentReturnBalance` (string, decimal, required): Balance of unsettled returned payments. - `unsettledPayoutBalance` (string, decimal, required): Balance of unsettled outgoing payouts. - `unsettledPayoutReturnBalance` (string, decimal, required): Balance of unsettled returned payouts. - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user who created this reconciliation (`GET /users` (undocumented) lists the account's users). - `dateTimeCreated` (string, required, read-only): When the reconciliation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `changeTransactionBalance` (string, decimal, required): Net of the reconciliation's change records (transactions reconciled into it or removed from it one at a time after it was completed): money in added and money out removed count positive, money out added and money in removed count negative. `0.00` when there are none. Computed by the query, so it is not stored. For a voided reconciliation, read the balance from `GET /accounting/reconciliations/{reconciliationID}` (`includes=reconciliationChangeTransactions`). ### reconciliation_transaction_types_request * `1` - Money In * `2` - Money Out * `3` - Adjustment ### reconciliation_object_types_request * `1` - Bank Adjustment * `2` - Bank Transfer In * `3` - Bank Transfer Out * `4` - Deposit * `5` - Payout * `6` - Transaction * `7` - Transaction Entry * `8` - Settlement * `9` - Payment Return * `10` - Bank Fee * `11` - Payout Return ### reconciliation_created The reconciliation the API just saved, as the create answers it: the values in memory after the save rather than a fresh read, so the totals the API computes are JSON numbers, `bankAccountID` and `statementEndingBalance` come back as they were sent, and the flags are numbers. `GET /accounting/reconciliations/{reconciliationID}` reads the same record back with every value a string. - `reconciliationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the reconciliation record. - `reconciliationVersionID` (integer, required, one of 2): Always `2` (Period Adjusted Balance) on a new reconciliation, sent as a JSON number. - `bankAccountID` (string | integer, required, pattern `^-?[0-9]+$`): The bank account, exactly as the request sent it (a string or a number). - `statementStartDate` (string, date, required): Start of the statement period, as `YYYY-MM-DD`: the day after the previous reconciliation's end date when the bank account has one, else the date the request sent. - `statementEndDate` (string, date, required): End of the statement period, as `YYYY-MM-DD` whichever accepted form the request used. - `statementEndingBalance` (string | number, decimal, required): The statement's ending balance, exactly as the request sent it (a string or a number). - `isCurrent` (integer, required, one of 1): Always `1`: a new reconciliation becomes the bank account's current one. Sent as a JSON number. - `isVoided` (integer, required, one of 0): Always `0` on a new reconciliation, sent as a JSON number. - `previousStatementEndingBalance` (string | number, decimal, required): The previous reconciliation's ending balance: a decimal string read from it, or the number `0` when the bank account had no reconciliation before. - `moneyInTotal` (number, required): Total money-in (credits) for the period. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `moneyOutTotal` (number, required): Total money-out (debits) for the period. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `reconciledMoneyInTotal` (number, required): Total reconciled credits for the period. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `reconciledMoneyOutTotal` (number, required): Total reconciled debits for the period. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `unreconciledMoneyInTotal` (number, required): Total unreconciled credits remaining. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `unreconciledMoneyOutTotal` (number, required): Total unreconciled debits remaining. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `reconciledBalance` (number, required): Net reconciled balance (credits minus debits). Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `adjustedCashBalance` (number, required): Adjusted cash balance after reconciliation adjustments. Computed by the API and sent as a JSON number (`2450`, `2450.25`). - `bankAccountBalance` (string, decimal, required): Current bank account balance as of the statement end date. - `undepositedPaymentsBalance` (string, decimal, required): Total value of payments not yet deposited. - `paymentsDepositedAfterStatementEndDateBalance` (string, decimal, required): Payments deposited after the statement end date. - `unsettledElectronicTransactionsBalance` (string, decimal, required): Balance of electronic transactions not yet settled. - `electronicTransactionsSettledAfterStatementEndDateBalance` (string, decimal, required): Electronic transactions settled after the statement end date. - `adjustmentsTotal` (number, required, one of 0): Total value of all reconciliation adjustments. Always `0` on a new reconciliation, sent as a JSON number. - `reconciledAdjustmentsTotal` (number, required, one of 0): Total value of reconciled adjustments. Always `0` on a new reconciliation, sent as a JSON number. - `unreconciledAdjustmentsTotal` (number, required, one of 0): Total value of unreconciled adjustments. Always `0` on a new reconciliation, sent as a JSON number. - `bankAdjustmentBalance` (number, required, one of 0): Net bank adjustment balance. Always `0` on a new reconciliation, sent as a JSON number. - `bankAccountUndepositedBalance` (number, required, one of 0): Undeposited balance in the bank account. Always `0` on a new reconciliation, sent as a JSON number. - `unsettledPaymentBalance` (number, required, one of 0): Balance of unsettled incoming payments. Always `0` on a new reconciliation, sent as a JSON number. - `unsettledPaymentReturnBalance` (number, required, one of 0): Balance of unsettled returned payments. Always `0` on a new reconciliation, sent as a JSON number. - `unsettledPayoutBalance` (number, required, one of 0): Balance of unsettled outgoing payouts. Always `0` on a new reconciliation, sent as a JSON number. - `unsettledPayoutReturnBalance` (number, required, one of 0): Balance of unsettled returned payouts. Always `0` on a new reconciliation, sent as a JSON number. - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user who created this reconciliation (`GET /users` (undocumented) lists the account's users). - `dateTimeCreated` (string, required, read-only): When the reconciliation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### reconciliation_transaction_types * `1` - Money In * `2` - Money Out * `3` - Adjustment ### reconciliation_object_types * `1` - Bank Adjustment * `2` - Bank Transfer In * `3` - Bank Transfer Out * `4` - Deposit * `5` - Payout * `6` - Transaction * `7` - Transaction Entry * `8` - Settlement * `9` - Payment Return * `10` - Bank Fee * `11` - Payout Return ### reconciliation_transaction One unreconciled item dated on or before the statement end date when the reconciliation was completed (older ones included), whether or not it was reconciled, as the `transactions` include of `GET /accounting/reconciliations/{reconciliationID}` returns it. The rows are a snapshot taken at completion. - `reconciliationTransactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the snapshot row. - `reconciliationID` (string, required, pattern `^-?[0-9]+$`): The reconciliation the row belongs to. - `isReconciled` (string, required, one of "0", "1"): `1` when the item was cleared in this reconciliation, `0` when it was in the period but left unreconciled. - `reconciliationTransactionTypeID` (`reconciliation_transaction_types`, required) - `reconciliationObjectTypeID` (`reconciliation_object_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the item, in the table `reconciliationObjectTypeID` names (a deposit's `depositID`, a transaction's `transactionID`, ...). - `transactionEntryTransactionID` (string | null, required, pattern `^-?[0-9]+$`): The accounting transaction behind the item, or null when there is none. - `datePosted` (string, date, required): The item's posting date. - `description` (string | null, required, max length 2000): The item's description. - `reference` (string | null, required, max length 1000): The item's reference (a check or deposit number). - `amount` (string, decimal, required): The item's amount, always positive; `reconciliationTransactionTypeID` says which way the money moved. ### unreconcilable_transaction_types * `1` - Undeposited Payment * `2` - Payment Deposited After Statement End Date * `3` - Unsettled Electronic Transaction * `4` - Electronic Transaction Settled After Statement End Date ### transaction_types * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return ### reconciliation_unreconcilable_transaction A payment or payout that fell in the reconciliation's statement period but could not be reconciled when the reconciliation was completed (not yet deposited, deposited after the period, or an electronic transaction not settled in the period). The rows are a snapshot taken at completion. - `unreconcilableTransactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the snapshot row. - `reconciliationID` (string, required, pattern `^-?[0-9]+$`): The reconciliation the row belongs to. - `unreconcilableTransactionTypeID` (`unreconcilable_transaction_types`, required) - `objectTypeID` (string, required, pattern `^-?[0-9]+$`): The object type of the item (an object type ID). The API writes `9` (Accounting Transaction), `12` (Accounting Payouts) or `41` (Accounting Payout Returns). - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the item in the table `objectTypeID` names. - `transactionTypeID` (one of several shapes, required): The accounting transaction's type, or null for a payout or payout return. - One of: - Option 1: `transaction_types` - Option 2: null - `transactionID` (string | null, required, pattern `^-?[0-9]+$`): The accounting transaction, or null for a payout or payout return. - `datePosted` (string, date, required): The item's posting date. - `description` (string | null, required, max length 2000): The item's description. - `reference` (string | null, required, max length 1000): The item's reference. - `amount` (string, decimal, required): The item's amount. ### reconciliation_change_types * `1` - Added to Reconciliation * `2` - Removed from Reconciliation ### reconciliation_change_transaction A transaction reconciled into or removed from a completed reconciliation on its own (`POST /accounting/transactions/{transactionID}/reconcile` and `/unreconcile`, or the deposit equivalents), recorded so the reconciliation's balance can be reported with the change. - `reconciliationChangeTransactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the change record. - `reconciliationID` (string, required, pattern `^-?[0-9]+$`): The reconciliation that was changed. - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The reconciliation's bank account. - `reconciliationChangeTypeID` (`reconciliation_change_types`, required) - `reconciliationTransactionTypeID` (`reconciliation_transaction_types`, required) - `reconciliationObjectTypeID` (`reconciliation_object_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the item, in the table `reconciliationObjectTypeID` names (a transaction's `transactionID` for type `6`). - `transactionEntryTransactionID` (string | null, required, pattern `^-?[0-9]+$`): The accounting transaction behind the item, or null. - `datePosted` (string, date, required): The item's posting date when it was changed. - `description` (string | null, required, max length 2000): The item's description when it was changed. - `reference` (string | null, required, max length 1000): The item's reference when it was changed. - `amount` (string, decimal, required): The item's amount, always positive. - `dateTimeCreated` (string, required, read-only): When the change was made. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### reconciliation_matched_bank_transaction A bank-feed transaction (Bank Sync) that was confirmed as the match for an item the reconciliation cleared. The API builds this object itself, so three of its IDs are JSON numbers. - `reconciliationBankTransactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the bank transaction. - `reconciliationBankStatementID` (string, required, pattern `^-?[0-9]+$`): The bank statement the transaction arrived on. - `sourceKey` (string | null, required, max length 100): The bank feed's own identifier for the transaction. - `datePosted` (string, date, required): The date the bank posted the transaction. - `amount` (string, decimal, required): The amount the bank reported. - `bankTransactionTypeID` (string, required): Whether the bank reported money in (`1`) or money out (`2`). - `description` (string | null, required): The bank's description of the transaction. - `reference` (string | null, required, max length 255): The bank's reference (a check number, for example). - `confidence` (integer | null, required): How confident the automatic matcher was, as a JSON number, or null. - `reconciliationBankTransactionMatchID` (integer | null, required): The confirmed match record, as a JSON number, or null. - `reconciliationID` (integer, required): The reconciliation that cleared the transaction, as a JSON number. ### reconciliation_voided The reconciliation the API just voided: every column as read before the void, except the two flags the void set, which are JSON numbers. - `reconciliationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the reconciliation record. - `reconciliationVersionID` (`reconciliation_versions`, required): Version identifier for the reconciliation. * `1` - All Time Adjusted Balance * `2` - Period Adjusted Balance - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The bank account this reconciliation belongs to. - `statementStartDate` (string, date, required): Start date of the bank statement period. - `statementEndDate` (string, date, required): End date of the bank statement period. - `statementEndingBalance` (string, decimal, required): Ending balance from the bank statement. - `isCurrent` (integer, required, one of 0): Always `0`: a voided reconciliation is no longer current. Sent as a JSON number. - `isVoided` (integer, required, one of 1): Always `1`. Sent as a JSON number. - `previousStatementEndingBalance` (string, decimal, required): Ending balance from the previous statement period. - `moneyInTotal` (string, decimal, required): Total money-in (credits) for the period. - `moneyOutTotal` (string, decimal, required): Total money-out (debits) for the period. - `reconciledMoneyInTotal` (string, decimal, required): Total reconciled credits for the period. - `reconciledMoneyOutTotal` (string, decimal, required): Total reconciled debits for the period. - `unreconciledMoneyInTotal` (string, decimal, required): Total unreconciled credits remaining. - `unreconciledMoneyOutTotal` (string, decimal, required): Total unreconciled debits remaining. - `reconciledBalance` (string, decimal, required): Net reconciled balance (credits minus debits). - `adjustedCashBalance` (string, decimal, required): Adjusted cash balance after reconciliation adjustments. - `bankAccountBalance` (string, decimal, required): Current bank account balance as of the statement end date. - `undepositedPaymentsBalance` (string, decimal, required): Total value of payments not yet deposited. - `paymentsDepositedAfterStatementEndDateBalance` (string, decimal, required): Payments deposited after the statement end date. - `unsettledElectronicTransactionsBalance` (string, decimal, required): Balance of electronic transactions not yet settled. - `electronicTransactionsSettledAfterStatementEndDateBalance` (string, decimal, required): Electronic transactions settled after the statement end date. - `adjustmentsTotal` (string, decimal, required): Total value of all reconciliation adjustments. - `reconciledAdjustmentsTotal` (string, decimal, required): Total value of reconciled adjustments. - `unreconciledAdjustmentsTotal` (string, decimal, required): Total value of unreconciled adjustments. - `bankAdjustmentBalance` (string, decimal, required): Net bank adjustment balance. - `bankAccountUndepositedBalance` (string, decimal, required): Undeposited balance in the bank account. - `unsettledPaymentBalance` (string, decimal, required): Balance of unsettled incoming payments. - `unsettledPaymentReturnBalance` (string, decimal, required): Balance of unsettled returned payments. - `unsettledPayoutBalance` (string, decimal, required): Balance of unsettled outgoing payouts. - `unsettledPayoutReturnBalance` (string, decimal, required): Balance of unsettled returned payouts. - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user who created this reconciliation (`GET /users` (undocumented) lists the account's users). - `dateTimeCreated` (string, required, read-only): When the reconciliation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### invoice An invoice is an inbound document (uploaded PDF or vendor-created line-item entry) that can be reviewed, converted to a bill, or declined. The `invoiceStatusID` tracks processing state; the `invoiceTypeID` distinguishes uploaded PDFs from manually created invoices. Predicted fields are populated by the AI extraction service for uploaded invoices. - `invoiceID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `receivedInvoiceEmailID` (string | null, pattern `^-?[0-9]+$`): ID of the inbound email that delivered this invoice, if applicable. - `invoiceTypeID` (string, required, one of "1", "2"): * `1` - Uploaded * `2` - Created - `invoiceStatusID` (string, required, one of "1", "2", "3", "4", "5"): * `1` - Processing * `2` - Ready * `3` - Converted * `4` - Declined * `5` - Not Processed - `invoiceSourceID` (string, required, one of "1", "2", "3", "4", "5"): * `1` - Portal * `2` - Upload * `3` - Email * `4` - Mobile * `5` - Manager - `invoiceFileID` (string | null, pattern `^-?[0-9]+$`): File ID of the uploaded invoice PDF. - `payeeContactID` (string | null, pattern `^-?[0-9]+$`): The confirmed payee contact, populated after review. - `billID` (string | null, pattern `^-?[0-9]+$`): The bill this invoice was converted to, or null. - `workOrderID` (string | null, pattern `^-?[0-9]+$`): Associated work order, if applicable. - `reference` (string | null): User-assigned reference number. - `submittedByUserID` (string | null, read-only, pattern `^-?[0-9]+$`): The user who submitted the invoice. - `submittedByEmail` (string | null, email): Email address of the submitter. - `declinedMessage` (string | null): Message sent to the vendor when the invoice was declined. - `predictedFields` (object | null): Structured AI extraction predictions. Each named key maps to a prediction object with `value` (the extracted value, or null if not predicted), and optionally `source` (`"predicted"`) and `confidence` (0–1 float) when a prediction was made. `lineItems` is an array of similar prediction objects. - `amount` (object) - `value` (number | null) - `source` (string) - `confidence` (number) - `ledger` (object) - `value` (string | null) - `dueDate` (object) - `value` (string | null, date) - `source` (string) - `confidence` (number) - `billDate` (object) - `value` (string | null, date) - `source` (string) - `confidence` (number) - `accountID` (object) - `value` (integer | null) - `lineItems` (object[]) - `reference` (object) - `value` (string | null) - `source` (string) - `confidence` (number) - `workOrderID` (object) - `value` (integer | null) - `payeeContact` (object) - `value` (integer | null) - `serviceEndDate` (object) - `value` (string | null, date) - `source` (string) - `confidence` (number) - `defaultDiscount` (object) - `value` (string | null) - `serviceStartDate` (object) - `value` (string | null, date) - `source` (string) - `confidence` (number) - `serviceAccountNumber` (object) - `value` (string | null) - `source` (string) - `confidence` (number) - `predictedPayeeContactID` (string | null, pattern `^-?[0-9]+$`): AI-predicted payee contact ID (flat, from model column). - `predictedPayeeContactName` (string | null): AI-predicted payee contact name (flat, from model column). - `predictedDefaultDiscount` (string | null): AI-predicted default discount amount. - `predictedWorkOrderID` (string | null, pattern `^-?[0-9]+$`): AI-predicted work order ID. - `predictedLedgerID` (string | null, pattern `^-?[0-9]+$`): AI-predicted ledger ID. - `predictedLedgerAddress` (string | null): AI-predicted ledger address. - `predictedAccountID` (string | null, pattern `^-?[0-9]+$`): AI-predicted chart-of-accounts ID. - `predictedBillDate` (string | null, date): AI-predicted bill date. - `predictedDueDate` (string | null, date): AI-predicted due date. - `predictedReference` (string | null): AI-predicted reference / invoice number. - `predictedServiceAccountNumber` (string | null): AI-predicted service account number. - `predictedAmount` (string | null, decimal): AI-predicted total amount as a decimal string. - `predictedServiceStartDate` (string | null, date): AI-predicted service period start date. - `predictedServiceEndDate` (string | null, date): AI-predicted service period end date. - `datePosted` (string | null, date): Date the invoice was posted / converted to a bill. - `dateTimeCreated` (string, required, read-only): Timestamp when the invoice record was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### transaction - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`) - `transactionTypeID` (`transaction_types`, required) - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`) - `billID` (string | null, pattern `^-?[0-9]+$`) - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`) - `payoutID` (string | null, pattern `^-?[0-9]+$`) - `payoutReturnID` (string | null, pattern `^-?[0-9]+$`) - `amount` (string, decimal, required) - `description` (string | null) - `reference` (string | null) - `isVoided` (string, required, one of "0", "1") - `datePosted` (string, date, required) - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactID` (string | null, pattern `^-?[0-9]+$`) ### management_fee_modes * `1` - Ledger * `2` - Bill ### account_filter_types * `1` - Any * `2` - None * `3` - Account ### return_types * `1` - Insufficient Funds * `2` - Bad Account * `3` - Returned * `4` - Other ### payment_types * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check ### transaction_statuses * `1` - Created * `2` - Batched * `3` - Settled * `4` - Returned * `5` - Failed ### transaction_record An accounting transaction: every column of the transaction row. Fields a transaction's type doesn't use are null (a journal entry fills its type, ledger, portfolio, property or unit, amount, description and dates). - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the transaction. - `transactionTypeID` (`transaction_types`, required) - `managementFeeMode` (`management_fee_modes`, required): Management fee calculation mode applied to this transaction. * `1` - Ledger * `2` - Bill - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): The ledger the transaction posts on (`accounting_ledgers`: a manager or portfolio ledger), not a bank account; null on types that have none, such as a ledger transfer. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): Portfolio this transaction belongs to. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property associated with this transaction. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit associated with this transaction. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease this transaction is posted against. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill linked to this transaction, if any. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): The contact (tenant, owner or vendor) the transaction belongs to, or null. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account the payment was deposited into, if applicable. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against (present for charge transactions). - `equityAccountID` (string | null, required, pattern `^-?[0-9]+$`): Equity account ID, if applicable. - `destinationBankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Destination bank account for transfer transactions. - `managementFeeIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account used for management fee recording. - `prepaymentAccountFilterTypeID` (one of several shapes, required): Filter type controlling which prepayment account is used. * `1` - Any * `2` - None * `3` - Account - One of: - Option 1: `account_filter_types` - Option 2: null - `prepaymentAccountID` (string | null, required, pattern `^-?[0-9]+$`): Prepayment/unapplied account ID. Use `-1` to apply to the default prepayment account. - `unallocatedAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account used to hold unallocated payment funds. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): Payout linked to this transaction, if any. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): Payout return linked to this transaction, if any. - `amount` (string, decimal, required): Transaction amount as a decimal string. - `amountPaid` (string | null, decimal, required): Amount of the charge that has been paid so far. - `amountAllocated` (string | null, decimal, required): Portion of a payment that has been applied to charges. - `processingFee` (string | null, decimal, required): Processing fee amount collected on this payment, if any. - `convenienceFee` (string | null, decimal, required): Convenience fee charged on online payments. - `convenienceFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Transaction ID of the associated convenience fee transaction. - `description` (string | null, required, max length 4000): Free-text label for this transaction. - `reference` (string | null, required, max length 200): External reference number (e.g. check number, ACH trace ID). - `receivedFrom` (string | null, required, max length 100): Name of the payer as recorded on the transaction. - `returnTransactionID` (string | null, required, pattern `^-?[0-9]+$`): On a transaction that was returned (a payment), the ID of the return transaction that reversed it; null otherwise. The `returnedTransaction` include follows the link the other way. - `returnTypeID` (one of several shapes, required): Return type code when this is a returned payment. * `1` - Insufficient Funds * `2` - Bad Account * `3` - Returned * `4` - Other - One of: - Option 1: `return_types` - Option 2: null - `returnDescription` (string | null, required, max length 200): Reason for the return. - `bulkPaymentID` (string | null, required, pattern `^-?[0-9]+$`): Bulk payment batch this transaction belongs to, if any. - `paymentTypeID` (one of several shapes, required): How the payment was made, or null on a transaction that isn't a payment. * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge transaction on a bill that this payment is applied to. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Credit transaction on a bill associated with this transaction. - `discountAmount` (string | null, decimal, required): Discount amount applied to this transaction. - `markupAmount` (string | null, decimal, required): Markup amount applied to this transaction. - `managementFeeAmountPaid` (string | null, decimal, required): Management fee portion that has been paid. - `isAdditionalManagementFee` (string | null, required, one of "0", "1", null): Whether this transaction is an additional management fee charge (`1` = yes, `0` = no). - `managementFeePercent` (string | null, decimal, required): Management fee percentage applied to this transaction. - `isSuppressed` (string, required, one of "0", "1"): Whether this transaction is suppressed from certain reports (`1` = yes, `0` = no). - `managementFeeExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account used for management fee disbursements. - `managementFeePeriodDate` (string | null, date, required): Period date for management fee calculation. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee on this transaction. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): Sales tax amount on the management fee that has been paid. - `managementFeeSalesTaxPercent` (string | null, decimal, required): Sales tax percentage applied to the management fee. - `managementFeeSalesTaxIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account for management fee sales tax. - `managementFeeSalesTaxExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account for management fee sales tax. - `managementFeeBatchID` (string | null, required, pattern `^-?[0-9]+$`): Management fee batch this transaction belongs to, if any. - `isSalesTaxCharge` (string | null, required, one of "0", "1", null): Whether this transaction is a sales tax charge (`1` = yes, `0` = no). - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to this charge transaction. - `salesTaxInitiatedFromTransactionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the parent transaction that triggered this sales tax charge. - `isVoided` (string, required, one of "0", "1"): Whether the transaction has been voided (`1` = voided, `0` = active). - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): Payment gateway ID associated with the bank account. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): Gateway-assigned transaction identifier. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): Settlement batch this transaction was settled in. - `paymentAccountName` (string | null, required, max length 200): Bank account name of the payer (for ACH/card transactions). - `paymentAccountNumberTruncated` (string | null, required, max length 10): Last 4 digits of the payer's account number. - `depositID` (string | null, required, pattern `^-?[0-9]+$`): Deposit batch this payment was included in. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Bank reconciliation this transaction has been reconciled in. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Previous reconciliation ID if the transaction was moved between reconciliations. - `achStatusID` (one of several shapes, required): ACH processing status code for electronic payments. * `1` - Created * `2` - Batched * `3` - Settled * `4` - Returned * `5` - Failed - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankTransferID` (string | null, required, pattern `^-?[0-9]+$`): Bank transfer record ID for ACH transactions. - `lateFeePeriod` (string | null, required, pattern `^-?[0-9]+$`): On a late fee charge, the period the late fee was assessed for; null otherwise. - `isFromManager` (string | null, required, one of "0", "1", null): Whether this transaction was entered directly by a manager (`1` = yes, `0` = no). - `isMoveInCharge` (string | null, required, one of "0", "1", null): Whether this is a move-in charge (`1` = yes, `0` = no). - `isProrated` (string | null, required, one of "0", "1", null): Whether this charge was prorated (`1` = yes, `0` = no). - `isMoveOutTransaction` (string | null, required, one of "0", "1", null): Whether this transaction is part of a move-out settlement (`1` = yes, `0` = no). - `moveOutAmount` (string | null, decimal, required): Amount applied during move-out settlement. - `discountMarkupBillChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge transaction ID for discount or markup adjustments. - `recurringObjectID` (string | null, required, pattern `^-?[0-9]+$`): Recurring charge object that generated this transaction, if any. - `residentServiceID` (string | null, required, pattern `^-?[0-9]+$`): ID of the service this record points to. - `residentPackageID` (string | null, required, pattern `^-?[0-9]+$`): ID of the package this record points to. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): Tax agency for withholding tax, if applicable. - `withholdingTaxContactID` (string | null, required, pattern `^-?[0-9]+$`): Contact associated with withholding tax, if applicable. - `datePosted` (string, date, required): Date the transaction was posted to the ledger. - `dateTimeCreated` (string, required, read-only): Timestamp when the transaction record was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the transaction record was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### included_ledger An accounting ledger (every column of the row; the shared ledger model lacks the timestamps). - `ledgerID` (string, required, read-only, pattern `^-?[0-9]+$`) - `ledgerTypeID` (`ledger_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): ID of the record the ledger belongs to, as `ledgerTypeID` says: the portfolio (`2`), property (`3`) or unit (`4`). A manager ledger (`1`) belongs to none of these. - `name` (string, required, max length 200) - `isActive` (string, required, one of "0", "1") - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### included_portfolio A portfolio (every column of the row; the shared portfolio model types `contacts` as a JSON string and doesn't allow the numeric values older rows store). `contacts` is decoded from JSON. - `portfolioID` (string, required, read-only, pattern `^-?[0-9]+$`) - `code` (string | null, required, max length 100) - `name` (string, required, max length 100) - `contacts` (object[] | null, required): The portfolio's owners, decoded from JSON; null until first built. Rows written by older code store `contactID` and the percentages as JSON numbers, newer rows as strings, so both forms arrive. - `name` (string, required) - `contactID` (string | integer, required, pattern `^-?[0-9]+$`) - `percentOwned` (string | number, decimal, required) - `percentDistributed` (string | number, decimal, required) - `postingSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the posting setting this record points to. - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `minimumDistributionAmount` (string | null, decimal, required) - `maximumDistributionAmount` (string | null, decimal, required) - `reserveAmount` (string, decimal, required) - `additionalReserveAmount` (string, decimal, required) - `additionalReserveDescription` (string | null, required, max length 1000) - `overdraftOverrideAmount` (string | null, decimal, required) - `fiscalYearEndMonth` (string, required, pattern `^-?[0-9]+$`) - `statementSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the statement setting this record points to. - `sendStatements` (string, required, one of "0", "1") - `holdDistributions` (string, required, one of "0", "1") - `holdDistributionsDescription` (string | null, required, max length 1000) - `isActive` (string, required, one of "0", "1") - `isLiveLedgerEnabled` (string | null, required, one of "0", "1", null) - `isBalanceNoticeDisabled` (string, required, one of "0", "1") - `dateTimeCreated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null, required, max length 100) - `isPublicStatementEnabled` (string, required, one of "0", "1") - `dateClosed` (string | null, date, required) - `payOwnersNotes` (string | null): Notes for paying the owners. A newer column, so an account whose database doesn't have it yet doesn't send the key. ### property_types * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot ### address_validation_statuses * `1` - Not Validated * `2` - Valid * `3` - Invalid * `4` - Incomplete ### commercial_class_types * `1` - A * `2` - B * `3` - C * `4` - D ### deactivation_reasons * `1` - Property Sold * `2` - Owner Moved In * `3` - Property Uninhabitable / Demolished * `4` - Owner Self-Managing * `5` - Switched to Competitor * `6` - Price / Fees * `7` - Service Quality * `8` - Management Terminated by Us * `10` - Foreclosure / Bank Repossession * `11` - Owner Deceased / Estate Closed * `12` - Entered in Error / Duplicate * `13` - Lease Only * `14` - Maintenance Handling * `15` - Accounting / Financial Errors * `16` - Leasing Performance * `17` - Communication Breakdown * `18` - Relationship / Staffing Issues * `19` - Owner Terminated Management * `20` - Portfolio Consolidation * `21` - Relationship Change / Divorce * `98` - Other * `99` - Unknown ### included_property A property, as an include returns it (every column of the property row). - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the property. - `propertyImageID` (string, required, pattern `^-?[0-9]+$`): Primary image file id. - `propertyTypeID` (`property_types`, required): Property type (e.g. single-family, multi-family, commercial). * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot - `isMultiUnit` (string, required, one of "0", "1"): Whether the property has multiple units (`1`/`0`). - `isActive` (string, required, one of "0", "1"): Whether the property is active (`1`/`0`). - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio that owns this property. - `managementFeeSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the management fee setting. - `name` (string | null, required, max length 100): The property's name. - `countryID` (string, required, max length 2): ID of the country. - `address` (string, required, max length 100): Full formatted street address. - `streetNumber` (string | null, required, pattern `^-?[0-9]+$`): The property's street number. - `streetName` (string | null, required, max length 100): The property's street name. - `address2` (string | null, required, max length 100): The property's address2. - `stateID` (string, required, max length 3): ID of the state. - `city` (string, required, max length 100): The property's city. - `postalCode` (string | null, required, max length 20): The property's postal code. - `latitude` (string, decimal, required): The property's latitude. - `longitude` (string, decimal, required): The property's longitude. - `addressValidationStatusID` (`address_validation_statuses`, required): Address-validation status. * `1` - Not Validated * `2` - Valid * `3` - Invalid * `4` - Incomplete - `addressValidationData` (object | null, required): Result of the last address validation, decoded from JSON; null when the address hasn't been validated. - `county` (string | null, required, max length 100): The property's county. - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): User the property is assigned to. - `legalDescription` (string | null, required, max length 200): The property's legal description. - `maintenanceLimitAmount` (string | null, decimal, required): Spend limit before maintenance needs approval. - `yearBuilt` (string | null, required, pattern `^-?[0-9]+$`): The property's year built. - `dateInsuranceExpires` (string | null, date, required): Date insurance expires. - `dateWarrantyExpires` (string | null, date, required): Date warranty expires. - `maintenanceNotes` (string | null, required): The property's maintenance notes. - `applicationTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the application template. - `reserveAmount` (string, decimal, required): Owner reserve held for the property. - `markupPercent` (string | null, decimal, required): Maintenance markup percentage. - `markupAmount` (string | null, decimal, required): The property's markup amount. - `markupAmountMin` (string | null, decimal, required): The property's markup amount min. - `markupAmountMax` (string | null, decimal, required): The property's markup amount max. - `dateContractBegins` (string | null, date, required): Date contract begins. - `dateContractEnds` (string | null, date, required): Date contract ends. - `commercialClassTypeID` (one of several shapes, required): ID of the commercial class type. - One of: - Option 1: `commercial_class_types` - Option 2: null - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the sales tax setting. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): ID of the withholding tax agency. - `insuranceCompany` (string | null, required, max length 100): The property's insurance company. - `insuranceAgent` (string | null, required, max length 100): The property's insurance agent. - `insurancePolicyNumber` (string | null, required, max length 50): The property's insurance policy number. - `requiredRentersInsuranceLiabilityAmount` (string, decimal, required): The property's required renters insurance liability amount. - `insuranceContactDetails` (string | null, required, max length 500): The property's insurance contact details. - `leaseReturnChargeAmount` (string | null, decimal, required): Default NSF/returned-payment charge for the property's leases. - `defaultMonthToMonthPremiumSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the default month to month premium setting. - `defaultResidentPackageID` (string | null, required, pattern `^-?[0-9]+$`): ID of the default resident package. - `propertyShowingProviderID` (string | null, required, pattern `^-?[0-9]+$`): ID of the property showing provider. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `deactivationReasonID` (one of several shapes, required): ID of the deactivation reason. - One of: - Option 1: `deactivation_reasons` - Option 2: null - `deactivationNotes` (string | null, required): The property's deactivation notes. - `isFromImport` (string, required, one of "0", "1"): Whether the property was created via import (`1`/`0`). - `importSourceKey` (string | null, required, max length 100): The property's import source key. ### property_beds * `0` - Studio * `1` - 1 * `2` - 2 * `3` - 3 * `4` - 4 * `5` - 5 * `6` - 6 * `7` - 7 * `8` - 8 * `9` - 9 * `10` - 10 ### property_baths * `0` - None * `1` - 1 * `2` - 2 * `3` - 3 * `4` - 4 * `5` - 5 * `6` - 6 * `7` - 7 * `8` - 8 * `9` - 9 * `10` - 10 ### commercial_space_types * `1` - Office * `2` - Industrial * `3` - Retail * `4` - Restaurant * `5` - Medical * `6` - Special Purpose * `7` - Storage * `8` - Warehouse * `9` - Multi-use ### non_revenue_types * `1` - Renovation * `2` - Employee * `3` - Model * `4` - Other * `5` - For Sale * `6` - Lease Only ### filter_delivery_address_types * `1` - Deliver to the Unit * `2` - Deliver to a Custom Address ### included_unit A unit, as an include returns it (every column of the unit row). - `unitID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the unit. - `propertyID` (string, required, pattern `^-?[0-9]+$`): The property this unit belongs to. - `propertyImageID` (string, required, pattern `^-?[0-9]+$`): ID of the property image. - `isActive` (string, required, one of "0", "1"): Whether the unit is active. * `0` - Inactive * `1` - Active - `name` (string | null, required, max length 100): Unit name/number. - `address` (string, required, max length 100): The unit's address. - `streetNumber` (string | null, required, pattern `^-?[0-9]+$`): The unit's street number. - `streetName` (string | null, required, max length 100): The unit's street name. - `address2` (string | null, required, max length 100): The unit's address2. - `stateID` (string, required, max length 3): The ID of the state the unit is in. Uses the 2-letter state code. - `city` (string, required, max length 100): The unit's city. - `postalCode` (string | null, required, max length 20): The unit's postal code. - `latitude` (string, decimal, required): The unit's latitude. - `longitude` (string, decimal, required): The unit's longitude. - `addressValidationStatusID` (`address_validation_statuses`, required): ID of the address validation status. * `1` - Not Validated * `2` - Valid * `3` - Invalid * `4` - Incomplete - `addressValidationData` (object | null, required): Result of the last address validation, decoded from JSON; null when the address hasn't been validated. - `rent` (string, decimal, required): Default market rent for the unit. - `deposit` (string | null, decimal, required): Default security deposit. - `size` (string | null, required, pattern `^-?[0-9]+$`): Square footage. - `beds` (one of several shapes, required): The unit's beds. - One of: - Option 1: `property_beds` - Option 2: null - `fullBaths` (one of several shapes, required): The unit's full baths. - One of: - Option 1: `property_baths` - Option 2: null - `halfBaths` (one of several shapes, required): The unit's half baths. - One of: - Option 1: `property_baths` - Option 2: null - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): The unit's current active lease, if any. - `propertyManagerID` (string | null, required, pattern `^-?[0-9]+$`): ID of the property manager. - `commercialSpaceTypeID` (one of several shapes, required): ID of the commercial space type. - One of: - Option 1: `commercial_space_types` - Option 2: null - `isNonRevenue` (string, required, one of "0", "1"): Whether the unit is a non-revenue unit. * `0` - Revenue unit * `1` - Non-revenue unit - `nonRevenueTypeID` (one of several shapes, required): ID of the non revenue type. - One of: - Option 1: `non_revenue_types` - Option 2: null - `nonRevenueStartDate` (string | null, date, required): The unit's non revenue start date. - `isUtilityBillingEnabled` (string, required, one of "0", "1"): Whether utility billing is enabled for this unit. * `0` - Disabled * `1` - Enabled - `filterDeliveryScheduleID` (string | null, required, pattern `^-?[0-9]+$`): ID of the filter delivery schedule. - `filterDeliveryAddressTypeID` (one of several shapes, required): ID of the filter delivery address type. - One of: - Option 1: `filter_delivery_address_types` - Option 2: null - `filterDeliveryAddressID` (string | null, required, pattern `^-?[0-9]+$`): ID of the filter delivery address. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string, required, one of "0", "1"): Whether the unit was created via import (`1`/`0`). - `importSourceKey` (string | null, required, max length 100): The unit's import source key. - `leaseNotes` (string | null, required): The unit's lease notes. - `entryInstructions` (string | null, required): Resident-facing entry instructions. - `vendorEntryInstructions` (string | null, required): Vendor-facing entry instructions. - `maintenanceNotes` (string | null, required): The unit's maintenance notes. ### primary_lease_statuses * `1` - Pending * `2` - Active * `3` - Closed ### move_out_statuses * `1` - None * `2` - Active * `3` - Completed ### lease_allowed_payment_amount_types * `1` - Any Amount * `2` - Full Amount Only * `3` - >= Full Amount Only ### tenant_refund_payout_types * `1` - Check * `2` - ACH ### enrollment_provider_statuses * `1` - Pending * `2` - Active * `3` - Deactivation Pending * `4` - Deactivated * `5` - Failed ### rentvine_insurance_packages * `1` - Rentvine Insurance - TLL * `2` - Rentvine Insurance - TLL with Contents * `3` - Rentvine Insurance - TLL ### renters_insurance_provider_types * `1` - Millennial Specialty Insurance ### lease_activation_options * `1` - Manually Activate Lease * `2` - Activate Lease on Creation * `3` - Automatically Activate Lease on Start Date ### scheduled_activation_failure_reasons * `1` - The unit still has an active lease. Close it and this lease will activate automatically. * `2` - The unit is inactive. Reactivate it and this lease will activate automatically. * `3` - The unit could not be found. Activate this lease manually. * `99` - Activate this lease manually. ### included_lease A lease, as the property and unit includes send it: every column of the lease row (the shared lease model lacks some). `tenants` is decoded from JSON. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `primaryLeaseStatusID` (`primary_lease_statuses`, required) - `leaseStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the lease status this record points to. - `moveOutStatusID` (`move_out_statuses`, required) - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `applicationID` (string | null, required, pattern `^-?[0-9]+$`): ID of the application this record points to. - `leaseDocumentTransactionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the lease's document-signing transaction (a document sent for e-signature), not an accounting transaction; null when none. - `code` (string | null, required, max length 100) - `tenants` (string[] | null, required): Display names of the tenants on the lease, decoded from JSON; null when not yet built. - `moveInDate` (string, date, required) - `startDate` (string, date, required) - `endDate` (string | null, date, required) - `occupancyStartDate` (string | null, date, required) - `occupancyEndDate` (string | null, date, required) - `isOccupancy` (string, required, one of "0", "1") - `isMonthToMonth` (string, required, one of "0", "1") - `monthToMonthStartDate` (string | null, date, required) - `monthToMonthPremiumSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the month to month premium setting this record points to. - `tenantLiabilityInsuranceProviderID` (string | null, required, pattern `^-?[0-9]+$`): ID of the tenant liability insurance provider this record points to. - `tenantLiabilityInsuranceEffectiveDate` (string | null, date, required) - `rentersInsuranceCompany` (string | null, required, max length 100) - `rentersInsurancePolicyNumber` (string | null, required, max length 100) - `rentersInsuranceStartDate` (string | null, date, required) - `rentersInsuranceExpirationDate` (string | null, date, required) - `rentersInsuranceFileID` (string | null, required, pattern `^-?[0-9]+$`): ID of the file this record points to. - `rentersInsurancePolicyLiabilityAmount` (string | null, decimal, required) - `requiredRentersInsuranceLiabilityAmount` (string, decimal, required) - `leaseFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the transaction this record points to. - `leaseFeeBillID` (string | null, required, pattern `^-?[0-9]+$`): ID of the bill this record points to. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `lateFeeSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the late fee setting this record points to. - `isPortalDisabled` (string, required, one of "0", "1") - `isPortalPaymentDisabled` (string, required, one of "0", "1") - `isCertifiedFundsRequired` (string, required, one of "0", "1") - `isLateFeesActive` (string, required, one of "0", "1") - `allowedPaymentAmountTypeID` (one of several shapes, required) - One of: - Option 1: `lease_allowed_payment_amount_types` - Option 2: null - `isAchDisabled` (string | null, required, one of "0", "1", null) - `isCreditCardDisabled` (string | null, required, one of "0", "1", null) - `isCashDisabled` (string | null, required, one of "0", "1", null) - `closedDate` (string | null, date, required) - `closedDescription` (string | null, required, max length 4000) - `noticeDate` (string | null, date, required) - `expectedMoveOutDate` (string | null, date, required) - `moveOutDate` (string | null, date, required) - `depositRefundDueDate` (string | null, date, required) - `leaseReturnChargeAmount` (string, decimal, required) - `moveOutReasonID` (string | null, required, pattern `^-?[0-9]+$`): ID of the move out reason this record points to. - `moveOutUnitAvailabilityDate` (string | null, date, required) - `moveOutTenantRemarks` (string | null, required) - `moveOutLeaseTenantID` (string | null, required, pattern `^-?[0-9]+$`): ID of the lease tenant (`leaseTenantID`, a row of the lease's tenants, not a contact) moving out; null when none. - `isLeaseAgreementViolated` (string, required, one of "0", "1") - `forwardingName` (string | null, required, max length 100) - `forwardingCountryID` (string | null, required, max length 2): ID of the country this record points to. - `forwardingAddress` (string | null, required, max length 100) - `forwardingAddress2` (string | null, required, max length 100) - `forwardingCity` (string | null, required, max length 100) - `forwardingStateID` (string | null, required, max length 3): ID of the state this record points to. - `forwardingPostalCode` (string | null, required, max length 20) - `forwardingEmail` (string | null, required, max length 100) - `forwardingPhone` (string | null, required, max length 20) - `moveOutTenantReason` (string | null, required) - `tenantRefundPayoutTypeID` (`tenant_refund_payout_types`, required) - `statementSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the statement setting this record points to. - `sendStatements` (string, required, one of "0", "1") - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null, required, max length 100) - `isTenantPastDueNoticeEnabled` (string, required, one of "0", "1") - `rentvineInsuranceEnrollmentID` (string | null, required, pattern `^-?[0-9]+$`): ID of the enrollment this record points to. - `rentvineInsuranceEnrollmentStatusID` (one of several shapes, required) - One of: - Option 1: `enrollment_provider_statuses` - Option 2: null - `rentvineInsurancePackageID` (one of several shapes, required) - One of: - Option 1: `rentvine_insurance_packages` - Option 2: null - `rentvineInsuranceRecurringChargeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the recurring charge this record points to. - `rentvineInsuranceChargeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the transaction this record points to. - `rentersInsuranceProviderTypeID` (one of several shapes, required) - One of: - Option 1: `renters_insurance_provider_types` - Option 2: null - `leaseActivationOptionID` (`lease_activation_options`, required) - `scheduledActivationFailedDateTime` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `scheduledActivationFailureReasonID` (one of several shapes, required) - One of: - Option 1: `scheduled_activation_failure_reasons` - Option 2: null - `increaseEligibilityDate` (string | null, date, required) - `isAutoClosed` (string, required, one of "0", "1") - `isPublicStatementEnabled` (string, required, one of "0", "1") - `isMarkedToVacate` (string, required, one of "0", "1") ### contact_types * `1` - Owner * `2` - Tenant * `3` - Vendor * `4` - Manager * `5` - Association * `6` - Applicant * `7` - Screening Prospect * `8` - Internal Technician * `9` - Owner Lead ### form_types * `1` - 1099-MISC * `2` - 1042 ### identification_types * `1` - Driver's License * `2` - Passport * `3` - State Issued Identification Card * `4` - Military ID * `5` - Permanent Resident Card (Green Card) * `6` - Employment Authorization Document (EAD) * `7` - Visa * `8` - Other ### payout_types * `1` - Other * `2` - Check * `3` - eCheck (ACH) * `4` - NACHA (ACH) ### other_payout_types * `1` - Cash * `2` - Credit\Debit Card * `3` - Bank Transfer * `4` - Check * `5` - Other ### included_contact A contact (every column of the row plus the computed `contactType`; the shared contact model lacks many of them). - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (`contact_types`, required) - `vendorTypeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the vendor type this record points to. - `code` (string | null, required, max length 100) - `name` (string, required, max length 100) - `firstName` (string | null, required, max length 100) - `middleName` (string | null, required, max length 100) - `lastName` (string | null, required, max length 100) - `suffix` (string | null, required, max length 15) - `email` (string | null, required, max length 100) - `phone` (string | null, required, max length 20) - `countryID` (string | null, required, max length 2): ID of the country this record points to. - `address` (string | null, required, max length 100) - `address2` (string | null, required, max length 100) - `city` (string | null, required, max length 45) - `stateID` (string | null, required, max length 3) - `postalCode` (string | null, required, max length 30) - `birthDate` (string | null, date, required) - `defaultBillChargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the account this record points to. - `payeeName` (string | null, required, max length 100) - `taxPayerName` (string | null, required, max length 100) - `taxFormTypeID` (one of several shapes, required) - One of: - Option 1: `form_types` - Option 2: null - `identificationTypeID` (one of several shapes, required) - One of: - Option 1: `identification_types` - Option 2: null - `identificationNumber` (string | null, required, max length 50) - `identificationCountryID` (string | null, required, max length 2): ID of the country this record points to. - `identificationIssuingLocation` (string | null, required, max length 100) - `identificationExpirationDate` (string | null, date, required) - `payoutTypeID` (`payout_types`, required) - `otherPayoutTypeID` (one of several shapes, required) - One of: - Option 1: `other_payout_types` - Option 2: null - `achDetailsCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): ID of the ciphertext this record points to. - `achAccountNumberTruncated` (string | null, required, max length 4) - `achAccountTypeID` (one of several shapes, required) - One of: - Option 1: `bank_account_types` - Option 2: null - `achIsCorporateAccount` (string, required, one of "0", "1") - `holdPayments` (string, required, one of "0", "1") - `liabilityInsuranceName` (string | null, required, max length 100) - `liabilityInsurancePolicyNumber` (string | null, required, max length 50) - `liabilityInsuranceExpiresDate` (string | null, date, required) - `workersCompInsuranceName` (string | null, required, max length 100) - `workersCompInsurancePolicyNumber` (string | null, required, max length 50) - `workersCompInsuranceExpiresDate` (string | null, date, required) - `discountPercent` (string | null, decimal, required) - `discountAmount` (string | null, decimal, required) - `discountAmountMin` (string | null, decimal, required) - `discountAmountMax` (string | null, decimal, required) - `discountGraceDays` (string | null, required, pattern `^-?[0-9]+$`) - `isActive` (string, required, one of "0", "1") - `isInsuranceRequiredForPayment` (string | null, required, one of "0", "1", null) - `maxLineItemsOnPayment` (string | null, required, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string, required, one of "0", "1") - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null, required, max length 100) - `websiteUrl` (string | null, required, max length 500) - `applicantID` (string | null, required, pattern `^-?[0-9]+$`): ID of the applicant this record points to. - `ownerPortalNameOverride` (string | null, required, max length 100) - `isBillApprovalExempt` (string, required, one of "0", "1") - `isBillingSalesTaxEnabled` (string, required, one of "0", "1") - `isQuickbooksExportEnabled` (string, required, one of "0", "1") - `quickbooksCustomerName` (string | null, required, max length 100) - `invoiceAutofillTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the invoice autofill template this record points to. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (one of several shapes, required): The contact type's label (`Owner`, `Tenant`, `Vendor`, …), computed in PHP; `false` when `contactTypeID` is null. - One of: - Option 1: string - Option 2: any ### bulk_payment_types * `1` - Lease * `2` - Portfolio ### included_bulk_payment A bulk payment (bulk receipt): one deposit item covering several lease payments. - `bulkPaymentID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the bulk payment. - `bulkPaymentTypeID` (`bulk_payment_types`, required): Whose payments the bulk payment holds. * `1` - Lease * `2` - Portfolio - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): ID of the bank account. - `paymentTypeID` (`payment_types`, required): How the bulk payment was made. * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - `depositID` (string | null, required, pattern `^-?[0-9]+$`): ID of the deposit. - `amount` (string, decimal, required): The bulk payment's amount. - `isVoided` (string, required, one of "0", "1"): Whether the bulk payment is voided. - `description` (string | null, required, max length 4000): The bulk payment's description. - `reference` (string | null, required, max length 200): The bulk payment's reference. - `receivedFrom` (string, required, max length 100): The bulk payment's received from. - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the created by user. - `datePosted` (string, date, required): Date posted. - `dateTimeCreated` (string, required, read-only): Date time created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date time modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### transaction_log_types * `1` - Create * `2` - Modify * `3` - Void * `4` - Reallocate Receipts * `5` - Return * `6` - Return Voided * `7` - Receipt Allocated * `8` - Receipt Modified ### included_transaction_log A transaction log entry: one change to a transaction (create, modify, void, return, receipt allocation) and who made it. - `transactionLogID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the transaction log. - `transactionID` (string, required, pattern `^-?[0-9]+$`): ID of the transaction. - `transactionTypeID` (`transaction_types`, required): Type of the transaction at the time of the change. * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return - `userID` (string, required, pattern `^-?[0-9]+$`): ID of the user. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the bank account. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the charge account. - `transactionLogTypeID` (`transaction_log_types`, required): What the change was. * `1` - Create * `2` - Modify * `3` - Void * `4` - Reallocate Receipts * `5` - Return * `6` - Return Voided * `7` - Receipt Allocated * `8` - Receipt Modified - `amount` (string, decimal, required): The log entry's amount. - `description` (string | null, required, max length 4000): The log entry's description. - `log` (string | null, required): The log entry's log. - `datePosted` (string, date, required): Date posted. - `dateTimeCreated` (string, required, read-only): Date time created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### entry_types * `1` - Credit * `2` - Debit ### transaction_entry_row_reconciliation A reconciliation the entry points to (`reconciliationID` or `previousReconciliationID`); every key `null` when there is none. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation's ID. - `statementStartDate` (string | null, date, required): Start of the statement period. - `statementEndDate` (string | null, date, required): End of the statement period. - `statementEndingBalance` (string | null, decimal, required): The statement's ending balance. - `previousStatementEndingBalance` (string | null, decimal, required): The previous statement's ending balance. - `isCurrent` (string | null, required, one of "0", "1", null): Whether this is the bank account's current reconciliation. - `dateTimeCreated` (string | null, required): When the reconciliation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### transaction_entry_row One of a transaction's entries as the `entries` include lists them: the entry, the ledger it posts to, a summary of its transaction and that transaction's primary ledger, and the property, portfolio, unit and reconciliations the entry points to. The related records are left-joined: when there is none, each of their keys is `null`. - `transactionEntry` (object, required): The entry. - `transactionEntryID` (string, required, pattern `^-?[0-9]+$`): Unique identifier for the entry. - `transactionLogID` (string, required, pattern `^-?[0-9]+$`): The transaction log (the create or modify) that wrote the entry. - `accountID` (string, required, pattern `^-?[0-9]+$`): The chart-of-accounts account the entry posts to. - `entryTypeID` (`entry_types`, required): Whether the entry is a credit or a debit. * `1` - Credit * `2` - Debit - `receiptID` (string | null, required, pattern `^-?[0-9]+$`): The receipt the entry belongs to, or null. - `description` (string | null, required, max length 4000): The entry's description, or null. - `credit` (string, decimal, required): Amount credited (`0.00` on a debit entry). - `debit` (string, decimal, required): Amount debited (`0.00` on a credit entry). - `isVoided` (string, required, one of "0", "1"): Whether the entry is voided. The include lists only entries that aren't. - `isSuppressed` (string, required, one of "0", "1"): Whether the entry is suppressed (management fee billing mode). - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation that reconciled the entry, or null. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation the entry was reconciled in before, or null. - `isCash` (string, required, one of "0", "1"): Whether the entry is on the cash basis. - `isAccrual` (string, required, one of "0", "1"): Whether the entry is on the accrual basis. - `datePosted` (string, date, required): Date the entry posts on. - `dateTimeCreated` (string, required): When the entry was written. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `ledger` (object, required): The ledger the entry posts to. - `ledgerID` (string, required, pattern `^-?[0-9]+$`): The ledger's ID. - `ledgerTypeID` (`ledger_types`, required): The ledger's type. * `1` - Manager * `2` - Portfolio * `3` - Property * `4` - Unit - `name` (string, required): The ledger's name. - `transaction` (object, required): A summary of the entry's transaction. - `transactionID` (string, required, pattern `^-?[0-9]+$`): The transaction's ID. - `transactionTypeID` (`transaction_types`, required): The transaction's type. * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): The transaction's primary ledger. - `billID` (string | null, required, pattern `^-?[0-9]+$`): The bill the transaction belongs to, or null. - `description` (string | null, required, max length 4000): The transaction's description. - `isVoided` (string, required, one of "0", "1"): Whether the transaction is voided. - `amount` (string, decimal, required): The transaction's amount. - `datePosted` (string, date, required): Date the transaction posts on. - `reference` (string | null, required, max length 200): The transaction's reference (a check number, for example), or null. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): The payout the transaction belongs to, or null. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): The payout return the transaction belongs to, or null. - `dateTimeCreated` (string, required): When the transaction was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required): When the transaction was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `primaryLedger` (object, required): The transaction's primary ledger; every key `null` when the transaction has none. - `ledgerID` (string | null, required, pattern `^-?[0-9]+$`): The ledger's ID. - `ledgerTypeID` (string | null, required, one of "1", "2", "3", "4", null): The ledger's type (`1` Manager, `2` Portfolio, `3` Property, `4` Unit). - `name` (string | null, required): The ledger's name. - `property` (object, required): The property the transaction points to; every key `null` when it points to none. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): The transaction's property. - `name` (string | null, required): The property's name. - `address` (string | null, required): The property's street address. - `address2` (string | null, required): The property's address, line 2. - `city` (string | null, required): The property's city. - `stateID` (string | null, required): The property's state code. - `postalCode` (string | null, required): The property's postal code. - `isMultiUnit` (string | null, required, one of "0", "1", null): Whether the property has several units. - `portfolio` (object, required): The portfolio the transaction points to; both keys `null` when it points to none. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): The transaction's portfolio. - `name` (string | null, required): The portfolio's name. - `unit` (object, required): The unit the transaction points to; every key `null` when it points to none. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): The transaction's unit. - `name` (string | null, required): The unit's name. - `address` (string | null, required): The unit's street address. - `address2` (string | null, required): The unit's address, line 2. - `city` (string | null, required): The unit's city. - `stateID` (string | null, required): The unit's state code. - `postalCode` (string | null, required): The unit's postal code. - `reconciliation` (`transaction_entry_row_reconciliation`, required) - `previousReconciliation` (`transaction_entry_row_reconciliation`, required) ### transaction_entry_record A transaction entry: one debit or credit line a transaction posted to an account and a ledger (every column of the entry row). - `transactionEntryID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the entry. - `transactionID` (string, required, pattern `^-?[0-9]+$`): The transaction the entry belongs to. - `transactionLogID` (string, required, pattern `^-?[0-9]+$`): The transaction log (the create or modify) that wrote the entry. - `accountID` (string, required, pattern `^-?[0-9]+$`): The chart-of-accounts account the entry posts to. - `entryTypeID` (`entry_types`, required): Whether the entry is a credit or a debit. * `1` - Credit * `2` - Debit - `ledgerID` (string, required, pattern `^-?[0-9]+$`): The ledger the entry posts to. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): The portfolio the entry posts to, or null. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): The property the entry posts to, or null. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): The unit the entry posts to, or null. - `receiptID` (string | null, required, pattern `^-?[0-9]+$`): The receipt the entry belongs to, or null. - `description` (string | null, required, max length 4000): The entry's description, or null. - `credit` (string, decimal, required): Amount credited (`0.00` on a debit entry). - `debit` (string, decimal, required): Amount debited (`0.00` on a credit entry). - `isVoided` (string, required, one of "0", "1"): Whether the entry is voided (`1` once its transaction is voided). - `isSuppressed` (string, required, one of "0", "1"): Whether the entry is suppressed (management fee billing mode). - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation that reconciled the entry, or null. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation the entry was reconciled in before, or null. - `isCash` (string, required, one of "0", "1"): Whether the entry is on the cash basis. - `isAccrual` (string, required, one of "0", "1"): Whether the entry is on the accrual basis. - `datePosted` (string, date, required): Date the entry posts on. - `dateTimeCreated` (string, required, read-only): When the entry was written. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### transaction_entry_with_ledger A transaction entry and the ledger it posts to. - `transactionEntry` (`transaction_entry_record`, required) - `ledger` (`included_ledger`, required) ### transaction_entry_archive An archived transaction entry: a line a transaction had before a later change to the transaction replaced its entries (every column of the archive row). - `transactionEntryArchiveID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the archived entry. - `transactionID` (string, required, pattern `^-?[0-9]+$`): The transaction the entry belongs to. - `transactionLogID` (string, required, pattern `^-?[0-9]+$`): The transaction log (the create or modify) that wrote the entry. - `accountID` (string, required, pattern `^-?[0-9]+$`): The chart-of-accounts account the entry posts to. - `entryTypeID` (`entry_types`, required): Whether the entry is a credit or a debit. * `1` - Credit * `2` - Debit - `ledgerID` (string, required, pattern `^-?[0-9]+$`): The ledger the entry posts to. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): The portfolio the entry posts to, or null. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): The property the entry posts to, or null. - `receiptID` (string | null, required, pattern `^-?[0-9]+$`): The receipt the entry belongs to, or null. - `description` (string | null, required, max length 4000): The entry's description, or null. - `credit` (string, decimal, required): Amount credited (`0.00` on a debit entry). - `debit` (string, decimal, required): Amount debited (`0.00` on a credit entry). - `isVoided` (string, required, one of "0", "1"): Whether the entry was voided when it was archived. - `isSuppressed` (string, required, one of "0", "1"): Whether the entry is suppressed (management fee billing mode). - `isCash` (string, required, one of "0", "1"): Whether the entry is on the cash basis. - `isAccrual` (string, required, one of "0", "1"): Whether the entry is on the accrual basis. - `datePosted` (string, date, required): Date the entry posts on. - `dateTimeCreated` (string, required, read-only): When the entry was written. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### transaction_entry_archive_with_ledger An archived transaction entry and the ledger it posted to. - `transactionEntryArchive` (`transaction_entry_archive`, required) - `ledger` (`included_ledger`, required) ### transaction_view One accounting transaction, with the related records the `includes` parameter asked for, each under its own key. `GET /accounting/transactions/{transactionID}` answers with it, and so does the journal entry create. - `transaction` (`transaction_record`, required) - `ledger` (one of several shapes): The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the `ledger` include. - One of: - Option 1: `included_ledger` - Option 2: null - `portfolio` (one of several shapes): The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is `false`, not `null`. Requires the `portfolio` include. - One of: - Option 1: `included_portfolio` - Option 2: any - `property` (one of several shapes): The transaction's property, or null when it has none. Requires the `property` include. - One of: - Option 1: `included_property` - Option 2: null - `unit` (one of several shapes): The transaction's unit, or null when it has none. Requires the `unit` include. - One of: - Option 1: `included_unit` - Option 2: null - `lease` (one of several shapes): The transaction's lease, or null when it has none. Requires the `lease` include. - One of: - Option 1: `included_lease` - Option 2: null - `account` (null): Always `null`: transactions have no `accountID`, so this include never finds an account. Requires the `account` include. - `contact` (one of several shapes): The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the `contact` include. - One of: - Option 1: `included_contact` - Option 2: null - `reconciliation` (one of several shapes): The reconciliation that reconciled the transaction, or null. Requires the `reconciliation` include. - One of: - Option 1: `included_reconciliation` - Option 2: null - `previousReconciliation` (one of several shapes): The reconciliation the transaction was reconciled in before, or null. Requires the `previousReconciliation` include. - One of: - Option 1: `included_reconciliation` - Option 2: null - `returnedTransaction` (one of several shapes): The transaction this one returned: the transaction whose `returnTransactionID` is this transaction's ID (on a payment return, the payment it returned), or null when there is none. Requires the `returnedTransaction` include. - One of: - Option 1: `transaction_record` - Option 2: null - `bulkPayment` (one of several shapes): The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the `bulkPayment` include. - One of: - Option 1: `included_bulk_payment` - Option 2: null - `transactionLogs` (object[]): Every change made to the transaction (create, modify, void), newest first (changes made in the same second come in no set order), one row per change. Requires the `transactionLogs` include. - `transactionLog` (`included_transaction_log`, required) - `token` (string, required, pattern `^[0-9]+$`): The time of the request, as Unix seconds. Sent on every row of this list. - `entries` (`transaction_entry_row`[]): The transaction's cash-basis entries that aren't voided (an accrual-only entry isn't listed), newest first: by date posted, then transaction, then entry ID, each descending. Each comes with its ledger and related records. Requires the `entries` include. - `cashEntries` (`transaction_entry_with_ledger`[]): Every cash-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger. Requires the `cashEntries` include. - `accrualEntries` (`transaction_entry_with_ledger`[]): Every accrual-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger. Requires the `accrualEntries` include. - `cashEntryArchives` (`transaction_entry_archive_with_ledger`[]): The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger. Requires the `cashEntryArchives` include. - `accrualEntryArchives` (`transaction_entry_archive_with_ledger`[]): The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger. Requires the `accrualEntryArchives` include. ### transaction_entry - `transactionEntryID` (string, required, read-only, pattern `^-?[0-9]+$`) - `transactionLogID` (string, required, pattern `^-?[0-9]+$`) - `accountID` (string, required, pattern `^-?[0-9]+$`) - `entryTypeID` (`entry_types`, required) - `receiptID` (string | null, pattern `^-?[0-9]+$`) - `description` (string | null) - `credit` (string, decimal, required) - `debit` (string, decimal, required) - `isVoided` (string, required, one of "0", "1") - `isSuppressed` (string, required, one of "0", "1") - `reconciliationID` (string | null, pattern `^-?[0-9]+$`) - `isCash` (string, required, one of "0", "1") - `isAccrual` (string, required, one of "0", "1") - `datePosted` (string, date, required) - `dateTimeCreated` (string, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### payment_types_request * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check ### transaction_detail Full accounting transaction record as returned by lease charge and payment creation endpoints. Contains all fields including management-fee, sales-tax, ACH, prepayment, and reconciliation metadata. Fields that are not applicable to a given transaction type will be null. - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the transaction. - `transactionTypeID` (`transaction_types`, required) - `managementFeeMode` (string | null, pattern `^-?[0-9]+$`): Management fee calculation mode applied to this transaction. - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): ID of the primary ledger (usually the trust/operating bank account) this transaction posts to. - `portfolioID` (string | null, pattern `^-?[0-9]+$`): Portfolio this transaction belongs to. - `propertyID` (string | null, pattern `^-?[0-9]+$`): Property associated with this transaction. - `unitID` (string | null, pattern `^-?[0-9]+$`): Unit associated with this transaction. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease this transaction is posted against. - `billID` (string | null, pattern `^-?[0-9]+$`): Bill linked to this transaction, if any. - `contactID` (string | null, pattern `^-?[0-9]+$`): Contact (tenant) associated with this transaction, if any. - `bankAccountID` (string | null, pattern `^-?[0-9]+$`): Bank account the payment was deposited into, if applicable. - `chargeAccountID` (string | null, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against (present for charge transactions). - `equityAccountID` (string | null, pattern `^-?[0-9]+$`): Equity account ID, if applicable. - `destinationBankAccountID` (string | null, pattern `^-?[0-9]+$`): Destination bank account for transfer transactions. - `managementFeeIncomeAccountID` (string | null, pattern `^-?[0-9]+$`): Income account used for management fee recording. - `prepaymentAccountFilterTypeID` (string | null, pattern `^-?[0-9]+$`): Filter type controlling which prepayment account is used. - `prepaymentAccountID` (string | null, pattern `^-?[0-9]+$`): Prepayment/unapplied account ID. Use `-1` to apply to the default prepayment account. - `unallocatedAccountID` (string | null, pattern `^-?[0-9]+$`): Account used to hold unallocated payment funds. - `payoutID` (string | null, pattern `^-?[0-9]+$`): Payout linked to this transaction, if any. - `payoutReturnID` (string | null, pattern `^-?[0-9]+$`): Payout return linked to this transaction, if any. - `amount` (string, decimal, required): Transaction amount as a decimal string. - `amountPaid` (string | null, decimal): Amount of the charge that has been paid so far. - `amountAllocated` (string | null, decimal): Portion of a payment that has been applied to charges. - `processingFee` (string | null, decimal): Processing fee amount collected on this payment, if any. - `convenienceFee` (string | null, decimal): Convenience fee charged on online payments. - `convenienceFeeTransactionID` (string | null, pattern `^-?[0-9]+$`): Transaction ID of the associated convenience fee transaction. - `description` (string | null): Free-text label for this transaction. - `reference` (string | null): External reference number (e.g. check number, ACH trace ID). - `receivedFrom` (string | null): Name of the payer as recorded on the transaction. - `returnTransactionID` (string | null, pattern `^-?[0-9]+$`): ID of the original transaction this is a return for. - `returnTypeID` (string | null, pattern `^-?[0-9]+$`): Return type code when this is a returned payment. - `returnDescription` (string | null): Reason for the return. - `bulkPaymentID` (string | null, pattern `^-?[0-9]+$`): Bulk payment batch this transaction belongs to, if any. - `paymentTypeID` (string | null, pattern `^-?[0-9]+$`): Payment method type (e.g. 3 = Check, 4 = ACH). - `billChargeTransactionID` (string | null, pattern `^-?[0-9]+$`): Charge transaction on a bill that this payment is applied to. - `billCreditTransactionID` (string | null, pattern `^-?[0-9]+$`): Credit transaction on a bill associated with this transaction. - `discountAmount` (string | null, decimal): Discount amount applied to this transaction. - `markupAmount` (string | null, decimal): Markup amount applied to this transaction. - `managementFeeAmountPaid` (string | null, decimal): Management fee portion that has been paid. - `isAdditionalManagementFee` (string | null, one of "0", "1", null): Whether this transaction is an additional management fee charge (`1` = yes, `0` = no). - `managementFeePercent` (string | null, decimal): Management fee percentage applied to this transaction. - `isSuppressed` (string, one of "0", "1"): Whether this transaction is suppressed from certain reports (`1` = yes, `0` = no). - `managementFeeExpenseAccountID` (string | null, pattern `^-?[0-9]+$`): Expense account used for management fee disbursements. - `managementFeePeriodDate` (string | null, date): Period date for management fee calculation. - `managementFeeSalesTaxSettingID` (string | null, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee on this transaction. - `managementFeeSalesTaxAmountPaid` (string | null, decimal): Sales tax amount on the management fee that has been paid. - `managementFeeSalesTaxPercent` (string | null, decimal): Sales tax percentage applied to the management fee. - `managementFeeSalesTaxIncomeAccountID` (string | null, pattern `^-?[0-9]+$`): Income account for management fee sales tax. - `managementFeeSalesTaxExpenseAccountID` (string | null, pattern `^-?[0-9]+$`): Expense account for management fee sales tax. - `managementFeeBatchID` (string | null, pattern `^-?[0-9]+$`): Management fee batch this transaction belongs to, if any. - `isSalesTaxCharge` (string | null, one of "0", "1", null): Whether this transaction is a sales tax charge (`1` = yes, `0` = no). - `salesTaxSettingID` (string | null, pattern `^-?[0-9]+$`): Sales tax setting applied to this charge transaction. - `salesTaxInitiatedFromTransactionID` (string | null, pattern `^-?[0-9]+$`): ID of the parent transaction that triggered this sales tax charge. - `isVoided` (string, required, one of "0", "1"): Whether the transaction has been voided (`1` = voided, `0` = active). - `bankAccountGatewayID` (string | null, pattern `^-?[0-9]+$`): Payment gateway ID associated with the bank account. - `bankAccountGatewayTransactionID` (string | null): Gateway-assigned transaction identifier. - `settlementID` (string | null, pattern `^-?[0-9]+$`): Settlement batch this transaction was settled in. - `paymentAccountName` (string | null): Bank account name of the payer (for ACH/card transactions). - `paymentAccountNumberTruncated` (string | null): Last 4 digits of the payer's account number. - `depositID` (string | null, pattern `^-?[0-9]+$`): Deposit batch this payment was included in. - `reconciliationID` (string | null, pattern `^-?[0-9]+$`): Bank reconciliation this transaction has been reconciled in. - `previousReconciliationID` (string | null, pattern `^-?[0-9]+$`): Previous reconciliation ID if the transaction was moved between reconciliations. - `achStatusID` (string | null, pattern `^-?[0-9]+$`): ACH processing status code for electronic payments. - `bankTransferID` (string | null, pattern `^-?[0-9]+$`): Bank transfer record ID for ACH transactions. - `lateFeePeriod` (string | null, date, pattern `^-?[0-9]+$`): Period date when a late fee was assessed, if applicable. - `isFromManager` (string | null, one of "0", "1", null): Whether this transaction was entered directly by a manager (`1` = yes, `0` = no). - `isMoveInCharge` (string | null, one of "0", "1", null): Whether this is a move-in charge (`1` = yes, `0` = no). - `isProrated` (string | null, one of "0", "1", null): Whether this charge was prorated (`1` = yes, `0` = no). - `isMoveOutTransaction` (string | null, one of "0", "1", null): Whether this transaction is part of a move-out settlement (`1` = yes, `0` = no). - `moveOutAmount` (string | null, decimal): Amount applied during move-out settlement. - `discountMarkupBillChargeTransactionID` (string | null, pattern `^-?[0-9]+$`): Bill charge transaction ID for discount or markup adjustments. - `recurringObjectID` (string | null, pattern `^-?[0-9]+$`): Recurring charge object that generated this transaction, if any. - `withholdingTaxAgencyID` (string | null, pattern `^-?[0-9]+$`): Tax agency for withholding tax, if applicable. - `withholdingTaxContactID` (string | null, pattern `^-?[0-9]+$`): Contact associated with withholding tax, if applicable. - `datePosted` (string, date, required): Date the transaction was posted to the ledger. - `dateTimeCreated` (string, required, read-only): Timestamp when the transaction record was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the transaction record was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease_transaction A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the transaction. - `transactionTypeID` (`transaction_types`, required): Transaction type: * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return - `managementFeeMode` (`management_fee_modes`, required): Management fee mode the account used when the transaction posted: * `1` - Ledger * `2` - Bill - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): Portfolio that owned the property when the transaction posted. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property of the transaction's lease. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit of the transaction's lease. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease the transaction belongs to. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill the transaction belongs to; null for lease transactions. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account the money moved through (payments, returns); null for charges and credits. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. - `equityAccountID` (string | null, required, pattern `^-?[0-9]+$`): Equity account that funds a refunded return (debited); null for other types. - `destinationBankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Destination bank account of a bank transfer; null for lease transactions. - `managementFeeIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of a management fee; null for lease transactions. - `prepaymentAccountFilterTypeID` (one of several shapes, required): Which charges the unapplied amount may later be applied to: * `1` - Any * `2` - None * `3` - Account - One of: - Option 1: `account_filter_types` - Option 2: null - `prepaymentAccountID` (string | null, required, pattern `^-?[0-9]+$`): Prepayment account chosen for a payment's unapplied amount, when the payment names one. - `unallocatedAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account that holds the unapplied (prepayment) amount of a payment or credit. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): Payout the transaction belongs to; null for lease charges, credits and payments. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): Payout return the transaction belongs to. - `amount` (string, decimal, required): Amount of the transaction, in its column's scale. - `amountPaid` (string | null, decimal, required): Amount of a charge paid so far by receipts; null for types that don't track it. - `amountAllocated` (string | null, decimal, required): Amount of a payment or credit applied to charges or refunded so far; null for types that don't track it. - `processingFee` (string | null, decimal, required): Processing fee of an online payment. - `convenienceFee` (string | null, decimal, required): Convenience fee charged on an online payment. - `convenienceFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge that carries the convenience fee of an online payment. - `description` (string | null, required, max length 4000): Free-text description shown on the ledger. - `reference` (string | null, required, max length 200): External reference, such as a check number. - `receivedFrom` (string | null, required, max length 100): Name the payment was received from, when entered. - `returnTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Return transaction of a returned payment; null until the payment is returned. - `returnTypeID` (one of several shapes, required): Return reason code of an electronic payment return. - One of: - Option 1: `return_types` - Option 2: null - `returnDescription` (string | null, required, max length 200): Return reason text of an electronic payment return. - `bulkPaymentID` (string | null, required, pattern `^-?[0-9]+$`): Bulk payment (bulk receipt) the payment belongs to. - `paymentTypeID` (one of several shapes, required): How a payment was made: * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a bill-related transaction belongs to. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill credit a bill-related transaction belongs to. - `discountAmount` (string | null, decimal, required): Discount applied to a bill charge. - `markupAmount` (string | null, decimal, required): Markup applied to a bill charge. - `managementFeeAmountPaid` (string | null, decimal, required): Management fee taken from what was paid on this charge. - `isAdditionalManagementFee` (string | null, required, one of "0", "1", null): Whether the charge carries an additional management fee. - `managementFeePercent` (string | null, decimal, required): Management fee percent applied to this charge. - `isSuppressed` (string, required, one of "0", "1"): Whether the transaction is hidden from the tenant. - `managementFeeExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management fee. - `managementFeePeriodDate` (string | null, date, required): Management fee period the transaction counts toward. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): Sales tax on the management fee, paid so far. - `managementFeeSalesTaxPercent` (string | null, decimal, required): Sales tax percent on the management fee. - `managementFeeSalesTaxIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of the management-fee sales tax. - `managementFeeSalesTaxExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management-fee sales tax. - `managementFeeBatchID` (string | null, required, pattern `^-?[0-9]+$`): Management fee batch the transaction was billed in. - `isSalesTaxCharge` (string | null, required, one of "0", "1", null): Whether the charge is a sales tax charge. - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting of a sales tax charge. - `salesTaxInitiatedFromTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge a sales tax charge was raised from. - `isVoided` (string, required, one of "0", "1"): `'1'` once the transaction is voided; a voided transaction keeps its row and is excluded from balances. - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): Processor's transaction ID of an online payment. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): Processor settlement an online payment was paid out in. - `paymentAccountName` (string | null, required, max length 200): Name on the account an online payment came from. - `paymentAccountNumberTruncated` (string | null, required, max length 10): Last digits of the account an online payment came from. - `depositID` (string | null, required, pattern `^-?[0-9]+$`): Bank deposit the payment is in; a payment must be deposited before it can be returned. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Bank reconciliation the transaction was reconciled in. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Reconciliation the transaction was in before it was last unreconciled. - `achStatusID` (one of several shapes, required): Status of an ACH transfer. - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankTransferID` (string | null, required, pattern `^-?[0-9]+$`): Bank transfer the transaction belongs to. - `lateFeePeriod` (string | null, required, pattern `^-?[0-9]+$`): Late fee period a late-fee charge was raised for. - `isFromManager` (string | null, required, one of "0", "1", null): Whether a resident-portal transaction was entered by the manager. - `isMoveInCharge` (string | null, required, one of "0", "1", null): Whether this is a move-in charge. - `isProrated` (string | null, required, one of "0", "1", null): Whether this is a prorated charge. - `isMoveOutTransaction` (string | null, required, one of "0", "1", null): Whether this is a move-out transaction. - `moveOutAmount` (string | null, decimal, required): Amount counted toward the move-out statement. - `discountMarkupBillChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a discount or markup belongs to. - `recurringObjectID` (string | null, required, pattern `^-?[0-9]+$`): Recurring charge or credit that raised the transaction. - `residentServiceID` (string | null, required, pattern `^-?[0-9]+$`): Resident service the charge is for. - `residentPackageID` (string | null, required, pattern `^-?[0-9]+$`): Resident package the charge is for. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): Tax agency of a withholding. - `withholdingTaxContactID` (string | null, required, pattern `^-?[0-9]+$`): Contact a withholding is held for. - `datePosted` (string, date, required): Date the transaction posts to the ledger. - `dateTimeCreated` (string, required, read-only): When the transaction was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): When the transaction was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease_transaction_error The body of a lease transaction action's `400`. Two forms: `{"error": ""}` for a check the controller makes itself (an empty body, a record that doesn't exist or isn't the right type), and a validation map, each key a field path and its value the messages for that field, when the service or a model refuses the change. - `error` (string): The message, when the controller refuses the request itself. ### receipt_types * `1` - Charge * `2` - Payout ### included_receipt A receipt: an application of a payment or credit to a charge (`receiptTypeID` `1`), or to a refund payout (`2`). - `receiptID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the receipt. - `receiptTypeID` (`receipt_types`, required): What the receipt applies the payment or credit to. * `1` - Charge * `2` - Payout - `paymentTransactionID` (string, required, pattern `^-?[0-9]+$`): ID of the payment transaction. - `chargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the charge transaction. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): ID of the payout. - `amount` (string, decimal, required): The receipt's amount. - `isFromPrepayment` (string, required, one of "0", "1"): Whether the receipt is from prepayment. - `managementFeeAmountPaid` (string, decimal, required): The receipt's management fee amount paid. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the management fee sales tax setting. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): The receipt's management fee sales tax amount paid. - `chargeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the charge sales tax setting. - `isVoided` (string, required, one of "0", "1"): Whether the receipt is voided. - `datePosted` (string, date, required): Date posted. ### included_transaction_left_joined A transaction reached through a left join, as a receipt row's `charge` is: every column of the transaction, all of them null when the row has no such transaction (a refund receipt has no charge). - `transactionID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the transaction. Null when the row has no charge. - `transactionTypeID` (one of several shapes, required): Transaction type. Null when the row has no charge. * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return - One of: - Option 1: `transaction_types` - Option 2: null - `managementFeeMode` (one of several shapes, required): Management fee mode the account used when the transaction posted. Null when the row has no charge. * `1` - Ledger * `2` - Bill - One of: - Option 1: `management_fee_modes` - Option 2: null - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). Null when the row has no charge. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): Portfolio that owned the property when the transaction posted. Null when the row has no charge. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property of the transaction's lease. Null when the row has no charge. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit of the transaction's lease. Null when the row has no charge. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease the transaction belongs to. Null when the row has no charge. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill the transaction belongs to; null for lease transactions. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account the money moved through (payments, returns); null for charges and credits. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. Null when the row has no charge. - `equityAccountID` (string | null, required, pattern `^-?[0-9]+$`): Equity account that funds a refunded return (debited); null for other types. - `destinationBankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Destination bank account of a bank transfer; null for lease transactions. - `managementFeeIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of a management fee; null for lease transactions. - `prepaymentAccountFilterTypeID` (one of several shapes, required): Which charges the unapplied amount may later be applied to. Null when the row has no charge. * `1` - Any * `2` - None * `3` - Account - One of: - Option 1: `account_filter_types` - Option 2: null - `prepaymentAccountID` (string | null, required, pattern `^-?[0-9]+$`): Prepayment account chosen for a payment's unapplied amount, when the payment names one. Null when the row has no charge. - `unallocatedAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account that holds the unapplied (prepayment) amount of a payment or credit. Null when the row has no charge. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): Payout the transaction belongs to; null for lease charges, credits and payments. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): Payout return the transaction belongs to. Null when the row has no charge. - `amount` (string | null, decimal, required): Amount of the transaction, in its column's scale. Null when the row has no charge. - `amountPaid` (string | null, decimal, required): Amount of a charge paid so far by receipts; null for types that don't track it. - `amountAllocated` (string | null, decimal, required): Amount of a payment or credit applied to charges or refunded so far; null for types that don't track it. - `processingFee` (string | null, decimal, required): Processing fee of an online payment. Null when the row has no charge. - `convenienceFee` (string | null, decimal, required): Convenience fee charged on an online payment. Null when the row has no charge. - `convenienceFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge that carries the convenience fee of an online payment. Null when the row has no charge. - `description` (string | null, required, max length 4000): Free-text description shown on the ledger. Null when the row has no charge. - `reference` (string | null, required, max length 200): External reference, such as a check number. Null when the row has no charge. - `receivedFrom` (string | null, required, max length 100): Name the payment was received from, when entered. Null when the row has no charge. - `returnTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Return transaction of a returned payment; null until the payment is returned. - `returnTypeID` (one of several shapes, required): Return reason code of an electronic payment return. Null when the row has no charge. - One of: - Option 1: `return_types` - Option 2: null - `returnDescription` (string | null, required, max length 200): Return reason text of an electronic payment return. Null when the row has no charge. - `bulkPaymentID` (string | null, required, pattern `^-?[0-9]+$`): Bulk payment (bulk receipt) the payment belongs to. Null when the row has no charge. - `paymentTypeID` (one of several shapes, required): How a payment was made. Null when the row has no charge. * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a bill-related transaction belongs to. Null when the row has no charge. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill credit a bill-related transaction belongs to. Null when the row has no charge. - `discountAmount` (string | null, decimal, required): Discount applied to a bill charge. Null when the row has no charge. - `markupAmount` (string | null, decimal, required): Markup applied to a bill charge. Null when the row has no charge. - `managementFeeAmountPaid` (string | null, decimal, required): Management fee taken from what was paid on this charge. Null when the row has no charge. - `isAdditionalManagementFee` (string | null, required, one of "0", "1", null): Whether the charge carries an additional management fee. Null when the row has no charge. - `managementFeePercent` (string | null, decimal, required): Management fee percent applied to this charge. Null when the row has no charge. - `isSuppressed` (string | null, required, one of "0", "1", null): Whether the transaction is hidden from the tenant. Null when the row has no charge. - `managementFeeExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management fee. Null when the row has no charge. - `managementFeePeriodDate` (string | null, date, required): Management fee period the transaction counts toward. Null when the row has no charge. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee. Null when the row has no charge. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): Sales tax on the management fee, paid so far. Null when the row has no charge. - `managementFeeSalesTaxPercent` (string | null, decimal, required): Sales tax percent on the management fee. Null when the row has no charge. - `managementFeeSalesTaxIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of the management-fee sales tax. Null when the row has no charge. - `managementFeeSalesTaxExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management-fee sales tax. Null when the row has no charge. - `managementFeeBatchID` (string | null, required, pattern `^-?[0-9]+$`): Management fee batch the transaction was billed in. Null when the row has no charge. - `isSalesTaxCharge` (string | null, required, one of "0", "1", null): Whether the charge is a sales tax charge. Null when the row has no charge. - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting of a sales tax charge. Null when the row has no charge. - `salesTaxInitiatedFromTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge a sales tax charge was raised from. Null when the row has no charge. - `isVoided` (string | null, required, one of "0", "1", null): `'1'` once the transaction is voided; a voided transaction keeps its row and is excluded from balances. Null when the row has no charge. - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. Null when the row has no charge. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): Processor's transaction ID of an online payment. Null when the row has no charge. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): Processor settlement an online payment was paid out in. Null when the row has no charge. - `paymentAccountName` (string | null, required, max length 200): Name on the account an online payment came from. Null when the row has no charge. - `paymentAccountNumberTruncated` (string | null, required, max length 10): Last digits of the account an online payment came from. Null when the row has no charge. - `depositID` (string | null, required, pattern `^-?[0-9]+$`): Bank deposit the payment is in; a payment must be deposited before it can be returned. Null when the row has no charge. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Bank reconciliation the transaction was reconciled in. Null when the row has no charge. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Reconciliation the transaction was in before it was last unreconciled. Null when the row has no charge. - `achStatusID` (one of several shapes, required): Status of an ACH transfer. Null when the row has no charge. - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankTransferID` (string | null, required, pattern `^-?[0-9]+$`): Bank transfer the transaction belongs to. Null when the row has no charge. - `lateFeePeriod` (string | null, required, pattern `^-?[0-9]+$`): Late fee period a late-fee charge was raised for. Null when the row has no charge. - `isFromManager` (string | null, required, one of "0", "1", null): Whether a resident-portal transaction was entered by the manager. Null when the row has no charge. - `isMoveInCharge` (string | null, required, one of "0", "1", null): Whether this is a move-in charge. Null when the row has no charge. - `isProrated` (string | null, required, one of "0", "1", null): Whether this is a prorated charge. Null when the row has no charge. - `isMoveOutTransaction` (string | null, required, one of "0", "1", null): Whether this is a move-out transaction. Null when the row has no charge. - `moveOutAmount` (string | null, decimal, required): Amount counted toward the move-out statement. Null when the row has no charge. - `discountMarkupBillChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a discount or markup belongs to. Null when the row has no charge. - `recurringObjectID` (string | null, required, pattern `^-?[0-9]+$`): Recurring charge or credit that raised the transaction. Null when the row has no charge. - `residentServiceID` (string | null, required, pattern `^-?[0-9]+$`): Resident service the charge is for. Null when the row has no charge. - `residentPackageID` (string | null, required, pattern `^-?[0-9]+$`): Resident package the charge is for. Null when the row has no charge. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): Tax agency of a withholding. Null when the row has no charge. - `withholdingTaxContactID` (string | null, required, pattern `^-?[0-9]+$`): Contact a withholding is held for. Null when the row has no charge. - `datePosted` (string | null, date, required): Date the transaction posts to the ledger. Null when the row has no charge. - `dateTimeCreated` (string | null, required, read-only): When the transaction was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no charge. - `dateTimeModified` (string | null, required, read-only): When the transaction was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no charge. ### payout_sources * `1` - Bill * `2` - Ledger * `3` - Lease ### included_payout_left_joined A payout reached through a left join, as a receipt row's `payout` is: every column, all of them null when the receipt isn't a refund (no payout). - `payoutID` (string | null, required, read-only, pattern `^-?[0-9]+$`): ID of the payout. Null when the row has no payout. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): ID of the contact. Null when the row has no payout. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the bank account. Null when the row has no payout. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): ID of the reconciliation. Null when the row has no payout. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): ID of the previous reconciliation. Null when the row has no payout. - `payoutBatchID` (string | null, required, pattern `^-?[0-9]+$`): ID of the payout batch. Null when the row has no payout. - `payoutSourceID` (one of several shapes, required): What the payout pays. Null when the row has no payout. * `1` - Bill * `2` - Ledger * `3` - Lease - One of: - Option 1: `payout_sources` - Option 2: null - `payoutTypeID` (one of several shapes, required): How the payout is paid. Null when the row has no payout. * `1` - Other * `2` - Check * `3` - eCheck (ACH) * `4` - NACHA (ACH) - One of: - Option 1: `payout_types` - Option 2: null - `otherPayoutTypeID` (one of several shapes, required): ID of the other payout type. Null when the row has no payout. - One of: - Option 1: `other_payout_types` - Option 2: null - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): ID of the portfolio. Null when the row has no payout. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): ID of the lease. Null when the row has no payout. - `amount` (string | null, decimal, required): The payout's amount. Null when the row has no payout. - `memo` (string | null, required, max length 200): The payout's memo. Null when the row has no payout. - `achStatusID` (one of several shapes, required): ID of the ach status. Null when the row has no payout. - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the bank account gateway. Null when the row has no payout. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): ID of the bank account gateway transaction. Null when the row has no payout. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): ID of the settlement. Null when the row has no payout. - `checkPayeeName` (string | null, required, max length 200): The payout's check payee name. Null when the row has no payout. - `destinationAccountNumberTruncated` (string | null, required, max length 4): The payout's destination account number truncated. Null when the row has no payout. - `checkNumber` (string | null, required, max length 100): The payout's check number. Null when the row has no payout. - `isVoided` (string | null, required, one of "0", "1", null): Whether the payout is voided. Null when the row has no payout. - `isOwnerDistribution` (string | null, required, one of "0", "1", null): Whether the payout is owner distribution. Null when the row has no payout. - `payoutOverrideID` (string | null, required, pattern `^-?[0-9]+$`): ID of the payout override. Null when the row has no payout. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): ID of the payout return. Null when the row has no payout. - `payeeCountryID` (string | null, required, max length 2): ID of the payee country. Null when the row has no payout. - `payeeAddress` (string | null, required, max length 100): The payout's payee address. Null when the row has no payout. - `payeeAddress2` (string | null, required, max length 100): The payout's payee address2. Null when the row has no payout. - `payeeCity` (string | null, required, max length 100): The payout's payee city. Null when the row has no payout. - `payeeStateID` (string | null, required, max length 3): ID of the payee state. Null when the row has no payout. - `payeePostalCode` (string | null, required, max length 30): The payout's payee postal code. Null when the row has no payout. - `isMoveOutTransaction` (string | null, required, one of "0", "1", null): Whether the payout is move out transaction. Null when the row has no payout. - `datePosted` (string | null, date, required): Date posted. Null when the row has no payout. - `dateTimeCreated` (string | null, required, read-only): Date time created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no payout. - `dateTimeLastPrinted` (string | null, required): Date time last printed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no payout. - `positivePaySyncID` (string | null, required, pattern `^-?[0-9]+$`): ID of the positive pay sync. Null when the row has no payout. ### included_deposit_release A deposit release: the part of a deposit-release credit drawn from one security-deposit liability account. - `depositReleaseID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the deposit release. - `depositReleaseCreditTransactionID` (string, required, pattern `^-?[0-9]+$`): ID of the deposit release credit transaction. - `leaseID` (string, required, pattern `^-?[0-9]+$`): ID of the lease. - `liabilityAccountID` (string, required, pattern `^-?[0-9]+$`): ID of the liability account. - `amount` (string, decimal, required): The deposit release's amount. ### lease_transaction_voided A lease transaction as the void endpoints return it: the record they just voided, sent from memory rather than re-read. It has the same keys as a read, but a few values the void and the save set in memory arrive as numbers (`isVoided`, `amountPaid`, `amountAllocated`, `isMoveInCharge`, `isProrated`, `isMoveOutTransaction`). - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the transaction. - `transactionTypeID` (`transaction_types`, required): Transaction type: * `1` - Lease Charge * `2` - Tenant Receipt * `3` - Lease Credit * `4` - Lease Payment Return * `5` - Owner Receipt * `6` - Owner Contribution Return * `7` - Bill Charge * `8` - Bill Payout Charge * `9` - Bank Fee * `10` - Bank Transfer * `11` - Journal Entry * `12` - Other Receipt * `13` - Other Payment Return * `14` - Management Fee * `15` - Ledger Transfer * `16` - Ledger Payout * `17` - Ledger Payout Return * `18` - Bill Payout Charge Return * `19` - Lease Deposit Release Credit * `20` - Lease Payout * `21` - Lease Payout Return * `22` - Bill Credit * `23` - Bill Credit Applied * `24` - Bill Credit Return * `25` - Lease Refunded Return - `managementFeeMode` (`management_fee_modes`, required): Management fee mode the account used when the transaction posted: * `1` - Ledger * `2` - Bill - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): Portfolio that owned the property when the transaction posted. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property of the transaction's lease. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit of the transaction's lease. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease the transaction belongs to. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill the transaction belongs to; null for lease transactions. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account the money moved through (payments, returns); null for charges and credits. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. - `equityAccountID` (string | null, required, pattern `^-?[0-9]+$`): Equity account that funds a refunded return (debited); null for other types. - `destinationBankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Destination bank account of a bank transfer; null for lease transactions. - `managementFeeIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of a management fee; null for lease transactions. - `prepaymentAccountFilterTypeID` (one of several shapes, required): Which charges the unapplied amount may later be applied to: * `1` - Any * `2` - None * `3` - Account - One of: - Option 1: `account_filter_types` - Option 2: null - `prepaymentAccountID` (string | null, required, pattern `^-?[0-9]+$`): Prepayment account chosen for a payment's unapplied amount, when the payment names one. - `unallocatedAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account that holds the unapplied (prepayment) amount of a payment or credit. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): Payout the transaction belongs to; null for lease charges, credits and payments. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): Payout return the transaction belongs to. - `amount` (string, decimal, required): Amount of the transaction, in its column's scale. - `amountPaid` (integer | null, required, one of 0, null): Amount of a charge paid so far. Only a charge with nothing applied can be voided, and the void sets this to the number `0` in memory. Null for types that don't track it. - `amountAllocated` (integer | null, required, one of 0, null): Amount of a payment or credit applied so far; the void voids its receipts and recomputes it in memory, so a voided credit sends the number `0`. Null for types that don't track it. - `processingFee` (string | null, decimal, required): Processing fee of an online payment. - `convenienceFee` (string | null, decimal, required): Convenience fee charged on an online payment. - `convenienceFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge that carries the convenience fee of an online payment. - `description` (string | null, required, max length 4000): Free-text description shown on the ledger. - `reference` (string | null, required, max length 200): External reference, such as a check number. - `receivedFrom` (string | null, required, max length 100): Name the payment was received from, when entered. - `returnTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Return transaction of a returned payment; null until the payment is returned. - `returnTypeID` (one of several shapes, required): Return reason code of an electronic payment return. - One of: - Option 1: `return_types` - Option 2: null - `returnDescription` (string | null, required, max length 200): Return reason text of an electronic payment return. - `bulkPaymentID` (string | null, required, pattern `^-?[0-9]+$`): Bulk payment (bulk receipt) the payment belongs to. - `paymentTypeID` (one of several shapes, required): How a payment was made: * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a bill-related transaction belongs to. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill credit a bill-related transaction belongs to. - `discountAmount` (string | null, decimal, required): Discount applied to a bill charge. - `markupAmount` (string | null, decimal, required): Markup applied to a bill charge. - `managementFeeAmountPaid` (string | null, decimal, required): Management fee taken from what was paid on this charge. - `isAdditionalManagementFee` (string | null, required, one of "0", "1", null): Whether the charge carries an additional management fee. - `managementFeePercent` (string | null, decimal, required): Management fee percent applied to this charge. - `isSuppressed` (string, required, one of "0", "1"): Whether the transaction is hidden from the tenant. - `managementFeeExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management fee. - `managementFeePeriodDate` (string | null, date, required): Management fee period the transaction counts toward. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): Sales tax on the management fee, paid so far. - `managementFeeSalesTaxPercent` (string | null, decimal, required): Sales tax percent on the management fee. - `managementFeeSalesTaxIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account of the management-fee sales tax. - `managementFeeSalesTaxExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account of the management-fee sales tax. - `managementFeeBatchID` (string | null, required, pattern `^-?[0-9]+$`): Management fee batch the transaction was billed in. - `isSalesTaxCharge` (string | null, required, one of "0", "1", null): Whether the charge is a sales tax charge. - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting of a sales tax charge. - `salesTaxInitiatedFromTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge a sales tax charge was raised from. - `isVoided` (integer, required, one of 1): Always `1`: the void sets it in memory, so this response sends a number where a read sends the string `'1'`. - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): Processor's transaction ID of an online payment. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): Processor settlement an online payment was paid out in. - `paymentAccountName` (string | null, required, max length 200): Name on the account an online payment came from. - `paymentAccountNumberTruncated` (string | null, required, max length 10): Last digits of the account an online payment came from. - `depositID` (string | null, required, pattern `^-?[0-9]+$`): Bank deposit the payment is in; a payment must be deposited before it can be returned. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Bank reconciliation the transaction was reconciled in. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Reconciliation the transaction was in before it was last unreconciled. - `achStatusID` (one of several shapes, required): Status of an ACH transfer. - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankTransferID` (string | null, required, pattern `^-?[0-9]+$`): Bank transfer the transaction belongs to. - `lateFeePeriod` (string | null, required, pattern `^-?[0-9]+$`): Late fee period a late-fee charge was raised for. - `isFromManager` (string | null, required, one of "0", "1", null): Whether a resident-portal transaction was entered by the manager. - `isMoveInCharge` (string | integer, required, one of 0, "1"): Whether this is a move-in charge. The save sets an empty value to the number `0` in memory, so this response sends `0` (a number) for no and the stored string `'1'` for yes. - `isProrated` (string | integer, required, one of 0, "1"): Whether this is a prorated charge. The save sets an empty value to the number `0` in memory, so this response sends `0` (a number) for no and the stored string `'1'` for yes. - `isMoveOutTransaction` (string | integer, required, one of 0, "1"): Whether this is a move-out transaction. The save sets an empty value to the number `0` in memory, so this response sends `0` (a number) for no and the stored string `'1'` for yes. - `moveOutAmount` (string | null, decimal, required): Amount counted toward the move-out statement. - `discountMarkupBillChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge a discount or markup belongs to. - `recurringObjectID` (string | null, required, pattern `^-?[0-9]+$`): Recurring charge or credit that raised the transaction. - `residentServiceID` (string | null, required, pattern `^-?[0-9]+$`): Resident service the charge is for. - `residentPackageID` (string | null, required, pattern `^-?[0-9]+$`): Resident package the charge is for. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): Tax agency of a withholding. - `withholdingTaxContactID` (string | null, required, pattern `^-?[0-9]+$`): Contact a withholding is held for. - `datePosted` (string, date, required): Date the transaction posts to the ledger. - `dateTimeCreated` (string, required, read-only): When the transaction was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): When the transaction was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### included_deposit A bank deposit, as the `deposit` include returns it (every column). - `depositID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the deposit. - `bankAccountID` (string, required, pattern `^-?[0-9]+$`): The bank account this deposit belongs to. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The reconciliation this deposit is linked to, or null if unreconciled. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): The previous reconciliation ID if the deposit was moved, or null. - `depositNumber` (string | null, required, max length 100): A user-assigned reference number for the deposit. - `description` (string | null, required, max length 1000): Optional free-text description. - `amount` (string, decimal, required): Total deposited amount as a decimal string. - `isVoided` (string, required, one of "0", "1"): `0` = active, `1` = voided. - `dateDeposited` (string, date, required): The date the deposit was made. - `dateTimeCreated` (string, required, read-only): Timestamp when the deposit record was created (MySQL datetime format, e.g. "2021-04-14 13:40:48"). UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### included_property_portfolio A property's ownership period: which portfolio owned the property from `startDate` to `endDate`. - `propertyPortfolioID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the property portfolio. - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): ID of the portfolio. - `isCurrent` (string, required, one of "0", "1"): Whether the ownership period is current. - `startDate` (string | null, date, required): The ownership period's start date. - `endDate` (string | null, date, required): The ownership period's end date. ### included_account_left_joined A chart-of-accounts account reached through a left join, as a receipt row's `chargeAccount` is: every column, all of them null when the row has no charge. - `accountID` (string | null, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the account. Null when the row has no account. - `parentAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the parent account for sub-accounts, if any. Null when the row has no account. - `accountTypeID` (one of several shapes, required): ID of the account type (e.g. income, expense, liability). Null when the row has no account. - One of: - Option 1: `account_types` - Option 2: null - `accountCategoryID` (string | null, required, pattern `^-?[0-9]+$`): ID of the account category, if assigned. Null when the row has no account. - `number` (string | null, required, max length 10): Chart-of-accounts number. Null when the row has no account. - `name` (string | null, required, max length 100): Display name of the account. Null when the row has no account. - `isActive` (string | null, required, one of "0", "1", null): Whether the account is active (`1` = active, `0` = inactive). Null when the row has no account. - `isSubjectToManagementFees` (string | null, required, one of "0", "1", null): Whether charges posted to this account are subject to management fees (`1` = yes, `0` = no). Null when the row has no account. - `isSubjectToLateFees` (string | null, required, one of "0", "1", null): Whether charges posted to this account are subject to late fees (`1` = yes, `0` = no). Null when the row has no account. - `isDeposit` (string | null, required, one of "0", "1", null): Whether this account is a deposit account (`1` = yes, `0` = no). Null when the row has no account. - `depositTypeID` (one of several shapes, required): Deposit type ID if `isDeposit = 1`, otherwise null. - One of: - Option 1: `deposit_types` - Option 2: null - `isEscrow` (string | null, required, one of "0", "1", null): Whether this account holds escrow funds (`1` = yes, `0` = no). Null when the row has no account. - `isRent` (string | null, required, one of "0", "1", null): Whether this account is classified as rent (`1` = yes, `0` = no). Null when the row has no account. - `isSubsidized` (string | null, required, one of "0", "1", null): Whether this account is subsidized (`1` = yes, `0` = no). Null when the row has no account. - `isTaxable` (string | null, required, one of "0", "1", null): Whether charges to this account are taxable (`1` = yes, `0` = no). If left blank, it will default to `1`. Null when the row has no account. - `isSubjectToSalesTax` (string | null, required, one of "0", "1", null): Whether charges are subject to sales tax (`1` = yes, `0` = no). Null when the row has no account. - `isSubjectToMarkup` (string | null, required, one of "0", "1", null): Whether charges to this account can be marked up (`1` = yes, `0` = no). If left blank, it will default to `1`. Null when the row has no account. - `isPrepayment` (string | null, required, one of "0", "1", null): Whether this account is for prepayments (`1` = yes, `0` = no). Null when the row has no account. - `isManagementFee` (string | null, required, one of "0", "1", null): Whether this account represents a management fee (`1` = yes, `0` = no). Null when the row has no account. - `isBudgetEnabled` (string | null, required, one of "0", "1", null): Whether budget tracking is enabled for this account (`1` = yes, `0` = no). Null when the row has no account. - `isHeld` (string | null, required, one of "0", "1", null): Whether funds in this account are held (`1` = yes, `0` = no). If left blank, it will default to `1` for new liability accounts. Null when the row has no account. - `bankName` (string | null, required, max length 100): Bank name for bank-type accounts, otherwise null. - `bankAccountTypeID` (one of several shapes, required): Bank account type ID (e.g. checking, savings) for bank accounts, otherwise null. - One of: - Option 1: `bank_account_types` - Option 2: null - `bankAccountCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): Encrypted bank account identifier. Always null in API responses for security. - `bankAccountNumberTruncated` (string | null, required, max length 4): Last 4 digits of the bank account number, if available. Null when the row has no account. - `bankAccountAddress` (string | null, required, max length 100): Bank account mailing address line 1. Null when the row has no account. - `bankAccountAddress2` (string | null, required, max length 100): Bank account mailing address line 2. Null when the row has no account. - `bankAccountCity` (string | null, required, max length 100): Bank account mailing city. Null when the row has no account. - `bankAccountStateID` (string | null, required, max length 3): Bank account mailing state code. Null when the row has no account. - `bankAccountPostalCode` (string | null, required, max length 20): Bank account mailing postal code. Null when the row has no account. - `bankAccountCountryID` (string | null, required, max length 3): Bank account mailing country code. Null when the row has no account. - `isCheckingEnabled` (string | null, required, one of "0", "1", null): Whether check printing is enabled for this account (`1` = yes, `0` = no). Null when the row has no account. - `checkCompanyName` (string | null, required, max length 100): Company name printed on checks, if check printing is enabled. Null when the row has no account. - `checkSignatory` (string | null, required, max length 100): Signatory name printed on checks. Null when the row has no account. - `checkAddress` (string | null, required, max length 100): Check mailing address line 1. Null when the row has no account. - `checkAddress2` (string | null, required, max length 100): Check mailing address line 2. Null when the row has no account. - `checkCity` (string | null, required, max length 100): Check mailing city. Null when the row has no account. - `checkStateID` (string | null, required, max length 3): Check mailing state code. Null when the row has no account. - `checkPostalCode` (string | null, required, max length 20): Check mailing postal code. Null when the row has no account. - `checkCountryID` (string | null, required, max length 3): Check mailing country code. Null when the row has no account. - `bankAccountNextCheckNumber` (string | null, required, max length 25): Next check number for this bank account. Null when the row has no account. - `bankAccountNextDepositNumber` (string | null, required, max length 25): Next deposit number for this bank account. Null when the row has no account. - `checkTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the check template assigned to this account. Null when the row has no account. - `creditCardGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the credit card payment gateway associated with this account. Null when the row has no account. - `achGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the ACH payment gateway associated with this account. Null when the row has no account. - `cashCardGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the cash card gateway associated with this account. Null when the row has no account. - `remoteCheckGatewayID` (string | null, required, pattern `^-?[0-9]+$`): ID of the remote check gateway associated with this account. Null when the row has no account. - `isFromImport` (string | null, required, one of "0", "1", null): Whether this account was created via import (`1` = yes, `0` = no). Null when the row has no account. - `importSourceKey` (string | null, required, max length 100): Import source key if the account came from an import, otherwise null. - `isNachaEnabled` (string | null, required, one of "0", "1", null): Whether NACHA (ACH) is enabled for this account (`1` = yes, `0` = no). Null when the row has no account. - `isNachaFileBalanced` (string | null, required, one of "0", "1", null): Whether NACHA files for this account are balanced (`1` = yes, `0` = no). Null when the row has no account. - `nachaOriginName` (string | null, required, max length 100): NACHA origination company name. Null when the row has no account. - `nachaOriginNumber` (string | null, required, max length 20): NACHA origination routing/transit number. Null when the row has no account. - `nachaDestinationName` (string | null, required, max length 100): NACHA destination institution name. Null when the row has no account. - `nachaDestinationNumber` (string | null, required, max length 20): NACHA destination routing/transit number. Null when the row has no account. - `nachaCompanyIdentification` (string | null, required, max length 20): NACHA company identification number. Null when the row has no account. - `nachaCompanyName` (string | null, required, max length 100): NACHA company name in batch headers. Null when the row has no account. - `nachaOriginatingFinancialInstitutionID` (string | null, required, max length 20): ID of the originating financial institution for NACHA. Null when the row has no account. - `nachaAdapterID` (string | null, required, pattern `^-?[0-9]+$`): ID of the NACHA adapter. Null when the row has no account. - `isBillApprovalExempt` (string | null, required, one of "0", "1", null): Whether bills posted to this account are exempt from approval (`1` = yes, `0` = no). Null when the row has no account. - `exportInvoiceServiceName` (string | null, required, max length 100): Service name used when exporting invoices for this account. Null when the row has no account. - `dateTimeCreated` (string | null, required, read-only): Timestamp when the account was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no account. - `dateTimeModified` (string | null, required, read-only): Timestamp when the account was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. Null when the row has no account. - `dateTimeDeactivated` (string | null, required): Timestamp when the account was deactivated, or null if still active. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease_receipt_row One receipt row of a `receipts` include: the receipt, and the charge, the charge's account and the refund payout it applies to, each reached through a left join, so the ones a receipt doesn't have arrive with every value null (a charge receipt has no payout; a refund receipt has no charge or charge account). - `receipt` (`included_receipt`, required) - `charge` (`included_transaction_left_joined`, required) - `chargeAccount` (`included_account_left_joined`, required) - `payout` (`included_payout_left_joined`, required) ### management_fee_record_types * `1` - Charge * `2` - Bill * `3` - Credit ### included_management_fee A management fee record, as the `managementFees` include returns it (every column). Typed from the table: every capture of these operations had the include empty (see the operation's description). - `managementFeeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the management fee record. - `managementFeeRecordTypeID` (`management_fee_record_types`, required): What the record is for (a charge receipt, an additional fee, ...). * `1` - Charge * `2` - Bill * `3` - Credit - `period` (string, required, max length 6): Fee period, `YYYYMM`. - `transactionID` (string | null, required, pattern `^-?[0-9]+$`): Transaction the fee was taken on. - `receiptID` (string | null, required, pattern `^-?[0-9]+$`): Receipt the fee was taken on. - `primaryLedgerID` (string, required, pattern `^-?[0-9]+$`): Ledger the fee posts to. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): Portfolio the fee is charged to. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property the fee is for. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit the fee is for. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease the fee is for. - `accountID` (string, required, pattern `^-?[0-9]+$`): Account the fee income posts to. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill the fee was billed on (bill mode). - `amount` (string, decimal, required): Fee amount. - `datePosted` (string, required): When the fee posted. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isAdditionalManagementFee` (string, required, one of "0", "1"): Whether this is an additional management fee. - `isSuppressed` (string, required, one of "0", "1"): Whether the fee is hidden from statements. - `isVoided` (string, required, one of "0", "1"): Whether the fee is voided. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill credit that carried the fee. - `salesTaxAmount` (string, decimal, required): Sales tax on the fee. - `salesTaxAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account the sales tax posts to. - `salesTaxBillCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill credit that carried the sales tax. - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied. ### lease_payment_view A lease payment as the payment endpoints return it: the payment under `transaction`, plus one key per requested include. - `transaction` (`lease_transaction`, required) - `deposit` (one of several shapes): The bank deposit the payment is in, with the `deposit` include; `false` when it isn't in one. A void takes the payment out of its deposit, so after a void this is always `false`. - One of: - Option 1: `included_deposit` - Option 2: boolean - `contact` (`included_contact`): The paying tenant's contact, with the `contact` include. - `lease` (`included_lease`): The payment's lease, with the `lease` include. - `portfolio` (`included_portfolio`): The portfolio the payment posted to, with the `portfolio` include. - `property` (`included_property`): The lease's property, with the `property` include. - `unit` (`included_unit`): The lease's unit, with the `unit` include. - `propertyPortfolios` (`included_property_portfolio`[]): Every ownership period of the lease's property, with the `propertyPortfolios` include. - `returnTransaction` (one of several shapes): The payment's return transaction, with the `returnTransaction` include; null until the payment is returned. - One of: - Option 1: `lease_transaction` - Option 2: null - `bulkPayment` (one of several shapes): The bulk payment (bulk receipt) the payment belongs to, with the `bulkPayment` include; null when none. - One of: - Option 1: `included_bulk_payment` - Option 2: null - `transactionLogs` (object[]): The payment's change log, with the `transactionLogs` include. - `transactionLog` (`included_transaction_log`, required) - `token` (string, required, pattern `^[0-9]+$`): The current Unix time, as a string of digits; added by the search when it selects one table. - `receipts` (`lease_receipt_row`[]): The payment's receipts that aren't voided, with the `receipts` include. A void voids every receipt and a return voids the charge receipts, so after either only refund receipts can remain. - `managementFees` (`included_management_fee`[]): The management fees taken on the payment that aren't voided, with the `managementFees` include. Voiding a receipt voids its fees, so after a void or a return this is empty in every case the contract tests and the live call produced. ### ledger_types_request * `1` - Manager * `2` - Portfolio * `3` - Property * `4` - Unit ### journal_entry_request A journal entry: the ledger it posts on, its date and description, and at least two balanced lines. The API reads only these keys and ignores any other. `{}` counts as an empty body. - `ledgerID` (string | integer, required, pattern `^-?[0-9]+$`): The ledger to post on, from `GET /accounting/ledgers/search`. A property or unit ledger posts on its portfolio's ledger with the property (and unit) recorded on the entry; a manager ledger has no portfolio. - `datePosted` (string, required): The date the entry posts on, `YYYY-MM-DD` (`MM/DD/YYYY` is read too). - `description` (string, required, max length 4000): What the entry is for. - `entries` (object[], required): The entry's lines. Each line either debits or credits one account; the debits must add up to the credits, and that total is the entry's `amount`. - `accountID` (string | integer, required, pattern `^-?[0-9]+$`): The chart-of-accounts account the line posts to, from `GET /accounting/accounts`. - `description` (string | null, max length 4000): The line's description. - `debit` (string | number, decimal): The amount the line debits. Send it, or `credit`, not both. - `credit` (string | number, decimal): The amount the line credits. Send it, or `debit`, not both. ### journal_entry_voided A journal entry as the void returns it: the transaction it just voided, sent from memory rather than re-read. It has the keys of the transaction `GET /accounting/transactions/{transactionID}` returns, but four values the void and the save set in memory arrive as JSON numbers: `isVoided` (`1`), `isMoveInCharge`, `isProrated` and `isMoveOutTransaction` (`0`). - `transactionID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the transaction. - `transactionTypeID` (`transaction_types`, required) - `managementFeeMode` (`management_fee_modes`, required): Management fee calculation mode applied to this transaction. * `1` - Ledger * `2` - Bill - `primaryLedgerID` (string | null, required, pattern `^-?[0-9]+$`): The ledger the transaction posts on (`accounting_ledgers`: a manager or portfolio ledger), not a bank account; null on types that have none, such as a ledger transfer. - `portfolioID` (string | null, required, pattern `^-?[0-9]+$`): Portfolio this transaction belongs to. - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): Property associated with this transaction. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): Unit associated with this transaction. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): Lease this transaction is posted against. - `billID` (string | null, required, pattern `^-?[0-9]+$`): Bill linked to this transaction, if any. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): The contact (tenant, owner or vendor) the transaction belongs to, or null. - `bankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Bank account the payment was deposited into, if applicable. - `chargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Chart-of-account ID the charge posts against (present for charge transactions). - `equityAccountID` (string | null, required, pattern `^-?[0-9]+$`): Equity account ID, if applicable. - `destinationBankAccountID` (string | null, required, pattern `^-?[0-9]+$`): Destination bank account for transfer transactions. - `managementFeeIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account used for management fee recording. - `prepaymentAccountFilterTypeID` (one of several shapes, required): Filter type controlling which prepayment account is used. * `1` - Any * `2` - None * `3` - Account - One of: - Option 1: `account_filter_types` - Option 2: null - `prepaymentAccountID` (string | null, required, pattern `^-?[0-9]+$`): Prepayment/unapplied account ID. Use `-1` to apply to the default prepayment account. - `unallocatedAccountID` (string | null, required, pattern `^-?[0-9]+$`): Account used to hold unallocated payment funds. - `payoutID` (string | null, required, pattern `^-?[0-9]+$`): Payout linked to this transaction, if any. - `payoutReturnID` (string | null, required, pattern `^-?[0-9]+$`): Payout return linked to this transaction, if any. - `amount` (string, decimal, required): Transaction amount as a decimal string. - `amountPaid` (string | null, decimal, required): Amount of the charge that has been paid so far. - `amountAllocated` (string | null, decimal, required): Portion of a payment that has been applied to charges. - `processingFee` (string | null, decimal, required): Processing fee amount collected on this payment, if any. - `convenienceFee` (string | null, decimal, required): Convenience fee charged on online payments. - `convenienceFeeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Transaction ID of the associated convenience fee transaction. - `description` (string | null, required, max length 4000): Free-text label for this transaction. - `reference` (string | null, required, max length 200): External reference number (e.g. check number, ACH trace ID). - `receivedFrom` (string | null, required, max length 100): Name of the payer as recorded on the transaction. - `returnTransactionID` (string | null, required, pattern `^-?[0-9]+$`): On a transaction that was returned (a payment), the ID of the return transaction that reversed it; null otherwise. The `returnedTransaction` include follows the link the other way. - `returnTypeID` (one of several shapes, required): Return type code when this is a returned payment. * `1` - Insufficient Funds * `2` - Bad Account * `3` - Returned * `4` - Other - One of: - Option 1: `return_types` - Option 2: null - `returnDescription` (string | null, required, max length 200): Reason for the return. - `bulkPaymentID` (string | null, required, pattern `^-?[0-9]+$`): Bulk payment batch this transaction belongs to, if any. - `paymentTypeID` (one of several shapes, required): How the payment was made, or null on a transaction that isn't a payment. * `1` - eCheck * `2` - Credit Card * `3` - Check * `4` - Money Order * `5` - Cash * `6` - Other * `7` - Cash Pay * `8` - Cashier's Check - One of: - Option 1: `payment_types` - Option 2: null - `billChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Charge transaction on a bill that this payment is applied to. - `billCreditTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Credit transaction on a bill associated with this transaction. - `discountAmount` (string | null, decimal, required): Discount amount applied to this transaction. - `markupAmount` (string | null, decimal, required): Markup amount applied to this transaction. - `managementFeeAmountPaid` (string | null, decimal, required): Management fee portion that has been paid. - `isAdditionalManagementFee` (string | null, required, one of "0", "1", null): Whether this transaction is an additional management fee charge (`1` = yes, `0` = no). - `managementFeePercent` (string | null, decimal, required): Management fee percentage applied to this transaction. - `isSuppressed` (string, required, one of "0", "1"): Whether this transaction is suppressed from certain reports (`1` = yes, `0` = no). - `managementFeeExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account used for management fee disbursements. - `managementFeePeriodDate` (string | null, date, required): Period date for management fee calculation. - `managementFeeSalesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to the management fee on this transaction. - `managementFeeSalesTaxAmountPaid` (string | null, decimal, required): Sales tax amount on the management fee that has been paid. - `managementFeeSalesTaxPercent` (string | null, decimal, required): Sales tax percentage applied to the management fee. - `managementFeeSalesTaxIncomeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Income account for management fee sales tax. - `managementFeeSalesTaxExpenseAccountID` (string | null, required, pattern `^-?[0-9]+$`): Expense account for management fee sales tax. - `managementFeeBatchID` (string | null, required, pattern `^-?[0-9]+$`): Management fee batch this transaction belongs to, if any. - `isSalesTaxCharge` (string | null, required, one of "0", "1", null): Whether this transaction is a sales tax charge (`1` = yes, `0` = no). - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): Sales tax setting applied to this charge transaction. - `salesTaxInitiatedFromTransactionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the parent transaction that triggered this sales tax charge. - `isVoided` (integer, required, one of 1): Always `1`, as a JSON number. - `bankAccountGatewayID` (string | null, required, pattern `^-?[0-9]+$`): Payment gateway ID associated with the bank account. - `bankAccountGatewayTransactionID` (string | null, required, max length 100): Gateway-assigned transaction identifier. - `settlementID` (string | null, required, pattern `^-?[0-9]+$`): Settlement batch this transaction was settled in. - `paymentAccountName` (string | null, required, max length 200): Bank account name of the payer (for ACH/card transactions). - `paymentAccountNumberTruncated` (string | null, required, max length 10): Last 4 digits of the payer's account number. - `depositID` (string | null, required, pattern `^-?[0-9]+$`): Deposit batch this payment was included in. - `reconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Bank reconciliation this transaction has been reconciled in. - `previousReconciliationID` (string | null, required, pattern `^-?[0-9]+$`): Previous reconciliation ID if the transaction was moved between reconciliations. - `achStatusID` (one of several shapes, required): ACH processing status code for electronic payments. * `1` - Created * `2` - Batched * `3` - Settled * `4` - Returned * `5` - Failed - One of: - Option 1: `transaction_statuses` - Option 2: null - `bankTransferID` (string | null, required, pattern `^-?[0-9]+$`): Bank transfer record ID for ACH transactions. - `lateFeePeriod` (string | null, required, pattern `^-?[0-9]+$`): On a late fee charge, the period the late fee was assessed for; null otherwise. - `isFromManager` (string | null, required, one of "0", "1", null): Whether this transaction was entered directly by a manager (`1` = yes, `0` = no). - `isMoveInCharge` (integer, required, one of 0): Always `0` on a journal entry, as a JSON number. - `isProrated` (integer, required, one of 0): Always `0` on a journal entry, as a JSON number. - `isMoveOutTransaction` (integer, required, one of 0): Always `0` on a journal entry, as a JSON number. - `moveOutAmount` (string | null, decimal, required): Amount applied during move-out settlement. - `discountMarkupBillChargeTransactionID` (string | null, required, pattern `^-?[0-9]+$`): Bill charge transaction ID for discount or markup adjustments. - `recurringObjectID` (string | null, required, pattern `^-?[0-9]+$`): Recurring charge object that generated this transaction, if any. - `residentServiceID` (string | null, required, pattern `^-?[0-9]+$`): ID of the service this record points to. - `residentPackageID` (string | null, required, pattern `^-?[0-9]+$`): ID of the package this record points to. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): Tax agency for withholding tax, if applicable. - `withholdingTaxContactID` (string | null, required, pattern `^-?[0-9]+$`): Contact associated with withholding tax, if applicable. - `datePosted` (string, date, required): Date the transaction was posted to the ledger. - `dateTimeCreated` (string, required, read-only): Timestamp when the transaction record was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the transaction record was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### contact_record A contact: every column of the row, plus the computed `contactType`. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the contact. - `contactTypeID` (`contact_types`, required): Contact type: `1` Owner, `2` Tenant, `3` Vendor, `4` Manager, `5` Association, `6` Applicant, `7` Screening Prospect, `8` Internal Technician (maintenance technician), `9` Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its `includeManager`, `includeMaintenanceTechnician` or `contactIDs[]` adds. - `vendorTypeID` (string | null, required, pattern `^-?[0-9]+$`): Vendor type, from `GET /contacts/vendor-types` (undocumented). Kept for vendors and maintenance technicians; null for other contact types. - `code` (string | null, required, max length 100): Optional short code or reference for the contact. - `name` (string, required, max length 100): Full display name. - `firstName` (string | null, required, max length 100): First name, parsed from `name` on every save for owners and tenants (and applicants); null for every other contact type. - `middleName` (string | null, required, max length 100): Middle name, parsed from `name` like `firstName`; null for types other than owners and tenants. - `lastName` (string | null, required, max length 100): Last name, parsed from `name` like `firstName`; null for types other than owners and tenants. - `suffix` (string | null, required, max length 15): Name suffix, parsed from `name` like `firstName`; null for types other than owners and tenants. - `email` (string | null, required, max length 100): Primary email address on the contact record. - `phone` (string | null, required, max length 20): Primary phone number on the contact record. - `countryID` (string | null, required, max length 2): Two-letter country code of the contact address. - `address` (string | null, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line. - `city` (string | null, required, max length 45): City. - `stateID` (string | null, required, max length 3): State or province code. - `postalCode` (string | null, required, max length 30): Postal code. - `birthDate` (string | null, date, required): Date of birth. - `defaultBillChargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save). - `payeeName` (string | null, required, max length 100): Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save. - `taxPayerName` (string | null, required, max length 100): Name printed on tax forms; null for maintenance technicians. - `taxFormTypeID` (one of several shapes, required): Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians. - One of: - Option 1: `form_types` - Option 2: null - `identificationTypeID` (one of several shapes, required): Type of identification on file, or null. - One of: - Option 1: `identification_types` - Option 2: null - `identificationNumber` (string | null, required, max length 50): Identification number. - `identificationCountryID` (string | null, required, max length 2): Two-letter code of the country that issued the identification. - `identificationIssuingLocation` (string | null, required, max length 100): Where the identification was issued. - `identificationExpirationDate` (string | null, date, required): Identification expiry date. - `payoutTypeID` (one of several shapes, required): How the contact is paid. A few older maintenance-technician rows store `0` (no payout type). - One of: - Option 1: `payout_types` - Option 2: string - `otherPayoutTypeID` (one of several shapes, required): How the contact is paid outside Rentvine when `payoutTypeID` is `1` (Other), or null; always null for maintenance technicians. - One of: - Option 1: `other_payout_types` - Option 2: null - `achDetailsCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians. - `achAccountNumberTruncated` (string | null, required, max length 4): Last 4 digits of the ACH account number; null for maintenance technicians. - `achAccountTypeID` (one of several shapes, required): ACH bank account type, or null; always null for maintenance technicians. - One of: - Option 1: `bank_account_types` - Option 2: null - `achIsCorporateAccount` (string, required, one of "0", "1"): `1` if the ACH account is a corporate account. - `holdPayments` (string, required, one of "0", "1"): `1` if payouts to the contact are on hold. Always `0` for tenants and maintenance technicians. - `liabilityInsuranceName` (string | null, required, max length 100): Liability insurer (vendors and associations; null for other contact types, which the API clears on save). - `liabilityInsurancePolicyNumber` (string | null, required, max length 50): Liability policy number (vendors and associations; null for other contact types, which the API clears on save). - `liabilityInsuranceExpiresDate` (string | null, required): Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), `YYYY-MM-DD`. A few older rows store `0000-00-00`. - `workersCompInsuranceName` (string | null, required, max length 100): Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save). - `workersCompInsurancePolicyNumber` (string | null, required, max length 50): Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save). - `workersCompInsuranceExpiresDate` (string | null, date, required): Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save). - `discountPercent` (string | null, decimal, required): Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save). - `discountAmount` (string | null, decimal, required): Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with `discountPercent`. - `discountAmountMin` (string | null, decimal, required): Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save). - `discountAmountMax` (string | null, decimal, required): Largest discount applied (vendors and associations; null for other contact types, which the API clears on save). - `discountGraceDays` (string | null, required, pattern `^-?[0-9]+$`): Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save). - `isActive` (string, required, one of "0", "1"): `1` if the contact is active, `0` if deactivated. - `isInsuranceRequiredForPayment` (string | null, required, one of "0", "1", null): `1` if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store `0`. - `maxLineItemsOnPayment` (string | null, required, pattern `^-?[0-9]+$`): Maximum number of bill line items allowed per payment, or null. - `preventConsolidatedPayments` (string, required, one of "0", "1"): `1` to prevent consolidated payouts. - `isFromImport` (string, required, one of "0", "1"): `1` if the record came from an import. - `importSourceKey` (string | null, required, max length 100): Key of the record in the import it came from, or null. - `websiteUrl` (string | null, required, max length 500): Website address, or null; always null for maintenance technicians. - `applicantID` (string | null, required, pattern `^-?[0-9]+$`): The applicant this contact was converted from, or null. - `ownerPortalNameOverride` (string | null, required, max length 100): Display name shown in the owner portal instead of `name` (vendors and associations; null for other contact types, which the API clears on save). - `isBillApprovalExempt` (string, required, one of "0", "1"): `1` if bills for this contact skip the bill approval workflow. - `isBillingSalesTaxEnabled` (string, required, one of "0", "1"): `1` if sales tax is enabled for invoices billed from this contact. Always `0` except for vendors and associations. - `isQuickbooksExportEnabled` (string, required, one of "0", "1"): `1` if QuickBooks export is enabled for this contact. Always `0` except for vendors and managers. - `quickbooksCustomerName` (string | null, required, max length 100): Name used for the contact in QuickBooks; null except for vendors and managers. - `invoiceAutofillTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians. - `dateTimeCreated` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (string, required, one of "Owner", "Tenant", "Vendor", "Manager", "Association", "Applicant", "Screening Prospect", "Internal Technician", "Owner Lead"): The contact type's label, computed in PHP: `Owner`, `Tenant`, `Vendor`, `Association`, `Internal Technician` (maintenance technicians), and `Manager` for a manager row a list adds. ### contact_list_item One row of a contact list: the contact row under `contact`, and a `token`. - `contact` (`contact_record`, required) - `token` (string, required, pattern `^-?[0-9]+$`): The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. ### payout_types_request * `1` - Other * `2` - Check * `3` - eCheck (ACH) * `4` - NACHA (ACH) ### contact - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (`contact_types`, required) - `vendorTypeID` (string | null, pattern `^-?[0-9]+$`) - `name` (string, required) - `firstName` (string | null) - `middleName` (string | null) - `lastName` (string | null) - `suffix` (string | null) - `emails` (string | null) - `phones` (string | null) - `addresses` (string | null) - `birthDate` (string | null, date) - `defaultBillChargeAccountID` (string | null, pattern `^-?[0-9]+$`) - `taxPayerName` (string | null) - `taxFormTypeID` (string | null, pattern `^-?[0-9]+$`) - `payoutTypeID` (`payout_types`, required) - `achDetailsCiphertextID` (string | null, pattern `^-?[0-9]+$`) - `achAccountNumberTruncated` (string | null) - `achAccountTypeID` (one of several shapes) - One of: - Option 1: `bank_account_types` - Option 2: null - `achIsCorporateAccount` (string, required, pattern `^-?[0-9]+$`) - `holdPayments` (string, required, pattern `^-?[0-9]+$`) - `liabilityInsuranceName` (string | null) - `liabilityInsurancePolicyNumber` (string | null) - `liabilityInsuranceExpiresDate` (string | null, date) - `workersCompInsuranceName` (string | null) - `workersCompInsurancePolicyNumber` (string | null) - `workersCompInsuranceExpiresDate` (string | null, date) - `discountPercent` (string | null, decimal) - `discountGraceDays` (string | null, pattern `^-?[0-9]+$`) - `isActive` (string, required, one of "0", "1") - `isInsuranceRequiredForPayment` (string | null, one of "0", "1", null) - `preventConsolidatedPayments` (string, required, pattern `^-?[0-9]+$`) - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null) - `websiteUrl` (string | null) - `applicantID` (string | null, pattern `^-?[0-9]+$`) ### tax_identifier_types_request * `1` - SSN * `2` - ITIN * `3` - EIN * `4` - Foreign Tax ID * `99` - Unknown ### tax_identifier_types * `1` - SSN * `2` - ITIN * `3` - EIN * `4` - Foreign Tax ID * `99` - Unknown ### contact_search_item One row of a contact search. - `contact` (object, required): The contact columns the search selects, plus values computed in SQL. - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the contact. - `contactTypeID` (`contact_types`, required): The contact type (`1` Owner, `2` Tenant, `3` Vendor, `4` Manager, `5` Association, `8` Internal Technician): the endpoint's, or a manager or maintenance-technician row `includeManager` or `includeMaintenanceTechnician` adds. - `vendorTypeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the vendor type this record points to. - `name` (string, required, max length 100): Display name. - `email` (string | null, required, max length 100): Primary email address, or null. - `phone` (string | null, required, max length 20): Primary phone, or null. - `address` (string | null, required, max length 100): Street address, or null. - `address2` (string | null, required, max length 100): Second address line, or null. - `city` (string | null, required, max length 45): City, or null. - `stateID` (string | null, required, max length 3): State or province code, or null. - `postalCode` (string | null, required, max length 30): Postal code, or null. - `countryID` (string | null, required, max length 2): ID of the country this record points to. - `birthDate` (string | null, date, required): Date of birth, or null. - `defaultBillChargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the account this record points to. - `payeeName` (string | null, required, max length 100): Name payouts are made out to, or null. - `taxPayerName` (string | null, required, max length 100): Name on tax forms, or null. - `taxFormTypeID` (one of several shapes, required): Tax form issued to the contact (1099-MISC or 1042), or null. - One of: - Option 1: `form_types` - Option 2: null - `payoutTypeID` (one of several shapes, required): How the contact is paid. A few older maintenance-technician rows store `0` (no payout type). - One of: - Option 1: `payout_types` - Option 2: string - `achDetailsCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): ID of the ciphertext this record points to. - `achAccountNumberTruncated` (string | null, required, max length 4): Last four digits of the bank account, or null. - `achAccountTypeID` (one of several shapes, required): Bank account type, or null. - One of: - Option 1: `bank_account_types` - Option 2: null - `holdPayments` (string, required, one of "0", "1"): `1` when payouts to the contact are on hold. - `liabilityInsuranceName` (string | null, required, max length 100): Liability insurer (vendors and associations; null for other types). - `liabilityInsurancePolicyNumber` (string | null, required, max length 50): Liability policy number, or null. - `liabilityInsuranceExpiresDate` (string | null, required): Liability insurance expiry date (`YYYY-MM-DD`), or null. A few older rows store `0000-00-00`. - `isBillingSalesTaxEnabled` (string, required, one of "0", "1"): `1` when sales tax is billed for the contact. - `daysUntilLiabilityInsuranceExpires` (string | null, required, pattern `^-?[0-9]+$`): Days from today (the account's local date) until `liabilityInsuranceExpiresDate`, negative once it has passed; null without a date. Computed in SQL. - `workersCompInsuranceName` (string | null, required, max length 100): Workers' comp insurer (vendors and associations; null for other types). - `workersCompInsurancePolicyNumber` (string | null, required, max length 50): Workers' comp policy number, or null. - `workersCompInsuranceExpiresDate` (string | null, date, required): Workers' comp insurance expiry date, or null. - `daysUntilWorkersCompInsuranceExpires` (string | null, required, pattern `^-?[0-9]+$`): Days from today until `workersCompInsuranceExpiresDate`, negative once it has passed; null without a date. Computed in SQL. - `insuranceExpiresDate` (string | null, required): The earlier of the two insurance expiry dates (SQL `LEAST`), `YYYY-MM-DD`, so null whenever either date is null, and `0000-00-00` when an older row stores that. Computed in SQL. - `daysUntilInsuranceExpires` (string | null, required, pattern `^-?[0-9]+$`): Days from today until the earlier of the two insurance expiry dates, using whichever date is set when only one is; null when neither is. Computed in SQL. - `discountPercent` (string | null, decimal, required): Early-payment discount percentage (vendors and associations), or null. - `discountGraceDays` (string | null, required, pattern `^-?[0-9]+$`): Days within which the discount applies, or null. - `isActive` (string, required, one of "0", "1"): `1` for an active contact. - `invoiceAutofillTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the invoice autofill template this record points to. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isInsuranceRequiredForPayment` (string | null, required, one of "0", "1", null): `1` when the vendor must have current insurance to be paid; null for types that don't carry it, though a few older rows of those types store `0`. - `identificationTypeID` (one of several shapes, required): Type of identification on file, or null. - One of: - Option 1: `identification_types` - Option 2: null - `identificationNumber` (string | null, required, max length 50): Identification number, or null. - `identificationIssuingLocation` (string | null, required, max length 100): Where the identification was issued, or null. - `identificationExpirationDate` (string | null, date, required): Identification expiry date, or null. - `identificationCountryID` (string | null, required, max length 2): ID of the country this record points to. - `hasTaxIdentifier` (string, required, one of "0", "1"): `1` when the contact has a stored tax identifier. The identifier itself is never returned here. - `isTaxIdentifierValid` (string, required, one of "0", "1"): `1` when the stored tax identifier passed validation; `0` without one. - `taxIdentifierTypeID` (one of several shapes, required): Type of the stored tax identifier, or null without one. A few older rows have an identifier but no type. - One of: - Option 1: `tax_identifier_types` - Option 2: null - `taxIdentifierCountryID` (string | null, required, max length 2): Two-letter code of the country that issued the tax identifier, or null. - `hasDuplicateTaxIdentifier` (string, required, one of "0", "1"): `1` when another contact on the account stores the same tax identifier. - `propertyCount` (string, required, pattern `^-?[0-9]+$`): Number of properties the contact is linked to as their association. Normally only associations are linked, so other types usually show `0`. Computed in SQL. - `search` (object): Sent only when `search` is given: the row's match rank. - `rank` (string, required, one of "0", "1", "10"): `10` when the name starts with the search text exactly as sent (spaces included), `1` when the name matches the text with each run of spaces read as a wildcard, `0` when only another field matched. Computed in SQL. ### contact_detail The contact: every column of the row plus the computed `contactType`, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here. - All of: - Option 1: `contact_record` - Option 2: object - `hasTaxIdentifier` (integer, required, one of 0, 1): `1` when the contact has a stored tax identifier. A JSON number, set in PHP. - `isTaxIdentifierValid` (string | integer, required, one of "0", "1", 0): Whether the stored tax identifier passed validation: the string `"0"` or `"1"` from the stored row, or the number `0` when the contact has no stored identifier. - `taxIdentifierTypeID` (one of several shapes, required): Type of the stored tax identifier, or null without one. A few older rows have an identifier but no type. - One of: - Option 1: `tax_identifier_types` - Option 2: null - `taxIdentifierCountryID` (string | null, required, max length 2): Two-letter code of the country that issued the tax identifier, or null. ### contact_email_row One row of the `emails` include: the contact's email address, under `email`. - `email` (object, required): The email row. - `contactEmailID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the email row. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `isPrimary` (string, required, one of "0", "1"): `1` for the contact's primary email. - `email` (string, required, max length 100): The email address. - `sendEmailNotifications` (string, required, one of "0", "1"): `1` when general notifications go to this address. - `sendPaymentNotifications` (string, required, one of "0", "1"): `1` when payment notifications go to this address. - `sendWorkOrderNotifications` (string, required, one of "0", "1"): `1` when work order notifications go to this address. ### phone_types * `1` - Mobile * `2` - Home * `3` - Work * `4` - Fax * `5` - Other ### contact_phone_row One row of the `phones` include: the contact's phone number, under `phone`. - `phone` (object, required): The phone row. - `contactPhoneID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the phone row. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `isPrimary` (string, required, one of "0", "1"): `1` for the contact's primary phone. - `phone` (string, required, max length 20): The phone number, as stored (E.164 when entered through the app). - `phoneTypeID` (one of several shapes, required) - One of: - Option 1: `phone_types` - Option 2: null - `description` (string | null, required, max length 200): Free-text label for the number. - `isActive` (string, required, one of "0", "1"): `1` while the number is in use. ### contact_address_row One row of the `addresses` include: one of the contact's addresses, under `address`. - `address` (object, required): The address row. - `contactAddressID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the address row. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `isPrimary` (string, required, one of "0", "1"): `1` for the contact's primary address. - `countryID` (string, required, max length 2): Two-letter country code. - `address` (string, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line, or null. - `city` (string, required, max length 100): City. - `stateID` (string, required, max length 3): State or province code. - `postalCode` (string | null, required, max length 30): Postal code, or null. ### owner_portfolio_row One row of the `portfolios` include: the owner's share of a portfolio, and the portfolio. - `owner` (object, required): The ownership row: the owner's share of the portfolio and any payout override. - `portfolioOwnerID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the ownership row. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): ID of the portfolio. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the owner contact. - `percentOwned` (string, decimal, required): Percentage of the portfolio the owner holds. - `percentDistributed` (string, decimal, required): Percentage of distributions paid to the owner. - `overrideContactPayoutSettings` (string, required, one of "0", "1", pattern `^-?[0-9]+$`): `1` when the payout fields below replace the owner contact's own payout settings for this portfolio. - `payeeName` (string | null, required, max length 100): Payee name used for this portfolio's payouts, when overridden. - `payoutTypeID` (`payout_types`, required) - `achDetailsCiphertextID` (string | null, required, max length 45): ID of the encrypted bank details, when overridden. - `achAccountNumberTruncated` (string | null, required, max length 4): Last four digits of the bank account, when overridden. - `achAccountTypeID` (one of several shapes, required) - One of: - Option 1: `bank_account_types` - Option 2: null - `achIsCorporateAccount` (string, required, one of "0", "1"): `1` when the overriding bank account is a corporate account. - `portfolio` (`included_portfolio`, required) ### portal_types * `1` - Manager * `2` - Owner * `3` - Resident * `4` - Vendor * `5` - Association * `6` - Applicant * `7` - Admin * `8` - Public * `9` - Maintenance * `10` - Owner Lead ### contact_portal_account One row of the `portalAccounts` include: a portal user linked to the contact, joined to its user record (`users`) for the name, email, phone and time zone. - `userPortalAccountID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the portal account. - `userID` (string, required, pattern `^-?[0-9]+$`): ID of the portal user. - `accountID` (string, required, pattern `^-?[0-9]+$`): ID of the property management account. - `portalTypeID` (`portal_types`, required): The portal the account signs in to: the contact type's own portal. - `portalID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the account belongs to (the `contactID` requested). - `email` (string, required, max length 75): The portal user's sign-in email. - `isActive` (string, required, one of "0", "1"): `1` while the portal user is active. - `firstName` (string, required, max length 50): The portal user's first name. - `lastName` (string, required, max length 50): The portal user's last name. - `phone` (string | null, required, max length 50): The portal user's phone. - `timeZone` (string, required, max length 50): The portal user's time zone (an IANA name such as `America/New_York`). ### portal_invitation_statuses * `1` - Pending * `2` - Accepted * `3` - Revoked ### contact_portal_invitation One row of the `portalInvitations` include: a pending invitation (status `1`, not yet expired) to the contact type's portal, newest first. Only the fields below are part of the contract. - `userPortalInvitationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the invitation. - `accountID` (string, required, pattern `^-?[0-9]+$`): ID of the property management account. - `portalInvitationStatusID` (`portal_invitation_statuses`, required): Always `1` (Pending): the include lists only pending invitations. - `portalTypeID` (`portal_types`, required): The portal the invitation is for. - `portalID` (string, required, pattern `^-?[0-9]+$`): ID of the contact invited (the `contactID` requested). - `email` (string, required, max length 100): Address the invitation was sent to. - `roleID` (string | null, required, pattern `^-?[0-9]+$`): ID of the role the invitation grants, or null. - `portfolioGroupIDs` (string | null, required): Portfolio group IDs as a JSON array in a string (for example `"[1, 2]"`), or null; not decoded. - `dateTimeCreated` (string, required, read-only): When the invitation was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeExpires` (string, required): When the invitation expires. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `nextReminderDateTime` (string | null, required): When the next reminder is due, or null. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### contact_tax_adjustment One row of the `taxAdjustments` include: an adjustment to the contact's 1099 reportable amount. - `taxAdjustmentID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the adjustment. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `amount` (string, decimal, required): Adjustment amount. - `description` (string, required, max length 1000): What the adjustment is for. - `datePosted` (string, date, required): Date the adjustment applies to. ### tenant_lease_row One row of the `leases` include: a lease the tenant is on, with the tenant row, the lease, its property and its unit. - `leaseTenant` (object, required): The tenant's row on the lease. - `leaseTenantID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the lease tenant row. - `leaseID` (string, required, pattern `^-?[0-9]+$`): ID of the lease. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the tenant contact. - `isPrimary` (string, required, one of "0", "1"): `1` for the lease's primary tenant. - `isActive` (string, required, one of "0", "1"): `1` while the tenant is on the lease. - `moveInDate` (string, date, required): Move-in date. - `moveOutDate` (string | null, date, required): Move-out date, or null. - `contact` (object, required): The tenant contact (a few columns). - `contactID` (string, required, read-only, pattern `^-?[0-9]+$`): ID of the tenant contact. - `contactTypeID` (`contact_types`, required) - `name` (string, required, max length 100): Display name. - `email` (string | null, required, max length 100): Primary email, or null. - `phone` (string | null, required, max length 20): Primary phone, or null. - `lease` (object, required): The lease. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the lease. - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit. - `startDate` (string, date, required): Lease start date. - `endDate` (string | null, date, required): Lease end date, or null for a month-to-month lease. - `primaryLeaseStatusID` (`primary_lease_statuses`, required) - `leaseStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the account's lease status (an open lookup of the account's statuses), or the primary status's default. - `property` (object, required): The lease's property (a few columns). - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the property. - `isMultiUnit` (string, required, one of "0", "1"): `1` for a multi-unit property. - `propertyTypeID` (`property_types`, required) - `name` (string | null, required, max length 100): Property name, or null. - `address` (string, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line, or null. - `city` (string, required, max length 100): City. - `stateID` (string, required, max length 3): State or province code. - `postalCode` (string | null, required, max length 20): Postal code, or null. - `countryID` (string, required, max length 2): Two-letter country code. - `unit` (object, required): The lease's unit (a few columns). - `unitID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the unit. - `name` (string | null, required, max length 100): Unit name, or null. - `address` (string, required, max length 100): Street address. - `address2` (string | null, required, max length 100): Second address line, or null. - `city` (string, required, max length 100): City. - `stateID` (string, required, max length 3): State or province code. - `postalCode` (string | null, required, max length 20): Postal code, or null. - `addressValidationStatusID` (`address_validation_statuses`, required) ### vendor_trade_row One row of the `vendorTrades` include: a trade the vendor is assigned to. - `contactVendorTrade` (object, required): The assignment of the trade to the contact. - `contactVendorTradeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the assignment. - `vendorTradeID` (string, required, pattern `^-?[0-9]+$`): ID of the trade. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `vendorTrade` (object, required): The trade. - `vendorTradeID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the trade. - `name` (string, required, max length 500): Trade name. - `isVisibleTenantPortal` (string, required, one of "0", "1"): `1` when residents can pick the trade in the resident portal. ### contact_person One row of the `contactPersons` include: a person at the vendor or association. - `contactPersonID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the contact person. - `contactID` (string, required, pattern `^-?[0-9]+$`): ID of the contact the row belongs to. - `name` (string, required, max length 100): The person's name. - `title` (string | null, required, max length 100): Job title. - `email` (string | null, required, max length 100): Email address. - `phone` (string | null, required, max length 20): Phone number. ### vendor_review_stats One row of the `reviewStats` include: the vendor's completed maintenance reviews, counted by star rating. Always one row; every value is `0` when the vendor has no completed review. - `totalRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed reviews. - `averageRating` (string, decimal, required): Average rating (1-5), or `0.0000` with no review. - `oneStarRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed one-star reviews. - `oneStarRatingPercent` (string, decimal, required): Share of reviews with one-star ratings, as a percentage (0-100). - `twoStarRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed two-star reviews. - `twoStarRatingPercent` (string, decimal, required): Share of reviews with two-star ratings, as a percentage (0-100). - `threeStarRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed three-star reviews. - `threeStarRatingPercent` (string, decimal, required): Share of reviews with three-star ratings, as a percentage (0-100). - `fourStarRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed four-star reviews. - `fourStarRatingPercent` (string, decimal, required): Share of reviews with four-star ratings, as a percentage (0-100). - `fiveStarRatingCount` (string, required, pattern `^-?[0-9]+$`): Number of completed five-star reviews. - `fiveStarRatingPercent` (string, decimal, required): Share of reviews with five-star ratings, as a percentage (0-100). ### contact_invoice_autofill_template The `invoiceAutofillTemplate` include: the invoice autofill template the contact's `invoiceAutofillTemplateID` names. - `invoiceAutofillTemplateID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the template. - `name` (string, required, max length 100): Template name. - `isDefault` (string, required, one of "0", "1"): `1` for the account's default template. - `billDescription` (string | null, required, max length 2000): Bill description the template fills in. - `paymentMemo` (string | null, required, max length 2000): Payment memo the template fills in. - `chargeDescription` (string | null, required, max length 2000): Charge description the template fills in. ### association_property_row One row of the `properties` include: a property the association is linked to, and the property. - `propertyAssociation` (object, required): The link between the property and the association. - `propertyAssociationID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the link. - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property. - `associationContactID` (string, required, pattern `^-?[0-9]+$`): ID of the association contact. - `property` (`included_property`, required) ### file_sources * `1` - Upload * `2` - Inbound Message * `3` - Letter * `4` - Bulk Letter * `5` - Statement Batch * `6` - Created Invoice * `7` - RentSign * `8` - Move Out Statement ### file A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an invoice). The file itself is downloaded through `GET /files/{fileID}/download` (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment. - `fileID` (string, required, read-only, pattern `^-?[0-9]+$`): The primary key of the file. - `fileSourceID` (`file_sources`, required): How the file reached Rentvine. Set when the file is created; an update can't change it. * `1` - Upload * `2` - Inbound Message * `3` - Letter * `4` - Bulk Letter * `5` - Statement Batch * `6` - Created Invoice * `7` - RentSign * `8` - Move Out Statement - `isAttachable` (string, required, one of "0", "1"): `1` when the file can be attached to records and is listed by `GET /files`. - `title` (string, required, max length 200): The name of the file shown to users. - `fileName` (string, required, read-only, max length 100): The internal name the file is stored under. - `fileType` (string, required, read-only, max length 20): The file's extension, lowercase (`pdf`, `jpg`). - `fileSize` (string, required, read-only, pattern `^-?[0-9]+$`): The size of the file in bytes. - `userID` (string, required, read-only, pattern `^-?[0-9]+$`): The user who uploaded or created the file. - `isImage` (string, required, read-only, one of "0", "1"): `1` when the file type is an image. - `isPublic` (string, required, read-only, one of "0", "1"): `1` when the file is publicly accessible. Set when the file is created; an update can't change it. - `previewFileName` (string | null, required, read-only, max length 150): The internal name of the file's preview (a thumbnail, mainly for images); null when it has none. - `dateTimeCreated` (string, required, read-only): When the file was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### object_types * `1` - Account * `2` - User * `3` - Contact * `4` - Lease * `5` - Bill * `6` - Property * `7` - Unit * `8` - Deposit * `9` - Accounting Transaction * `10` - Accounting Transaction Entry * `11` - Portfolios * `12` - Accounting Payouts * `13` - Bank Adjustments * `14` - Company * `15` - Statement * `16` - Work Orders * `17` - Inspections * `18` - Inspection Areas * `19` - Inspection Items * `20` - Application * `21` - Applicant * `22` - Bank Transfer * `23` - Listing * `24` - Appliance * `25` - Text Message * `26` - Email Message * `27` - Work Order Estimate * `28` - Settlement * `29` - Lease Tenant * `30` - Email Template * `31` - Note * `32` - File Attachment * `33` - Invoice * `34` - Document Transaction * `35` - Document Envelope * `36` - Application Template * `37` - Recurring Bill * `38` - Chat Message * `39` - Reconciliation * `40` - Path * `41` - Accounting Payout Returns * `42` - Management Fee Setting * `43` - Additional Management Fee Setting * `44` - Accounting Setting * `45` - Posting Setting * `46` - Late Fee Setting * `47` - Statement Setting * `48` - Payout Batch * `49` - Letter * `50` - Reminder * `51` - Review * `52` - Landlord Verification * `53` - Rent Increase * `54` - Accounting Account * `55` - Lease Charge Notification * `56` - Started Application * `57` - Saved Report * `58` - Tag * `59` - Tag Object * `60` - Contact Phone * `61` - Contact Email * `62` - Contact Address * `63` - Vendor Type * `64` - Vendor Trade * `65` - Contact Vendor Trade * `66` - Portfolio Owner * `67` - Property Association * `68` - Occupant * `69` - Vehicle * `70` - Emergency Contact * `71` - Property Feature * `72` - Property Custom Feature * `73` - Property Portfolio * `74` - Work Order Project * `75` - Ledger * `76` - Portfolio Group * `77` - Screening Report * `78` - Screening Report Document * `79` - Screening Prospect * `80` - Screening Prospect Source * `81` - Lease Statement * `82` - Lease Statement Setting * `83` - Document Setting * `84` - PetScreening Pet * `85` - Lease Pet * `86` - Owner Lead * `87` - Additional Field Answer * `102` - Owner Lead Address * `88` - Lease Renewal * `89` - Reconciliation Bank Statement * `90` - Pending Reconciliation * `91` - Bulk Payment * `92` - Portal Invitation * `93` - Portal Account * `94` - Insurance Setting * `95` - Month-to-Month Premium Setting * `96` - Month-to-Month Premium Recurring Charge * `97` - Month-to-Month Premium One-Time Charge * `98` - Resident Package * `99` - Resident Service * `100` - Resident Service * `101` - Resident Package * `103` - Magic Link * `104` - Lease Recurring Charge * `105` - Access Point * `106` - Access Point Credential * `107` - Owner Lead Source ### sub_object_types * `1` - Identity Verification * `2` - Income Verification * `3` - Pet Screening Photo * `4` - Pet Screening Vaccine Document * `5` - Applicant Animal Photo * `51` - Work Order Issue * `52` - Work Order Resolution * `101` - Invoice File * `151` - Bank Statement * `152` - Supporting Document * `201` - Lease Pet Photo ### attachment A file attachment, which shows one file on one record. A file can be attached to several records. - `fileAttachmentID` (string, required, read-only, pattern `^-?[0-9]+$`): The primary key of the file attachment. - `fileID` (string, required, pattern `^-?[0-9]+$`): The attached file. - `objectTypeID` (`object_types`, required): The [object type](https://docs.rentvine.com/#tag/Object-Types) of the record the file is attached to (`7` for a unit). - `objectID` (string, required, pattern `^-?[0-9]+$`): The ID of the record the file is attached to, a record of the type `objectTypeID` names. - `isSharedWithOwner` (string, required, one of "0", "1"): `1` when the file is shared with owners in the owner portal. - `isSharedWithTenant` (string, required, one of "0", "1"): `1` when the file is shared with tenants in the resident portal. - `isSharedWithVendor` (string, required, one of "0", "1"): `1` when the file is shared with vendors in the vendor portal. - `isSharedWithApplicant` (string, required, one of "0", "1"): `1` when the file is shared with applicants in the applicant portal. - `pathID` (string, required, pattern `^-?[0-9]+$`): The folder the attachment is in on the record; `1` is the top folder. - `portalTypeID` (`portal_types`, required): The portal the attachment was added from. * `1` - Manager * `2` - Owner * `3` - Resident * `4` - Vendor * `5` - Association * `6` - Applicant * `7` - Admin * `8` - Public * `9` - Maintenance * `10` - Owner Lead - `contactID` (string | null, required, pattern `^-?[0-9]+$`): A contact the attachment is linked to; null when none. - `subObjectTypeID` (one of several shapes, required): What part of the record the file belongs to (a work order's issue or resolution photos, an applicant's verification documents); null for a plain attachment. - One of: - Option 1: `sub_object_types` - Option 2: null - `relatedObjectTypeID` (one of several shapes, required): The object type of a second record the attachment points to; null when none. - One of: - Option 1: `object_types` - Option 2: null - `relatedObjectID` (string | null, required, pattern `^-?[0-9]+$`): The ID of the record `relatedObjectTypeID` names; null when none. ### file_view A file, as `GET /files/{fileID}` returns it. - `file` (`file`, required) - `fileAttachments` (`attachment`[]): Every attachment of the file, an empty list when it has none. Requires the `fileAttachments` include. ### portfolio Represents a portfolio — the ownership and financial management unit for one or more rental properties. Each portfolio tracks owner contacts, distribution rules, reserve requirements, and statement settings. - `portfolioID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the portfolio. - `code` (string | null): Optional short code for the portfolio. - `name` (string, required): Display name of the portfolio. - `contacts` (object[] | null, required): Owner contacts associated with this portfolio, with ownership and distribution percentages. - `contactID` (string, required, pattern `^-?[0-9]+$`): Unique identifier of the contact. - `percentOwned` (string, decimal, required): Ownership percentage (0–100, four decimal places). - `percentDistributed` (string, decimal, required): Percentage of distributions allocated to this contact (0–100, four decimal places). - `name` (string, required): Display name of the contact. - `postingSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the posting setting configuration for this portfolio. - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`): ID of the user assigned to manage this portfolio. - `minimumDistributionAmount` (string | null, decimal): Minimum distribution amount (decimal string). Distributions below this threshold are withheld. - `maximumDistributionAmount` (string | null, decimal): Maximum distribution amount per cycle (decimal string). `null` means no cap. - `reserveAmount` (string, decimal, required): Required reserve balance the portfolio must maintain before distributions are paid (decimal string). - `additionalReserveAmount` (string, decimal, required): Additional reserve amount on top of the base reserve (decimal string). - `additionalReserveDescription` (string | null): Explanation of the additional reserve amount. - `overdraftOverrideAmount` (string | null, decimal): Amount the portfolio balance is allowed to go negative before blocking transactions (decimal string). - `fiscalYearEndMonth` (string, required, pattern `^-?[0-9]+$`): Month number (1–12) when the fiscal year ends for this portfolio. - `statementSettingID` (string, required, pattern `^-?[0-9]+$`): ID of the statement setting configuration that controls how statements are generated. - `sendStatements` (string, required, one of "0", "1"): Whether statements are sent to owners. `"1"` = enabled, `"0"` = disabled. - `holdDistributions` (string, required, one of "0", "1"): Whether distributions are on hold. `"1"` = held, `"0"` = normal. - `holdDistributionsDescription` (string | null): Reason distributions are being held, if applicable. - `isActive` (string, required, one of "0", "1"): Whether the portfolio is active. `"1"` = active, `"0"` = inactive. - `isLiveLedgerEnabled` (string | null, one of "0", "1", null): Whether real-time ledger updates are enabled for this portfolio. `null` means unset (uses account default). - `isBalanceNoticeDisabled` (string, required, one of "0", "1"): Whether balance notice emails are disabled for this portfolio. `"1"` = disabled, `"0"` = enabled. - `dateTimeCreated` (string | null, read-only): Timestamp when the portfolio was created (MySQL datetime format). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, read-only): Timestamp when the portfolio was last modified (MySQL datetime format). UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, read-only): Timestamp when the portfolio was deactivated, or `null` if still active. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string, required, read-only, one of "0", "1"): Whether this portfolio was created via data import. `"1"` = imported, `"0"` = created manually. - `importSourceKey` (string | null, read-only): External key from the import source, if applicable. - `isPublicStatementEnabled` (string, one of "0", "1"): Whether public statement sharing is enabled for this portfolio. `"1"` = enabled, `"0"` = disabled. - `dateClosed` (string | null, date): Date the portfolio was closed (YYYY-MM-DD), or `null` if still open. ### portfolio_owner Represents an owner's stake in a portfolio, including ownership percentage, distribution settings, and payout configuration. - `portfolioOwnerID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the portfolio owner record. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio this owner belongs to. - `contactID` (string, required, pattern `^-?[0-9]+$`): The contact record representing the owner. - `percentOwned` (string, decimal, required): Ownership percentage of the portfolio (0–100). - `percentDistributed` (string, decimal, required): Percentage of distributions allocated to this owner (0–100). - `overrideContactPayoutSettings` (string, pattern `^-?[0-9]+$`): When `1`, payout settings on this record override the contact's default payout settings. - `payeeName` (string | null, max length 100): Name to appear on payouts, if overriding the contact's default name. - `payoutTypeID` (string | null, one of "1", "2", "3", "4", null): Payout method for this owner. * `1` - Cash * `2` - Check * `3` - eCheck (ACH) * `4` - NACHA (ACH) - `achDetailsCiphertextID` (string | null, read-only): Internal ID referencing the encrypted ACH details record. - `achAccountNumberTruncated` (string | null): Last 4 digits of the saved ACH account number. - `achAccountTypeID` (string | null, one of "1", "2", null): ACH bank account type. * `1` - Savings * `2` - Checking - `achIsCorporateAccount` (string | null, pattern `^-?[0-9]+$`): When `1`, the ACH account is a corporate (CCD) account rather than personal (PPD). ### statement_setting A statement setting template that controls how owner statements are generated and which modules are included. - `statementSettingID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `name` (string, required, max length 100): Human-readable name for this setting template. - `isActive` (string, required, one of "0", "1"): Whether this setting template is active (1 = active, 0 = inactive). - `settings` (object, required): Nested configuration controlling statement content and module visibility. - `statement` (object, required): Global statement-level content flags. - `includeBills` (boolean) - `includeBillAttachments` (boolean) - `includeBillAttachmentsWithMarkup` (boolean) - `includeBillAttachmentsWithDiscount` (boolean) - `includeWorkOrders` (boolean) - `includeWorkOrderAttachments` (boolean) - `includeBalanceMessage` (boolean) - `combineDiscount` (boolean) - `combineMarkup` (boolean) - `includePrepayments` (boolean) - `modules` (object, required): Per-module visibility and layout configuration. - `summary` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `taxSummary` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `includePrepayments` (boolean) - `transactionSummary` (object) - `isActive` (boolean) - `includeYearToDate` (boolean) - `excludeZeroBalanceAccounts` (boolean) - `pageBreak` (boolean) - `transactionDetails` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `isMultiUnitConsolidated` (boolean) - `isTransactionConsolidated` (boolean) - `isIncomeConsolidated` (boolean) - `isManagementFeeConsolidated` (boolean) - `propertyTransactionsOrderField` (integer) - `includeTransactionRunningBalance` (boolean) - `includePayeePayer` (boolean) - `includePropertyReserveAmount` (boolean) - `includeNetValues` (boolean) - `propertyOrderType` (integer) - `ledger` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `includePayeePayer` (boolean) - `openWorkOrders` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `closedWorkOrders` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `includeClosingComments` (integer) - `unpaidBills` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `notes` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `units` (object) - `isActive` (boolean) - `pageBreak` (boolean) - `showBalance` (boolean) - `showTenants` (boolean) - `showMoveInDate` (integer) ### statement An owner statement for a portfolio covering a specific date range. Statements summarize financial activity including income, expenses, distributions, and reserve balances for an owner's review. - `statementID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio this statement belongs to. - `statementBatchID` (string | null, pattern `^-?[0-9]+$`): The batch this statement was generated from, if any. - `statementSettingID` (string | null, pattern `^-?[0-9]+$`): Statement setting template used to generate this statement. - `statementPeriodTypeID` (string | null, one of "1", "2", null): Statement period type. * `1` - Monthly * `2` - Off-Cycle - `name` (string, required, max length 100): Human-readable name for the statement period. - `startDate` (string | null, date): Start of the statement period. - `endDate` (string | null, date): End of the statement period. - `statementStatusID` (string, required, one of "1", "2", "3", "4", "5"): Current processing status of the statement. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `beginningBalance` (string, decimal): Portfolio ledger balance at the start of the period (may be negative). - `endingBalance` (string, decimal): Portfolio ledger balance at the end of the period (may be negative). - `totalDistributionAmount` (string, decimal): Total distributions paid during the period. - `totalIncomeAmount` (string, decimal): Total income collected during the period (may be negative). - `totalExpenseAmount` (string, decimal): Total expenses during the period. - `totalAdjustmentAmount` (string, decimal): Total adjustments during the period. - `reserveAmount` (string, decimal): Reserve balance held for the portfolio. - `additionalReserveAmount` (string, decimal): Additional reserve held for the portfolio. - `unpaidBillAmount` (string, decimal): Total amount of unpaid bills at statement end. - `workOrderEstimateAmount` (string, decimal): Total open work order estimate amounts at statement end. - `dateTimeCreated` (string, required, read-only): When the statement was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `publicUUID` (string | null): Public UUID used to share the statement without authentication. - `publicVerificationCode` (string | null): Verification code required to access the public statement. - `dateTimeAccessExpires` (string | null): When public access to the statement expires. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `message` (string | null): Optional HTML message included with the statement. ### statement_batch A batch of owner statements generated in a single operation across multiple portfolios. Batches coordinate processing, publication, and PDF file generation for all included statements. - `statementBatchID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `statementSettingID` (string | null, pattern `^-?[0-9]+$`): Statement setting template used for this batch. - `statementStatusID` (string, required, one of "1", "2", "3", "4", "5"): Overall processing status of the batch. * `1` - Processing * `2` - Published * `3` - Failed * `4` - Review * `5` - Publishing - `statementPeriodTypeID` (string | null, one of "1", "2", null): Statement period type for this batch. * `1` - Monthly * `2` - Off-Cycle - `name` (string, required, max length 100): Name of the batch. - `startFromLastStatement` (string, pattern `^-?[0-9]+$`): When `1`, each portfolio's start date is calculated from its most recent statement end date. - `isAutoPublished` (string, one of "0", "1"): When `1`, statements are automatically published without a manual review step. - `sendNotifications` (string, one of "0", "1"): When `1`, owner notification emails are sent when statements are published. - `startDate` (string | null, date): Explicit start date for the statement period (used when `startFromLastStatement` is `0`). - `endDate` (string | null, date): End date for the statement period. - `message` (string | null): Optional HTML message included with all statements in the batch. - `statementBatchFileStatusID` (string | null, one of "1", "2", "3", null): Status of the combined PDF file for the batch. * `1` - No File * `2` - Pending * `3` - Complete - `fileID` (string | null, pattern `^-?[0-9]+$`): File ID of the generated combined PDF, if available. - `dateTimeCreated` (string, required, read-only): When the batch was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### address_validation_data The stored verdict of the last address validation, decoded from JSON. The key set depends on the validator version that wrote it: every verdict has `source` and `validatedAt`; verdicts from version 3 (`validatorVersion: 3`) carry every key below; older verdicts carry a subset (no `validatorVersion`, and `requireSecondary`/`secondary` only on some); an incomplete-address verdict (`reason: incomplete_address`) has `missingFields` and, from version 3, the provider keys set to `null`. - `source` (string, required, one of "google", "rentvine"): `google` for a provider verdict, `rentvine` for an incomplete-address verdict decided without calling the provider. - `validatedAt` (string, required): When the verdict was written. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `validatorVersion` (integer): Version of the validator that wrote the verdict (3 today). Absent on verdicts written before versioning. - `validationMode` (string): Whether the address was validated as a building or as a unit (`building`, `unit`). - `isValid` (boolean): True when the status is Valid. Absent on incomplete-address verdicts written before version 3. - `reason` (string, one of "incomplete_address"): Present only when the address was missing parts and was not sent to the provider. - `missingFields` (string[]): The address parts that were missing. Present only with `reason`. - `requireSecondary` (boolean): Whether a confirmed secondary (unit number) was required for a Valid status. - `secondary` (string | null): The secondary (unit number) sent to the provider. - `secondaryRaw` (string | null) - `secondarySource` (string | null) - `secondaryReconciliation` (string | null) - `providerAddressLine` (string | null): The address line sent to the provider. - `dpvConfirmation` (string | null): The USPS delivery-point confirmation code the provider returned (`Y`, `S`, `D`, `N`), or null. - `dpvFootnotes` (string | null) - `verdictGranularity` (string | null): The provider's verdict granularity (for example `PREMISE`, `SUB_PREMISE`). - `addressComplete` (boolean | null) - `hasInferredComponents` (boolean | null) - `hasUnconfirmedComponents` (boolean | null) - `unconfirmedComponentTypes` (string[] | null) - `secondaryStandardized` (string | null) - `isSecondaryConfirmed` (boolean) - `scrubbedAddress` (object): The address as the provider standardized it (all null on an incomplete-address verdict). `secondary` is present from version 3. - `address` (string | null, required) - `secondary` (string | null) - `city` (string | null, required) - `state` (string | null, required) - `postalCode` (string | null, required) ### property A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, `null` when empty. - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `propertyImageID` (string, required, read-only, pattern `^-?[0-9]+$`): The property's primary image (`1` is the shared no-image placeholder). - `propertyTypeID` (`property_types`, required) - `isMultiUnit` (string, required, one of "0", "1"): `1` for a multi-unit property, `0` for single-family. Set on create and never changed. - `isActive` (string, required, read-only, one of "0", "1"): `1` active, `0` deactivated. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): The portfolio that currently owns the property. - `managementFeeSettingID` (string, required, pattern `^-?[0-9]+$`): The management fee setting the property uses. - `name` (string | null, required, max length 100) - `countryID` (string, required, max length 2): Two-letter country code. - `address` (string, required, max length 100): Full formatted street address. - `streetNumber` (string | null, required, read-only, pattern `^-?[0-9]+$`): Leading street number parsed from `address`, or null when the address doesn't start with one. - `streetName` (string | null, required, read-only, max length 100): `address` with the leading street number removed. - `address2` (string | null, required, max length 100) - `stateID` (string, required, max length 3): Two-letter state or province code. - `city` (string, required, max length 100) - `postalCode` (string | null, required, max length 20) - `latitude` (string, decimal, required, read-only): Geocoded on create and when the address changes; `0.00000000` when geocoding found nothing. - `longitude` (string, decimal, required, read-only): Geocoded on create and when the address changes; `0.00000000` when geocoding found nothing. - `addressValidationStatusID` (`address_validation_statuses`, required, read-only): Result of the last address validation. Reset to `1` on create, on an address change and by the revalidate route; resolved in the background. * `1` - Not Validated * `2` - Valid * `3` - Invalid * `4` - Incomplete - `addressValidationData` (one of several shapes, required, read-only): The last address-validation verdict, or null before the first run and after a reset. - One of: - Option 1: `address_validation_data` - Option 2: null - `county` (string | null, required, max length 100) - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): The user the property is assigned to (its property manager), or null. - `legalDescription` (string | null, required, max length 200): Legal description of the lot. The column holds 200 characters, but create and update take at most 100. - `maintenanceLimitAmount` (string | null, decimal, required): Spend limit before maintenance needs approval. - `yearBuilt` (string | null, required, pattern `^-?[0-9]+$`) - `dateInsuranceExpires` (string | null, date, required) - `dateWarrantyExpires` (string | null, date, required) - `maintenanceNotes` (string | null, required) - `applicationTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the template this record points to. - `reserveAmount` (string, decimal, required): Owner reserve held for the property. - `markupPercent` (string | null, decimal, required): Maintenance markup as a percent. Never set together with `markupAmount`. - `markupAmount` (string | null, decimal, required): Maintenance markup as a fixed amount. Never set together with `markupPercent`. - `markupAmountMin` (string | null, decimal, required) - `markupAmountMax` (string | null, decimal, required) - `dateContractBegins` (string | null, date, required) - `dateContractEnds` (string | null, date, required) - `commercialClassTypeID` (one of several shapes, required): Commercial building class; always null unless the property type is Commercial (`9`). - One of: - Option 1: `commercial_class_types` - Option 2: null - `salesTaxSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the sales tax setting this record points to. - `withholdingTaxAgencyID` (string | null, required, pattern `^-?[0-9]+$`): ID of the withholding tax agency this record points to. - `insuranceCompany` (string | null, required, max length 100) - `insuranceAgent` (string | null, required, max length 100) - `insurancePolicyNumber` (string | null, required, max length 50) - `requiredRentersInsuranceLiabilityAmount` (string, decimal, required): Renters insurance liability coverage required of tenants. Defaults on create to the account's insurance setting, or 100000.00. - `insuranceContactDetails` (string | null, required, max length 500) - `leaseReturnChargeAmount` (string | null, decimal, required): Default NSF/returned-payment charge for the property's leases. - `defaultMonthToMonthPremiumSettingID` (string | null, required, pattern `^-?[0-9]+$`): ID of the month to month premium setting this record points to. - `defaultResidentPackageID` (string | null, required, pattern `^-?[0-9]+$`): ID of the package this record points to. - `propertyShowingProviderID` (string | null, required, pattern `^-?[0-9]+$`): The showing provider configured for the property, or null for the account default. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `deactivationReasonID` (one of several shapes, required): Why the property was deactivated. Null while active. `99` (Unknown) is the default when a deactivation sends no reason. - One of: - Option 1: `deactivation_reasons` - Option 2: null - `deactivationNotes` (string | null, required) - `isFromImport` (string, required, read-only, one of "0", "1"): `1` when the property was created by an import. - `importSourceKey` (string | null, required, read-only, max length 100): The import's key for the row, or null. ### property_image A property or unit image record. `propertyImageID` `1` is the shared no-image placeholder (`filePath` `noimage`, `propertyID` and `unitID` `0`). - `propertyImageID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `title` (string, required, max length 100) - `filePath` (string, required, max length 100) - `fileType` (string, required, max length 20) - `fileSize` (string, required, pattern `^-?[0-9]+$`) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `caption` (string | null, required) ### property_types_request * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot ### property_create The `property` object of a create request. Only these keys are read (the controller's `assign()` whitelist); any other key is ignored. Dates are parsed loosely: `YYYY-MM-DD` and `MM/DD/YYYY` are both accepted, and are returned as `YYYY-MM-DD`. - `propertyTypeID` (`property_types_request`, required): The property type, from the fixed list below (no lookup route): the values are the enum. * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot - `isMultiUnit` (string | integer, one of "0", "1", 0, 1, default 0): Send `1` to create a multi-unit property (with `units`), `0` or omit for single-family (with `unit`). Every type except Single Family Home (`1`) and Mobile Home (`8`) allows `1` (Apartment, Condo, Townhouse, Duplex, Multiplex, Loft, Commercial, Garage and Lot, `2`-`7` and `9`-`11`); `1` with type `1` or `8` is refused. Can't be changed after create. - `portfolioID` (string | integer, required, pattern `^-?[0-9]+$`): The owning portfolio, from `GET /portfolios`. A portfolio outside the API user's portfolio groups is refused. - `managementFeeSettingID` (string | integer, required, pattern `^-?[0-9]+$`): The management fee setting; must exist. From `GET /settings/management-fees` (undocumented). - `name` (string | null, max length 100): Display name. - `countryID` (string, required, max length 2): Two-letter country code, from `GET /countries` (undocumented). - `address` (string, required, max length 100): Street address. Geocoded on create; the leading number is split into `streetNumber`. - `address2` (string | null, max length 100): Second address line (suite, unit). - `stateID` (string, required, max length 3): State or province code of `countryID`, from `GET /states` (undocumented). - `city` (string, required, max length 100): City. At most 50 characters on a single-family property, whose unit takes a copy capped at 50. - `postalCode` (string | null, max length 20): Postal (ZIP) code. - `county` (string | null, max length 100): County. - `legalDescription` (string | null, max length 100): Legal description of the lot. - `maintenanceLimitAmount` (string | number | null, decimal, minimum 0): Not negative. - `yearBuilt` (string | integer | null, pattern `^-?[0-9]+$`): A positive whole number; empty is stored as null. - `dateInsuranceExpires` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `dateWarrantyExpires` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `maintenanceNotes` (string | null, max length 65535): Internal maintenance notes. - `applicationTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): An application template ID; must exist. - `reserveAmount` (string | number | null, decimal, default "0.00", minimum 0): Not negative; empty is stored as `0.00`. - `markupPercent` (string | number | null, decimal): Maintenance markup percent, 0.1 to 99. Can't be sent together with a non-empty `markupAmount`. `0` is stored as null. - `markupAmount` (string | number | null, decimal, minimum 0): Maintenance markup as a fixed amount. Can't be sent together with a non-empty `markupPercent`. `0` is stored as null. - `markupAmountMin` (string | number | null, decimal, minimum 0): `0` is stored as null. - `markupAmountMax` (string | number | null, decimal, minimum 0): `0` is stored as null. - `dateContractBegins` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `dateContractEnds` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `commercialClassTypeID` (string | integer | null, one of "1", "2", "3", "4", 1, 2, 3, 4, null): Stored only for a Commercial property (`propertyTypeID` `9`); cleared for any other type. * `1` - A * `2` - B * `3` - C * `4` - D - `salesTaxSettingID` (string | integer | null, pattern `^-?[0-9]+$`): A sales tax setting ID; must exist. - `withholdingTaxAgencyID` (string | integer | null, pattern `^-?[0-9]+$`): A withholding tax agency ID; must exist. - `insuranceCompany` (string | null, max length 100): The property's insurance carrier. - `insuranceAgent` (string | null, max length 100): The property's insurance agent. - `insurancePolicyNumber` (string | null, max length 50): The property's insurance policy number. - `insuranceContactDetails` (string | null, max length 500): How to reach the insurance carrier or agent. - `requiredRentersInsuranceLiabilityAmount` (string | number | null, decimal, minimum 0): Renters insurance liability coverage required of tenants. Empty defaults to the account's insurance setting, or 100000.00. - `leaseReturnChargeAmount` (string | number | null, decimal, minimum 0): Not negative; empty or `0` is stored as null. - `defaultMonthToMonthPremiumSettingID` (string | integer | null, pattern `^-?[0-9]+$`): A month-to-month premium setting ID; must exist. - `defaultResidentPackageID` (string | integer | null, pattern `^-?[0-9]+$`): A resident package ID; must exist. - `propertyShowingProviderID` (string | integer | null, pattern `^-?[0-9]+$`): A configured showing provider ID; must exist. - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): The user to assign the property to; must exist. ### unit_for_property_create A unit in a create-property request: `unit` for a single-family property, each item of `units` for a multi-unit one. Only these keys are read; any other key is ignored. A single-family property's unit takes its `name`, address, city, state and postal code from the property, whatever is sent here. - `name` (string | null, max length 100): Display name. - `address` (string, max length 100): Required on a multi-unit property's units; copied from the property on a single-family one. - `streetNumber` (string | integer | null, pattern `^-?[0-9]+$`): Overwritten from `address` on save. - `streetName` (string | null): Overwritten from `address` on save. - `address2` (string | null, max length 100): Second address line (suite, unit). - `stateID` (string, max length 3): Required on a multi-unit property's units, from `GET /states` (undocumented). - `city` (string, max length 50): Required on a multi-unit property's units. - `postalCode` (string | null, max length 20): Postal (ZIP) code. - `rent` (string | number, decimal, required, minimum 0): Market rent. Not negative. - `deposit` (string | number | null, decimal, minimum 0): Market security deposit; not negative. - `size` (string | integer | null, pattern `^[0-9]+$`): Square feet, not negative. Leave it out, or send null, when the size is unknown. - `beds` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. - `fullBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `halfBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `propertyManagerID` (string | integer | null, pattern `^-?[0-9]+$`): Deprecated property manager record ID; must exist. - `commercialSpaceTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", "7", "8", "9", 1, 2, 3, 4, 5, 6, 7, 8, 9, null): Kept only on a Commercial property. Labels as on the unit response. - `isNonRevenue` (string | integer, one of "0", "1", 0, 1, default 0): `1` marks the unit non-revenue (needs `nonRevenueTypeID`). - `nonRevenueTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", 1, 2, 3, 4, 5, 6, null): Required when `isNonRevenue` is `1`; cleared otherwise. Labels as on the unit response. - `nonRevenueStartDate` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`, normalized to `YYYY-MM-DD`; cleared unless `isNonRevenue` is `1`. ### parking_types * `1` - Attached Garage * `2` - Carport * `3` - Street * `4` - OffStreet * `5` - Other * `6` - Detached Garage ### cooling_system_types * `1` - Central * `2` - Evaporative * `3` - Geothermal * `4` - Refrigerator * `5` - Solar * `6` - Wall * `7` - Other ### heating_system_types * `1` - Baseboard * `2` - Forced Air * `3` - Geothermal * `4` - Heat Pump * `5` - Radiant * `6` - Stove * `7` - Wall * `8` - Other ### showing_providers * `2` - Tenant Turner * `3` - Rently * `4` - ShowMojo * `5` - ShowingHero ### listing_search_row One listing search row, keyed by entity. - `listing` (object, required): The listing columns, plus the unit size and the two application links. - `propertyListingID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the listing. - `isActive` (string, required, one of "0", "1"): `1` = active listing, `0` = deactivated listing - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the parent property. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit this listing is for. - `headline` (string | null, required, max length 200): Marketing headline for the listing. - `description` (string | null, required): Full marketing description. - `lotSize` (string | null, required, max length 100): Lot size in acres. - `depositDescription` (string | null, required, max length 500): Free-text description of the deposit requirement. - `availabilityDate` (string | null, date, required): Date the unit will be available for move-in. - `advertisedDate` (string | null, date, required): Date the listing was first advertised. - `virtualTour` (string | null, required, max length 2000): URL to a virtual tour. - `lockboxNumber` (string | null, required, max length 100) - `lockboxDescription` (string | null, required, max length 2000) - `parkingSpaces` (string | null, required, pattern `^-?[0-9]+$`): Number of parking spaces available. - `parkingTypeID` (one of several shapes, required): Parking type identifier. - One of: - Option 1: `parking_types` - Option 2: null - `areaInformation` (string | null, required): Free-text neighborhood or area description. - `schools` (string | null, required): Free-text description of nearby schools. - `leaseDescription` (string | null, required, max length 1000): Free-text description of lease terms. - `name` (string | null, required, max length 100): Primary contact name for this listing. - `phone` (string | null, required, max length 20): Primary contact phone number. - `phoneExtension` (string | null, required, max length 20) - `email` (string | null, required, max length 100): Primary contact email address. - `secondaryName` (string | null, required, max length 100): Secondary contact name. - `secondaryPhone` (string | null, required, max length 20) - `secondaryPhoneExtension` (string | null, required, max length 20) - `secondaryEmail` (string | null, required, max length 100): Secondary contact email address. - `applicationUrl` (string | null, required): The listing's own application link when set, otherwise `defaultApplicationUrl`. Validated as a URL when a listing is saved today, but rows saved before that check can hold other text (a bare host name), so it isn't declared a URI. - `size` (string | null, required, pattern `^-?[0-9]+$`): The unit's size in square feet (from the unit). - `isFurnished` (string | null, required, one of "0", "1", null): `1` = furnished, `0` = unfurnished, `null` = unspecified - `acceptDogs` (string | null, required, one of "0", "1", null): `1` = dogs accepted, `0` = dogs not accepted, `null` = unspecified - `acceptCats` (string | null, required, one of "0", "1", null): `1` = cats accepted, `0` = cats not accepted, `null` = unspecified - `petDescription` (string | null, required, max length 1000): Free-text description of pet policy. - `acceptSmoking` (string | null, required, one of "0", "1", null): `1` = smoking permitted, `0` = no smoking, `null` = unspecified - `acceptAssistance` (string | null, required, one of "0", "1", null): `1` = assistance animals accepted, `null` = unspecified - `isGasIncluded` (string, required, one of "0", "1"): `1` = gas included in rent, `0` = not included - `isElectricIncluded` (string, required, one of "0", "1"): `1` = electric included in rent, `0` = not included - `isWaterIncluded` (string, required, one of "0", "1"): `1` = water included in rent, `0` = not included - `isSewageIncluded` (string, required, one of "0", "1"): `1` = sewage included in rent, `0` = not included - `isGarbageIncluded` (string, required, one of "0", "1"): `1` = garbage included in rent, `0` = not included - `isLandscapingIncluded` (string, required, one of "0", "1"): `1` = landscaping included in rent, `0` = not included - `isCableIncluded` (string, required, one of "0", "1"): `1` = cable TV included in rent, `0` = not included - `isInternetIncluded` (string, required, one of "0", "1"): `1` = internet included in rent, `0` = not included - `isSnowRemovalIncluded` (string, required, one of "0", "1"): `1` = snow removal included in rent, `0` = not included - `isPoolServiceIncluded` (string, required, one of "0", "1"): `1` = pool service included in rent, `0` = not included - `heatType` (string | null, required, max length 200): Free-text heat type description. - `dateTimeCreated` (string, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `coolingSystemTypeID` (one of several shapes, required): Cooling system type identifier. - One of: - Option 1: `cooling_system_types` - Option 2: null - `heatingSystemTypeID` (one of several shapes, required): Heating system type identifier. - One of: - Option 1: `heating_system_types` - Option 2: null - `defaultApplicationUrl` (string | null, required): The Rentvine application page for the unit when the Rentvine application is on, the account-wide link for an external provider, otherwise null. - `unit` (object, required): The listed unit (always active). - `unitID` (string, required, pattern `^-?[0-9]+$`): Unique identifier for the unit. - `name` (string | null, required, max length 100): Optional display name for the unit. - `address` (string, required, max length 100): Street address of the unit. - `address2` (string | null, required, max length 100): Secondary address line. - `city` (string, required, max length 100) - `stateID` (string, required, max length 3): 2-character state or province code. - `postalCode` (string | null, required, max length 20) - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): The unit's current lease, or null when vacant. - `latitude` (string, decimal, required): GPS latitude coordinate. - `longitude` (string, decimal, required): GPS longitude coordinate. - `marketRent` (string, decimal, required): Same as `rent`. - `rent` (string, decimal, required): The unit's market rent (the unit's `rent` column, not a lease's contracted rent); same as `marketRent`. - `marketDeposit` (string | null, decimal, required): Same as `deposit`. - `deposit` (string | null, decimal, required): The unit's market deposit (the unit's `deposit` column, not a lease's); same as `marketDeposit`. - `beds` (one of several shapes, required): Number of bedrooms. - One of: - Option 1: `property_beds` - Option 2: null - `fullBaths` (one of several shapes, required): Number of full bathrooms. - One of: - Option 1: `property_baths` - Option 2: null - `halfBaths` (one of several shapes, required): Number of half bathrooms. - One of: - Option 1: `property_baths` - Option 2: null - `baths` (string | null, required, pattern `^-?[0-9]+$`): `fullBaths` + `halfBaths` (a half bath counts as one); null on a Commercial property. - `size` (string | null, required, pattern `^-?[0-9]+$`): Square footage of the unit. - `propertyManagerID` (string | null, required, pattern `^-?[0-9]+$`): Deprecated: the unit's property manager record; no longer editable (use the property's `assignedToUserID`). - `property` (object, required): The unit's property (always active). - `propertyID` (string, required, pattern `^-?[0-9]+$`): Unique identifier for the property. - `propertyTypeID` (`property_types`, required) - `countryID` (string, required, max length 2): 2-character country code. - `address` (string, required, max length 100): Street address of the property. - `address2` (string | null, required, max length 100) - `city` (string, required, max length 100) - `stateID` (string, required, max length 3): 2-character state or province code. - `postalCode` (string | null, required, max length 20) - `name` (string | null, required, max length 100): Optional display name for the property. - `yearBuilt` (string | null, required, pattern `^-?[0-9]+$`): Year the property was built. - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user assigned to manage this property. - `propertyShowingProviderID` (string | null, required, pattern `^-?[0-9]+$`): Showing provider ID configured on the property. - `showingProviderID` (one of several shapes, required): The property's showing provider type, or null when the property uses the account default. - One of: - Option 1: `showing_providers` - Option 2: null - `propertyGroups` (object, required) - `names` (string | null, required): The names of the property's groups, joined with `, `; null when it is in none. - `portfolio` (object, required) - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required): Display name of the portfolio. - `contacts` (string | null, required): The portfolio's owners as a JSON-encoded string (not decoded), an array of `{"name", "contactID", "percentOwned", "percentDistributed"}`, or null. Inside it the IDs and percentages are numbers in some rows and strings in others: read them as either. - `propertyManager` (object, required): The unit's property manager record; both fields null when it has none. - `propertyManagerID` (string | null, required, pattern `^-?[0-9]+$`): ID of the property manager assigned to the unit, or null if unassigned. - `name` (string | null, required): Display name of the property manager. - `image` (object, required): The unit's primary image. - `propertyImageID` (string, required, pattern `^-?[0-9]+$`): `1` is the shared no-image placeholder. - `small` (string | null, uri, required): CDN URL of the small rendition (`https://cdn.rentvine.com/{account}/properties/{propertyID}/images/{filePath}/small.{fileType}`); null for the placeholder. - `large` (string | null, uri, required): CDN URL of the large rendition; null for the placeholder. ### unit A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, `null` when empty. - `unitID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier. - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`): The property the unit belongs to. - `propertyImageID` (string, required, read-only, pattern `^-?[0-9]+$`): The unit's primary image (`1` is the shared no-image placeholder). - `isActive` (string, required, read-only, one of "0", "1"): `1` active, `0` deactivated. - `name` (string | null, required, max length 100): Unit name/number. - `address` (string, required, max length 100) - `streetNumber` (string | null, required, read-only, pattern `^-?[0-9]+$`): Leading street number parsed from `address`, or null when the address doesn't start with one. - `streetName` (string | null, required, read-only, max length 100): `address` with the leading street number removed. - `address2` (string | null, required, max length 100) - `stateID` (string, required, max length 3): Two-letter state or province code. - `city` (string, required, max length 100) - `postalCode` (string | null, required, max length 20) - `latitude` (string, decimal, required, read-only): Geocoded on create (multi-unit property) or copied from the property; `0.00000000` when unknown. - `longitude` (string, decimal, required, read-only): Geocoded on create (multi-unit property) or copied from the property; `0.00000000` when unknown. - `addressValidationStatusID` (`address_validation_statuses`, required, read-only): Result of the last address validation. Reset to `1` on create and on an address change; resolved in the background. * `1` - Not Validated * `2` - Valid * `3` - Invalid * `4` - Incomplete - `addressValidationData` (one of several shapes, required, read-only): The last address-validation verdict, or null before the first run and after a reset. - One of: - Option 1: `address_validation_data` - Option 2: null - `rent` (string, decimal, required): Market rent. - `deposit` (string | null, decimal, required): Market security deposit. - `size` (string | null, required, pattern `^-?[0-9]+$`): Size in square feet. - `beds` (one of several shapes, required): Bedrooms (`0` is a studio). Null on a Commercial property. - One of: - Option 1: `property_beds` - Option 2: null - `fullBaths` (one of several shapes, required): Full bathrooms. Null on a Commercial property. - One of: - Option 1: `property_baths` - Option 2: null - `halfBaths` (one of several shapes, required): Half bathrooms. Null on a Commercial property. - One of: - Option 1: `property_baths` - Option 2: null - `leaseID` (string | null, required, read-only, pattern `^-?[0-9]+$`): The unit's current lease, or null when vacant. - `propertyManagerID` (string | null, required, pattern `^-?[0-9]+$`): Deprecated: the unit's property manager record; no longer editable (use the property's `assignedToUserID`). - `commercialSpaceTypeID` (one of several shapes, required): Commercial space type; always null unless the property type is Commercial (`9`). * `1` - Office * `2` - Industrial * `3` - Retail * `4` - Restaurant * `5` - Medical * `6` - Special Purpose * `7` - Storage * `8` - Warehouse * `9` - Multi-use - One of: - Option 1: `commercial_space_types` - Option 2: null - `isNonRevenue` (string, required, one of "0", "1"): `1` when the unit is non-revenue. - `nonRevenueTypeID` (one of several shapes, required): Why the unit is non-revenue; null unless `isNonRevenue` is `1`. * `1` - Renovation * `2` - Employee * `3` - Model * `4` - Other * `5` - For Sale * `6` - Lease Only - One of: - Option 1: `non_revenue_types` - Option 2: null - `nonRevenueStartDate` (string | null, date, required): When the unit became non-revenue; null unless `isNonRevenue` is `1`. - `isUtilityBillingEnabled` (string, required, one of "0", "1"): `1` when utility billing is on for the unit. - `filterDeliveryScheduleID` (string | null, required, pattern `^-?[0-9]+$`): The air-filter delivery schedule, or null. - `filterDeliveryAddressTypeID` (one of several shapes, required): Where air filters are delivered, or null when not configured. * `1` - Deliver to the Unit * `2` - Deliver to a Custom Address - One of: - Option 1: `filter_delivery_address_types` - Option 2: null - `filterDeliveryAddressID` (string | null, required, pattern `^-?[0-9]+$`): The custom filter delivery address; null unless `filterDeliveryAddressTypeID` is `2`. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isFromImport` (string, required, read-only, one of "0", "1"): `1` when the unit was created by an import. - `importSourceKey` (string | null, required, read-only, max length 100): The import's key for the row, or null. - `leaseNotes` (string | null, required) - `entryInstructions` (string | null, required): Resident-facing entry instructions. - `vendorEntryInstructions` (string | null, required): Vendor-facing entry instructions. - `maintenanceNotes` (string | null, required) ### primary_statuses * `1` - Pending * `2` - Open * `3` - Closed * `4` - On Hold * `5` - Cancelled ### vendor_work_order_statuses * `1` - Pending * `2` - Open * `3` - Closed * `4` - Rejected ### priorities * `1` - Low * `2` - Medium * `3` - High ### source_types * `1` - Portal * `2` - In Person * `3` - Email * `4` - Text Message * `5` - Phone * `6` - Recurring * `7` - Ai ### vendor_access_types * `1` - Permission To Enter * `2` - Tenant Presence Required * `3` - Not Applicable ### included_work_order A work order (every column of the row; the shared work order model lacks many of them). - `workOrderID` (string, required, read-only, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, required, pattern `^-?[0-9]+$`) - `workOrderProjectID` (string | null, required, pattern `^-?[0-9]+$`): ID of the work order project this record points to. - `recurringWorkOrderID` (string | null, required, pattern `^-?[0-9]+$`): ID of the recurring work order this record points to. - `isInternal` (string | null, required, one of "0", "1", null) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): ID of the lease this record points to. - `portfolioID` (string, required, pattern `^-?[0-9]+$`): ID of the portfolio this record points to. - `vendorTradeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the vendor trade this record points to. - `vendorContactID` (string | null, required, pattern `^-?[0-9]+$`): ID of the contact this record points to. - `primaryWorkOrderStatusID` (`primary_statuses`, required) - `workOrderStatusID` (string, required, pattern `^-?[0-9]+$`): ID of the work order status this record points to. - `vendorWorkOrderStatusID` (`vendor_work_order_statuses`, required) - `portalVendorWorkOrderStatusID` (`vendor_work_order_statuses`, required) - `vendorWorkOrderStatusUpdated` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `priorityID` (`priorities`, required) - `sourceTypeID` (one of several shapes, required) - One of: - Option 1: `source_types` - Option 2: null - `isOwnerApproved` (string, required, one of "0", "1") - `isVacant` (string, required, one of "0", "1") - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `requestedByContactID` (string | null, required, pattern `^-?[0-9]+$`): ID of the contact this record points to. - `estimatedAmount` (string | null, decimal, required) - `scheduledStartDate` (string | null, date, required) - `actualStartDate` (string | null, date, required) - `scheduledEndDate` (string | null, date, required) - `actualEndDate` (string | null, date, required) - `description` (string, required) - `diagnosticSummary` (object | null, required): The maintenance agent's diagnostic summary, decoded from JSON, or null. - `summary` (object, required): The structured summary the agent produced. - `narrative` (string, required) - `agent_type` (string, required) - `session_id` (string, required) - `message_count` (integer, required) - `processing_time_seconds` (number, required) - `agentSummary` (string | null, required) - `aiSessionID` (string | null, required, max length 36) - `isResolvedByRequestor` (string, required, one of "0", "1") - `vendorInstructions` (string | null, required) - `dateClosed` (string | null, date, required) - `closingDescription` (string | null, required) - `isSharedWithTenant` (string, required, one of "0", "1") - `isSharedWithOwner` (string, required, one of "0", "1") - `isNew` (string, required, one of "0", "1") - `createdByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `closedByUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `cancelledByUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `modifiedByUserID` (string, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `dateTimeModified` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `inspectionID` (string | null, required, pattern `^-?[0-9]+$`): ID of the inspection this record points to. - `incidentLocation` (string | null, required, max length 255) - `appointmentWindowStartDateTime` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isTenantPresenceRequired` (string | null, required, one of "0", "1", null) - `rejectedByVendorContactID` (string | null, required, pattern `^-?[0-9]+$`): ID of the contact this record points to. - `vendorRejectReason` (string | null, required, max length 3000) - `vendorClosingComments` (string | null, required, max length 3000) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) - `dateDue` (string | null, date, required) - `reviewID` (string | null, required, pattern `^-?[0-9]+$`): ID of the review this record points to. - `vendorAccessTypeID` (`vendor_access_types`, required) - `residentProvidedEntryInstructions` (string | null, required) - `entryInstructions` (string | null, required) - `isTenantFinanciallyResponsible` (string, required, one of "0", "1") - `workOrderTypeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the work order type this record points to. ### included_work_order_contact The work order's vendor contact. Every column is null when the work order has no vendor (the contact is joined optionally). - `contactID` (string | null, required, pattern `^-?[0-9]+$`) - `contactTypeID` (one of several shapes, required) - One of: - Option 1: `contact_types` - Option 2: null - `vendorTypeID` (string | null, required, pattern `^-?[0-9]+$`): ID of the vendor type this record points to. - `code` (string | null, required, max length 100) - `name` (string | null, required, max length 100) - `firstName` (string | null, required, max length 100) - `middleName` (string | null, required, max length 100) - `lastName` (string | null, required, max length 100) - `suffix` (string | null, required, max length 15) - `email` (string | null, required, max length 100) - `phone` (string | null, required, max length 20) - `countryID` (string | null, required, max length 2): ID of the country this record points to. - `address` (string | null, required, max length 100) - `address2` (string | null, required, max length 100) - `city` (string | null, required, max length 45) - `stateID` (string | null, required, max length 3) - `postalCode` (string | null, required, max length 30) - `birthDate` (string | null, date, required) - `defaultBillChargeAccountID` (string | null, required, pattern `^-?[0-9]+$`): ID of the account this record points to. - `payeeName` (string | null, required, max length 100) - `taxPayerName` (string | null, required, max length 100) - `taxFormTypeID` (one of several shapes, required) - One of: - Option 1: `form_types` - Option 2: null - `identificationTypeID` (one of several shapes, required) - One of: - Option 1: `identification_types` - Option 2: null - `identificationNumber` (string | null, required, max length 50) - `identificationCountryID` (string | null, required, max length 2): ID of the country this record points to. - `identificationIssuingLocation` (string | null, required, max length 100) - `identificationExpirationDate` (string | null, date, required) - `payoutTypeID` (one of several shapes, required) - One of: - Option 1: `payout_types` - Option 2: null - `otherPayoutTypeID` (one of several shapes, required) - One of: - Option 1: `other_payout_types` - Option 2: null - `achDetailsCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): ID of the ciphertext this record points to. - `achAccountNumberTruncated` (string | null, required, max length 4) - `achAccountTypeID` (one of several shapes, required) - One of: - Option 1: `bank_account_types` - Option 2: null - `achIsCorporateAccount` (string | null, required, one of "0", "1", null) - `holdPayments` (string | null, required, one of "0", "1", null) - `liabilityInsuranceName` (string | null, required, max length 100) - `liabilityInsurancePolicyNumber` (string | null, required, max length 50) - `liabilityInsuranceExpiresDate` (string | null, date, required) - `workersCompInsuranceName` (string | null, required, max length 100) - `workersCompInsurancePolicyNumber` (string | null, required, max length 50) - `workersCompInsuranceExpiresDate` (string | null, date, required) - `discountPercent` (string | null, decimal, required) - `discountAmount` (string | null, decimal, required) - `discountAmountMin` (string | null, decimal, required) - `discountAmountMax` (string | null, decimal, required) - `discountGraceDays` (string | null, required, pattern `^-?[0-9]+$`) - `isActive` (string | null, required, one of "0", "1", null) - `isInsuranceRequiredForPayment` (string | null, required, one of "0", "1", null) - `maxLineItemsOnPayment` (string | null, required, pattern `^-?[0-9]+$`) - `preventConsolidatedPayments` (string | null, required, one of "0", "1", null) - `isFromImport` (string | null, required, one of "0", "1", null) - `importSourceKey` (string | null, required, max length 100) - `websiteUrl` (string | null, required, max length 500) - `applicantID` (string | null, required, pattern `^-?[0-9]+$`): ID of the applicant this record points to. - `ownerPortalNameOverride` (string | null, required, max length 100) - `isBillApprovalExempt` (string | null, required, one of "0", "1", null) - `isBillingSalesTaxEnabled` (string | null, required, one of "0", "1", null) - `isQuickbooksExportEnabled` (string | null, required, one of "0", "1", null) - `quickbooksCustomerName` (string | null, required, max length 100) - `invoiceAutofillTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the invoice autofill template this record points to. - `dateTimeCreated` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `contactType` (one of several shapes, required): The contact type's label (`Owner`, `Tenant`, `Vendor`, …), computed in PHP; `false` when `contactTypeID` is null. - One of: - Option 1: string - Option 2: any ### work_order_row A work order with its vendor contact. - `workOrder` (`included_work_order`, required) - `contact` (`included_work_order_contact`, required) ### lease_status A lease status (`lease_statuses`) — a per-account, orderable status row. `primaryLeaseStatusID` groups it under one of the system's primary lifecycle buckets; the move-in/move-out flags drive lifecycle transitions. - `leaseStatusID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the status. - `primaryLeaseStatusID` (string, pattern `^-?[0-9]+$`): The primary lifecycle bucket this status rolls up to. - `isSystemStatus` (string, one of "0", "1"): Whether this is a built-in system status (`1`) vs a PM-defined one (`0`). - `name` (string, required): Display name of the status. - `isPendingMoveInStatus` (string, one of "0", "1"): Whether a lease in this status is pending move-in (`1`/`0`). - `isPendingMoveOutStatus` (string, one of "0", "1"): Whether a lease in this status is pending move-out (`1`/`0`). - `isCompletedMoveOutStatus` (string, one of "0", "1"): Whether a lease in this status has completed move-out (`1`/`0`). - `orderIndex` (string, pattern `^-?[0-9]+$`): Sort order within the status list. ### lease_balances Balances of the current lease, computed for the account's local date. Most values are decimal strings from the database; three are computed in PHP and can arrive as JSON numbers (see each one). - `depositBalance` (string, decimal, required) - `generalDepositBalance` (string, decimal, required) - `specializedDepositBalance` (string, decimal, required) - `unpaidTotalDepositBalance` (string, decimal, required) - `unpaidGeneralDepositBalance` (string, decimal, required) - `unpaidSpecializedDepositBalance` (string, decimal, required) - `currentDepositBalance` (string, decimal, required) - `futureDepositBalance` (number, required): Unpaid deposit not yet due. Computed in PHP, so it is a JSON number (`0`, `150.5`), not a string. - `prepaymentBalance` (string, decimal, required) - `currentBalance` (string | number, decimal, required): Balance due now, deposits included. A decimal string when the lease has charges; the JSON number `0` when it has none. - `overdueChargeBalance` (string, decimal, required) - `overdueRentBalance` (string, decimal, required) - `futureChargeBalance` (string, decimal, required) - `upcomingBalance` (number, required): `currentBalance` plus `futureChargeBalance`. Computed in PHP, so it is a JSON number, not a string. ### listing The unit listing. When the unit has no listing row yet, an unsaved listing comes back: `propertyID`, `unitID` and `includedUtilities` set and every other column null. Besides the columns it carries two computed keys, `includedUtilities` and `defaultApplicationUrl`. - `propertyListingID` (string | null, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string | null, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string | null, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `isActive` (string | null, required, one of "0", "1", null) - `name` (string | null, required, max length 100) - `email` (string | null, required, max length 100) - `phone` (string | null, required, max length 20) - `phoneExtension` (string | null, required, max length 20) - `secondaryName` (string | null, required, max length 100) - `secondaryEmail` (string | null, required, max length 100) - `secondaryPhone` (string | null, required, max length 20) - `secondaryPhoneExtension` (string | null, required, max length 20) - `headline` (string | null, required, max length 200) - `description` (string | null, required) - `depositDescription` (string | null, required, max length 500) - `lotSize` (string | null, required, max length 100) - `isFurnished` (string | null, required, one of "0", "1", null) - `parkingSpaces` (string | null, required, pattern `^-?[0-9]+$`) - `parkingTypeID` (one of several shapes, required) - One of: - Option 1: `parking_types` - Option 2: null - `areaInformation` (string | null, required) - `schools` (string | null, required) - `virtualTour` (string | null, required, max length 2000) - `leaseDescription` (string | null, required, max length 1000) - `acceptDogs` (string | null, required, one of "0", "1", null) - `acceptCats` (string | null, required, one of "0", "1", null) - `petDescription` (string | null, required, max length 1000) - `acceptSmoking` (string | null, required, one of "0", "1", null) - `acceptAssistance` (string | null, required, one of "0", "1", null) - `availabilityDate` (string | null, date, required) - `advertisedDate` (string | null, date, required) - `isGasIncluded` (string | null, required, one of "0", "1", null) - `isElectricIncluded` (string | null, required, one of "0", "1", null) - `isWaterIncluded` (string | null, required, one of "0", "1", null) - `isSewageIncluded` (string | null, required, one of "0", "1", null) - `isGarbageIncluded` (string | null, required, one of "0", "1", null) - `isLandscapingIncluded` (string | null, required, one of "0", "1", null) - `isCableIncluded` (string | null, required, one of "0", "1", null) - `isInternetIncluded` (string | null, required, one of "0", "1", null) - `isSnowRemovalIncluded` (string | null, required, one of "0", "1", null) - `isPoolServiceIncluded` (string | null, required, one of "0", "1", null) - `heatType` (string | null, required, max length 200) - `coolingSystemTypeID` (one of several shapes, required) - One of: - Option 1: `cooling_system_types` - Option 2: null - `heatingSystemTypeID` (one of several shapes, required) - One of: - Option 1: `heating_system_types` - Option 2: null - `lockboxNumber` (string | null, required, max length 100) - `lockboxDescription` (string | null, required, max length 2000) - `applicationUrl` (string | null, required, max length 500): The listing's own application link, or null. Validated as a URL when a listing is saved today, but rows saved before that check can hold other text (a bare host name), so it isn't declared a URI. - `isWebsiteActive` (string | null, required, one of "0", "1", null) - `isZillowActive` (string | null, required, one of "0", "1", null) - `isRentalSourceActive` (string | null, required, one of "0", "1", null) - `isRentalscomActive` (string | null, required, one of "0", "1", null) - `isZumperActive` (string | null, required, one of "0", "1", null) - `isApartmentsActive` (string | null, required, one of "0", "1", null) - `dateTimeCreated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeDeactivated` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `includedUtilities` (string, required): The included utilities as a readable list, `No Utilities Included` when none. - `defaultApplicationUrl` (string | null, required): The application link the listing uses when `applicationUrl` is empty: the Rentvine application page for the unit when the Rentvine application is on, the account-wide link for an external provider, otherwise null. ### listing_file A file (photo or document) attached to a listing. A row with a null `propertyListingID` is an account-wide file shown on every listing. - `listingFileID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyListingID` (string | null, required, pattern `^-?[0-9]+$`): The listing the file belongs to, or null for an account-wide file shown on every listing. - `title` (string, required, max length 100) - `filePath` (string, required, max length 100) - `fileType` (string, required, max length 20) - `fileSize` (string, required, pattern `^-?[0-9]+$`) - `orderIndex` (string, required, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### appliance_types * `1` - Central Vacuum * `2` - Dryer * `3` - Washer * `4` - Washer Dryer Combo * `5` - Dishwasher * `6` - Garbage Disposal * `7` - HVAC * `8` - Microwave * `9` - Oven * `10` - Refrigerator * `11` - Stove * `12` - Sump Pump * `13` - Water Heater * `14` - Other * `15` - Furnace * `16` - Central Air Conditioning * `17` - Window Air Conditioner ### appliance An appliance in a unit. - `applianceID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `applianceTypeID` (`appliance_types`, required) - `brand` (string | null, required, max length 100) - `description` (string | null, required, max length 1000) - `modelNumber` (string | null, required, max length 100) - `serialNumber` (string | null, required, max length 100) - `hasWarranty` (string, required, one of "0", "1") - `warrantyExpiresDate` (string | null, date, required) - `manufacturedDate` (string | null, date, required) - `purchasedDate` (string | null, date, required) - `cost` (string | null, decimal, required) ### filter_brands * `1` - Trion * `2` - Generic * `3` - White Rodgers * `4` - Generic * `5` - Honeywell * `6` - White Rodgers * `7` - Generic * `8` - White Rodgers * `9` - Generic * `10` - Honeywell * `11` - White Rodgers * `12` - Bryant * `13` - Carrier * `14` - General Aire * `15` - Honeywell * `16` - Lennox * `17` - Trion AirBear * `18` - Honeywell * `19` - Lennox * `20` - Trion AirBear * `21` - Bryant * `22` - Carrier * `23` - General Aire * `24` - Honeywell * `25` - Lennox * `26` - Lennox * `27` - Skuttle * `28` - Trion AirBear ### filter An air filter installed in a unit. - `filterID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `length` (string, decimal, required) - `width` (string, decimal, required) - `depth` (string, decimal, required) - `filterBrandID` (one of several shapes, required) - One of: - Option 1: `filter_brands` - Option 2: null - `quantity` (string, required, pattern `^-?[0-9]+$`) - `location` (string | null, required, max length 100) - `description` (string | null, required, max length 1000) - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### filter_delivery_configuration Whether the unit's air-filter delivery is fully set up. Computed in PHP, so the values are JSON booleans and an integer. - `isConfigured` (boolean, required): True when the schedule, the address type, the address (for a custom address) and at least one filter are all set. - `isFilterDeliveryScheduleConfigured` (boolean, required) - `isFilterDeliveryAddressTypeConfigured` (boolean, required) - `isFilterDeliveryAddressConfigured` (boolean, required) - `configuredFilterCount` (integer, required): Number of filters recorded on the unit. ### filter_delivery_address An address book entry air filters can be delivered to. - `filterDeliveryAddressID` (string, required, read-only, pattern `^-?[0-9]+$`) - `isActive` (string, required, one of "0", "1") - `name` (string, required, max length 100) - `countryID` (string, required, max length 2): ID of the country this record points to. - `address` (string, required, max length 255) - `address2` (string | null, required, max length 255) - `city` (string, required, max length 100) - `stateID` (string, required, max length 2) - `postalCode` (string, required, max length 20) - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### filter_delivery_schedule An air-filter delivery schedule. - `filterDeliveryScheduleID` (string, required, read-only, pattern `^-?[0-9]+$`) - `isActive` (string, required, one of "0", "1") - `name` (string, required, max length 100) - `deliveryMonths` (string, required, pattern `^-?[0-9]+$`): Bit mask of the delivery months (bit 0 January … bit 11 December). - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### property_manager A property manager record (deprecated on units: assign the property instead). - `propertyManagerID` (string, required, read-only, pattern `^-?[0-9]+$`) - `name` (string, required, max length 500) - `email` (string | null, required, max length 100) - `phone` (string | null, required, max length 20) ### portfolio_balances Balances of the portfolio's ledger. When the ledger has balance rows, every value is a string from the database and the optional keys below are sent too; when it has none, only the required keys are sent, the balances as the JSON number `0` (and the reserve amounts as the portfolio's strings). - `ledgerID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `ledgerTypeID` (`ledger_types`, required) - `objectID` (string, required, pattern `^-?[0-9]+$`): The portfolio ID. - `additionalReserveAmount` (string | number, decimal, required) - `reserveAmount` (string | number, decimal, required) - `cashBalance` (string | number, decimal, required): A decimal string from the database, or the JSON number `0` when the ledger has no balance rows. The other balances below behave the same way. - `escrowBalance` (string | number, decimal, required) - `prepaymentBalance` (string | number, decimal, required) - `depositBalance` (string | number, decimal, required) - `nonHeldDepositBalance` (string | number, decimal, required) - `accountsReceivableBalance` (string | number, decimal, required) - `accountsPayableBalance` (string | number, decimal, required) - `creditBalance` (string | number, decimal, required) - `liabilityBalance` (string | number, decimal, required) - `nonHeldLiabilityBalance` (string | number, decimal, required) - `undepositedReceiptsBalance` (string | number, decimal, required) - `undepositedEscrowReceiptsBalance` (string | number, decimal, required) - `operatingBalance` (string | number, decimal, required) - `workOrderEstimateBalance` (string | number, decimal, required) - `overdraftOverrideAmount` (string | null, decimal): Sent only when the ledger has balance rows. - `currentCreditBalance` (string, decimal): Sent only when the ledger has balance rows. - `currentAccountsPayableBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedPrepaymentReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedLiabilityReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedDepositReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedManualReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedPrepaymentManualReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedLiabilityManualReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `undepositedDepositManualReceiptsBalance` (string, decimal): Sent only when the ledger has balance rows. - `availableFunds` (string, decimal): Sent only when the ledger has balance rows. ### property_portfolio_row One ownership period of the property, with a summary of the property and of the portfolio that owned it. - `propertyPortfolio` (object, required) - `propertyPortfolioID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `isCurrent` (string, required, one of "0", "1"): `1` for the current owner. - `startDate` (string | null, date, required): When the portfolio took ownership; null for the first owner. - `endDate` (string | null, date, required): When the ownership ended; null for the current owner. - `property` (object, required) - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `name` (string | null, required, max length 100) - `propertyTypeID` (`property_types`, required) - `isMultiUnit` (string, required, one of "0", "1") - `address` (string, required, max length 100) - `address2` (string | null, required, max length 100) - `city` (string, required, max length 100) - `stateID` (string, required, max length 3) - `postalCode` (string | null, required, max length 20) - `countryID` (string, required, max length 2) - `portfolio` (object, required) - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `name` (string, required) - `contacts` (object[] | null, required): The portfolio's owners, decoded from JSON; null until first built. Older rows store `contactID` and the percentages as JSON numbers, newer rows as strings. - `name` (string, required) - `contactID` (string | integer, required, pattern `^-?[0-9]+$`) - `percentOwned` (string | number, decimal, required) - `percentDistributed` (string | number, decimal, required) ### owner_row An owner of the portfolio with their contact record. - `owner` (combined object, required) - All of: - Option 1: `portfolio_owner` - Option 2: any - `contact` (`included_contact`, required) ### lease_fee_types * `1` - None * `2` - Flat * `3` - Percent of Rent ### included_management_fee_setting A management fee setting. - `managementFeeSettingID` (string, required, read-only, pattern `^-?[0-9]+$`) - `isActive` (string, required, one of "0", "1") - `name` (string, required, max length 200) - `description` (string | null, required, max length 1000) - `shortDescription` (string | null, required, max length 255) - `receivedPaymentPercent` (string | null, decimal, required) - `receivedPaymentMinimum` (string | null, decimal, required) - `recurringFixedAmount` (string | null, decimal, required) - `recurringPercentOfMarketRent` (string | null, decimal, required) - `recurringPercentOfActualRent` (string | null, decimal, required) - `vacantFixedAmount` (string | null, decimal, required) - `vacantPercentOfMarketRent` (string | null, decimal, required) - `leaseFeeTypeID` (`lease_fee_types`, required) - `leaseFeePercent` (string | null, decimal, required) - `leaseFeeAmount` (string | null, decimal, required) - `renewalFeeTypeID` (`lease_fee_types`, required) - `renewalFeePercent` (string | null, decimal, required) - `renewalFeeAmount` (string | null, decimal, required) ### inspection_types * `1` - Pre-Inspection * `2` - Move In * `3` - Move Out * `4` - Inspection ### inspection_statuses * `1` - Pending * `2` - In Progress * `3` - Pending Maintenance * `4` - Completed ### included_inspection An inspection (every column of the row; the shared inspection model types several IDs as string or number). - `inspectionID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`): ID of the property this record points to. - `unitID` (string, required, pattern `^-?[0-9]+$`): ID of the unit this record points to. - `leaseID` (string | null, required, pattern `^-?[0-9]+$`): ID of the lease this record points to. - `assignedToUserID` (string | null, required, pattern `^-?[0-9]+$`): ID of the user this record points to. - `inspectionTypeID` (`inspection_types`, required) - `inspectionStatusID` (`inspection_statuses`, required) - `description` (string | null, required) - `scheduledDate` (string | null, date, required) - `inspectionDate` (string | null, date, required) - `dateTimeCreated` (string, date, required, read-only) ### inspection_row An inspection. - `inspection` (`included_inspection`, required) - `token` (string, pattern `^[0-9]+$`): The current Unix time; carries no meaning for clients. ### association_row A homeowners' association linked to the property, with the association's contact record. - `propertyAssociation` (object, required) - `propertyAssociationID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `associationContactID` (string, required, pattern `^-?[0-9]+$`): The association's contact. - `associationContact` (`included_contact`, required) ### processing_fee_types * `1` - I will pay the fee * `2` - Tenant pays the fee ### included_template An application (screening) template. - `templateID` (string, required, read-only, pattern `^-?[0-9]+$`) - `name` (string, required, max length 100) - `isActive` (string, required, one of "0", "1") - `applicationFeeAmount` (string, decimal, required) - `processingFeeTypeID` (`processing_fee_types`, required) - `isLockRentAmount` (string, required, pattern `^-?[0-9]+$`) - `isLockDepositAmount` (string, required, pattern `^-?[0-9]+$`) - `isShowPendingApplicationMessage` (string, required, one of "0", "1") - `pendingApplicationMessage` (string | null, required) - `dateTimeCreated` (string, required, read-only): UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isDefault` (string, required, one of "0", "1") - `addendumTemplateID` (string | null, required, pattern `^-?[0-9]+$`): ID of the addendum template attached to this application template; null when none. ### showing_provider A showing provider configured on the account. - `propertyShowingProviderID` (string, required, read-only, pattern `^-?[0-9]+$`) - `showingProviderID` (`showing_providers`, required) - `name` (string, required, max length 100) - `isDefault` (string, required, one of "0", "1") - `settings` (object | null, required): Provider-specific connection settings (decoded JSON); the keys differ by provider. ### property_update The update body: every key optional, only the keys sent are changed. Only these keys are read (the controller's `assign()` whitelist); any other key is ignored, including `portfolioID` (change it with the portfolio transfer route), `isMultiUnit` and `isActive` (use the activate and deactivate routes). Dates are parsed loosely: `YYYY-MM-DD` and `MM/DD/YYYY` are both accepted, and are returned as `YYYY-MM-DD`. - `propertyTypeID` (`property_types_request`): The property type, from the fixed list below (no lookup route): the values are the enum. A multi-unit property can't be switched to a type that doesn't allow multiple units. * `1` - Single Family Home * `2` - Apartment * `3` - Condo * `4` - Townhouse * `5` - Duplex * `6` - Multiplex * `7` - Loft * `8` - Mobile Home * `9` - Commercial * `10` - Garage * `11` - Lot - `managementFeeSettingID` (string | integer, pattern `^-?[0-9]+$`): The management fee setting, from `GET /settings/management-fees` (undocumented). - `name` (string | null, max length 100): Display name. - `countryID` (string, max length 2): Two-letter country code, from `GET /countries` (undocumented). - `address` (string, max length 100): Street address. A changed address (or `address2`, `city`, `stateID`, `postalCode`) is geocoded again and resets address validation. - `address2` (string | null, max length 100): Second address line (suite, unit). - `stateID` (string, max length 3): State or province code of `countryID`, from `GET /states` (undocumented). - `city` (string, max length 100): City. At most 50 characters on a single-family property, whose unit takes a copy capped at 50. - `postalCode` (string | null, max length 20): Postal (ZIP) code. - `county` (string | null, max length 100): County. - `legalDescription` (string | null, max length 100): Legal description of the lot. - `maintenanceLimitAmount` (string | number | null, decimal, minimum 0): Not negative. - `yearBuilt` (string | integer | null, pattern `^-?[0-9]+$`): A positive whole number; empty is stored as null. - `dateInsuranceExpires` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `dateWarrantyExpires` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `maintenanceNotes` (string | null, max length 65535): Internal maintenance notes. - `applicationTemplateID` (string | integer | null, pattern `^-?[0-9]+$`): An application template ID; must exist. - `reserveAmount` (string | number | null, decimal, default "0.00", minimum 0): Not negative; empty is stored as `0.00`. - `markupPercent` (string | number | null, decimal): Maintenance markup percent, 0.1 to 99. Can't be sent together with a non-empty `markupAmount`. `0` is stored as null. - `markupAmount` (string | number | null, decimal, minimum 0): Maintenance markup as a fixed amount. Can't be sent together with a non-empty `markupPercent`. `0` is stored as null. - `markupAmountMin` (string | number | null, decimal, minimum 0): `0` is stored as null. - `markupAmountMax` (string | number | null, decimal, minimum 0): `0` is stored as null. - `dateContractBegins` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `dateContractEnds` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`; normalized to `YYYY-MM-DD`. - `commercialClassTypeID` (string | integer | null, one of "1", "2", "3", "4", 1, 2, 3, 4, null): Stored only for a Commercial property (`propertyTypeID` `9`); cleared for any other type. * `1` - A * `2` - B * `3` - C * `4` - D - `salesTaxSettingID` (string | integer | null, pattern `^-?[0-9]+$`): A sales tax setting ID; must exist. - `withholdingTaxAgencyID` (string | integer | null, pattern `^-?[0-9]+$`): A withholding tax agency ID; must exist. - `insuranceCompany` (string | null, max length 100): The property's insurance carrier. - `insuranceAgent` (string | null, max length 100): The property's insurance agent. - `insurancePolicyNumber` (string | null, max length 50): The property's insurance policy number. - `insuranceContactDetails` (string | null, max length 500): How to reach the insurance carrier or agent. - `requiredRentersInsuranceLiabilityAmount` (string | number | null, decimal, minimum 0): Renters insurance liability coverage required of tenants. Not negative. - `leaseReturnChargeAmount` (string | number | null, decimal, minimum 0): Not negative; empty or `0` is stored as null. - `defaultMonthToMonthPremiumSettingID` (string | integer | null, pattern `^-?[0-9]+$`): A month-to-month premium setting ID; must exist. - `defaultResidentPackageID` (string | integer | null, pattern `^-?[0-9]+$`): A resident package ID; must exist. - `propertyShowingProviderID` (string | integer | null, pattern `^-?[0-9]+$`): A configured showing provider ID; must exist. - `deactivationReasonID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", "7", "8", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "98", "99", 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 98, 99, null): Kept only while the property is inactive; an active property's reason is always cleared. Labels as on the response. - `deactivationNotes` (string | null, max length 65535): Kept only while the property is inactive. - `assignedToUserID` (string | integer | null, pattern `^-?[0-9]+$`): The user to assign the property to; must exist. ### unit_create The create-unit body. Only these keys are read; any other key (a `propertyID` included) is ignored. `{}` counts as empty and is refused. - `name` (string | null, max length 100): Display name. - `address` (string, required, max length 100): Street address; the leading number is split into `streetNumber`. - `streetNumber` (string | integer | null, pattern `^-?[0-9]+$`): Overwritten from `address` on save. - `streetName` (string | null): Overwritten from `address` on save. - `address2` (string | null, max length 100): Second address line (suite, unit). - `stateID` (string, required, max length 3): State or province code, from `GET /states` (undocumented). - `city` (string, required, max length 50): City. - `postalCode` (string | null, max length 20): Postal (ZIP) code. - `rent` (string | number, decimal, required, minimum 0): Market rent. Not negative. - `deposit` (string | number | null, decimal, minimum 0): Market security deposit; not negative. - `size` (string | integer | null, pattern `^([0-9]+)?$`): Square feet, not negative. An empty value (`""` or `0`) is normalized to null. - `beds` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. - `fullBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `halfBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `commercialSpaceTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", "7", "8", "9", 1, 2, 3, 4, 5, 6, 7, 8, 9, null): Kept only on a Commercial property. Labels as on the unit response. - `isNonRevenue` (string | integer, one of "0", "1", 0, 1, default 0): `1` marks the unit non-revenue (needs `nonRevenueTypeID`). - `nonRevenueTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", 1, 2, 3, 4, 5, 6, null): Required when `isNonRevenue` is `1`; cleared otherwise. Labels as on the unit response. - `nonRevenueStartDate` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`, normalized to `YYYY-MM-DD`; cleared unless `isNonRevenue` is `1`. - `leaseNotes` (string | null): Internal notes shown on the unit's leases. - `entryInstructions` (string | null): Entry instructions for residents and staff. - `vendorEntryInstructions` (string | null): Entry instructions for vendors. - `maintenanceNotes` (string | null): Internal maintenance notes. - `attachments` (string | integer[]): IDs of already uploaded files to link to the new unit. ### unit_update The update body: every key optional, only the keys sent are changed. Only these keys are read; any other key is ignored. `{}` counts as empty and is refused. - `name` (string | null, max length 100): Display name. - `address` (string, max length 100): Street address. A change resets address validation; on a single-family property the new address is also written to the property. - `address2` (string | null, max length 100): Second address line (suite, unit). - `stateID` (string, max length 3): State or province code, from `GET /states` (undocumented). - `city` (string, max length 50): City. - `postalCode` (string | null, max length 20): Postal (ZIP) code. - `rent` (string | number, decimal, minimum 0): Market rent. Not negative. - `deposit` (string | number | null, decimal, minimum 0): Market security deposit; not negative. - `size` (string | integer | null, pattern `^([0-9]+)?$`): Square feet, not negative. An empty value (`""` or `0`) is normalized to null. - `beds` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. - `fullBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `halfBaths` (string | integer | null, one of "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, null): 0 to 10; defaults to 0. Ignored on a Commercial property. - `propertyManagerID` (string | integer | null, pattern `^-?[0-9]+$`): Deprecated and read-only in practice. Sending a value different from the stored one (other than empty) is refused with a 400; use the property's `assignedToUserID` instead. - `commercialSpaceTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", "7", "8", "9", 1, 2, 3, 4, 5, 6, 7, 8, 9, null): Kept only on a Commercial property. Labels as on the unit response. - `isNonRevenue` (string | integer, one of "0", "1", 0, 1, default 0): `1` marks the unit non-revenue (needs `nonRevenueTypeID`). - `nonRevenueTypeID` (string | integer | null, one of "1", "2", "3", "4", "5", "6", 1, 2, 3, 4, 5, 6, null): Required when `isNonRevenue` is `1`; cleared otherwise. Labels as on the unit response. - `nonRevenueStartDate` (string | null): `YYYY-MM-DD` or `MM/DD/YYYY`, normalized to `YYYY-MM-DD`; cleared unless `isNonRevenue` is `1`. - `isUtilityBillingEnabled` (string | integer, one of "0", "1", 0, 1): `1` turns utility billing on for the unit. - `filterDeliveryScheduleID` (string | integer | null, pattern `^-?[0-9]+$`): An air-filter delivery schedule ID; must exist. - `filterDeliveryAddressTypeID` (string | integer | null, one of "1", "2", 1, 2, null): * `1` - Deliver to the Unit * `2` - Deliver to a Custom Address (needs `filterDeliveryAddressID`) - `filterDeliveryAddressID` (string | integer | null, pattern `^-?[0-9]+$`): Required when `filterDeliveryAddressTypeID` is `2`; cleared for any other type. Must exist. - `leaseNotes` (string | null): Internal notes shown on the unit's leases. - `entryInstructions` (string | null): Entry instructions for residents and staff. - `vendorEntryInstructions` (string | null): Entry instructions for vendors. - `maintenanceNotes` (string | null): Internal maintenance notes. ### unit_detail A unit, wrapped in `unit` (the `GET /properties/{propertyID}/units/{unitID}` shape without includes). - `unit` (`unit`, required) ### created_by_user_id The Rentvine user id of the user that created the object. ### unit_id_optional The unique id of the Unit object. See the [Unit API](https://docs.rentvine.com/#tag/Units) for more information. ### vendor_contact_id The contact id of the vendor contact that the work order has been assigned to. ### assigned_to_user_id The Rentvine user id of the user assigned to object. ### requested_by_contact_id The contact id of the resident that requested the work order. ### work_order_base - `workOrderProjectID` (string | null, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `unitID` (`unit_id_optional`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `vendorContactID` (`vendor_contact_id`) - `workOrderStatusID` (string, required, pattern `^-?[0-9]+$`): Unique id of the work order status. See [Work Order Status API](https://docs.rentvine.com/#tag/Work-Order-Statuses) for more information. - `priorityID` (`priorities`, required) - `isOwnerApproved` (string, required, one of "0", "1") - `isVacant` (string, required, one of "0", "1") - `assignedToUserID` (`assigned_to_user_id`) - `requestedByContactID` (`requested_by_contact_id`) - `estimatedAmount` (string | null, decimal) - `scheduledStartDate` (string | null, date) - `scheduledEndDate` (string | null, date) - `description` (string, required) - `vendorInstructions` (string | null) - `isSharedWithTenant` (string, required, one of "0", "1") - `isSharedWithOwner` (string, required, one of "0", "1") - `sourceTypeID` (one of several shapes): The method used to create the Work Order. E.g. sourceTypeID `1` indicates that the Work Order was created from the Portal. - One of: - Option 1: `source_types` - Option 2: null - `vendorTradeID` (string | null, pattern `^-?[0-9]+$`): The unique id of the vendor trade. See [Vendor Trades API](https://docs.rentvine.com/#tag/Vendor-Trades) for more information. ### work_order - All of: - Option 1: object - `workOrderID` (string, required, read-only, pattern `^-?[0-9]+$`) - `workOrderNumber` (string, required, pattern `^-?[0-9]+$`) - `portfolioID` (string, required, pattern `^-?[0-9]+$`) - `primaryWorkOrderStatusID` (`primary_statuses`, required) - `actualStartDate` (string | null, date) - `actualEndDate` (string | null, date) - `dateClosed` (string | null, date) - `closingDescription` (string | null) - `createdByUserID` (`created_by_user_id`, required) - `dateTimeCreated` (string, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `modifiedByUserID` (string, required, pattern `^-?[0-9]+$`) - `dateTimeModified` (string, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `inspectionID` (string | null, pattern `^-?[0-9]+$`) - `incidentLocation` (string | null) - `appointmentWindowStartDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `appointmentWindowEndDateTime` (string | null): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `orderIndex` (string, required, pattern `^-?[0-9]+$`) - Option 2: `work_order_base` ### work_order_search_contact A contact on a work order search row, its vendor (`vendorContact`) or the person who asked for the work (`requestedByContact`). Every key is `null` when the work order has none. - `contactID` (string | null, required, pattern `^-?[0-9]+$`): The contact's ID. - `name` (string | null, required, max length 100): The contact's display name. - `email` (string | null, required, max length 100): The contact's email address, if it has one. - `phone` (string | null, required, max length 20): The contact's phone number, if it has one. ### primary_statuses_request * `1` - Pending * `2` - Open * `3` - Closed * `4` - On Hold * `5` - Cancelled ### work_order_status_base - `primaryWorkOrderStatusID` (`primary_statuses_request`, required) - `name` (string, required): The name of the status ### work_order_status - All of: - Option 1: `work_order_status_base` - Option 2: object - `workOrderStatusID` (string, required, read-only, pattern `^-?[0-9]+$`) - `isSystemStatus` (string, required, one of "0", "1"): Indicates if the status is one of the 7 system statuses (`Open`, `Completed`, `Cancelled`, `Requested`, `On Hold`, `Estimating`, `Rejected`). Statuses created by user will not be a system status. - `orderIndex` (string, pattern `^-?[0-9]+$`) ### vendor_trade_base - `name` (string, required): Name of the vendor trade - `isVisibleTenantPortal` (string | integer, required, one of "0", "1", 0, 1): Indicates whether the trade is visible to the resident when they are creating work orders. ### vendor_trade - All of: - Option 1: object - `vendorTradeID` (string, required, read-only, pattern `^-?[0-9]+$`) - Option 2: `vendor_trade_base` ### unit_id_required The unique id of the Unit object. See the [Unit API](https://docs.rentvine.com/#tag/Units) for more information. ### inspection_types_request * `1` - Pre-Inspection * `2` - Move In * `3` - Move Out * `4` - Inspection ### inspection_statuses_request * `1` - Pending * `2` - In Progress * `3` - Pending Maintenance * `4` - Completed ### inspection_base - `unitID` (`unit_id_required`, required) - `inspectionTypeID` (`inspection_types_request`, required) - `inspectionStatusID` (`inspection_statuses_request`, required) - `description` (string | null) - `scheduledDate` (string | null, date) - `inspectionDate` (string | null, date) ### inspection - All of: - Option 1: object - `inspectionID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, pattern `^-?[0-9]+$`) - `leaseID` (string | null, pattern `^-?[0-9]+$`) - `assignedToUserID` (`assigned_to_user_id`) - `dateTimeCreated` (string, date, required) - Option 2: `inspection_base` ### material_base Fields accepted when creating or updating a maintenance material (inventory item). Only `name` and `sellPrice` are required on create; all other fields are optional. For updates, send only the fields being changed. - `name` (string, required, max length 200): Display name of the material - `description` (string | null, max length 4000): Optional description or supplier note - `isActive` (string | integer, one of "0", "1", 0, 1, default "1"): Active status. `1` = active, `0` = inactive - `upc` (string | null): Universal Product Code - `purchasePrice` (string | number | null, decimal): Cost to purchase the material (decimal as string) - `sellPrice` (string | number, decimal, required): Price charged when the material is used on a work order (decimal as string) ### material - All of: - Option 1: `material_base` - Option 2: object - `materialID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the material - `isDeleted` (string, required, read-only, one of "0", "1"): Soft-delete flag. `0` = active record, `1` = deleted - `dateTimeCreated` (string, required, read-only): Timestamp when the material was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the material was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### labor_rate_base Fields accepted when creating or updating a maintenance labor rate. `name` and `rate` are required; all other fields are optional. For updates, send only the fields being changed. - `name` (string, required): Display name of the labor rate - `description` (string | null): Optional description of the labor rate - `rate` (string | number, decimal, required): Rate charged to Owner for this labor type (decimal as string). Zero is allowed. - `hourlyRate` (string | number | null, decimal, required): The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. ### labor_rate - All of: - Option 1: `labor_rate_base` - Option 2: object - `laborRateID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the labor rate - `isDeleted` (string, read-only, one of "0", "1"): Makes the labor rate Non-Billable - `dateTimeCreated` (string, required, read-only): Timestamp when the labor rate was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): Timestamp when the labor rate was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`) - `propertyID` (string, required, read-only, pattern `^-?[0-9]+$`) - `unitID` (string, required, read-only, pattern `^-?[0-9]+$`) - `primaryLeaseStatusID` (`primary_lease_statuses`, required) - `leaseStatusID` (string, required, pattern `^-?[0-9]+$`) - `moveOutStatusID` (`move_out_statuses`, required) - `assignedToUserID` (string | null, pattern `^-?[0-9]+$`): ID of the user assigned to manage this lease. - `applicationID` (string | null, pattern `^-?[0-9]+$`) - `leaseDocumentTransactionID` (string | null, read-only, pattern `^-?[0-9]+$`) - `code` (string | null): Optional lease reference code. - `tenants` (string[] | null): Display names of the tenants on the lease. - `moveInDate` (string, date, required) - `startDate` (string, date, required) - `endDate` (string | null, date) - `tenantLiabilityInsuranceProviderID` (string | null, pattern `^-?[0-9]+$`) - `tenantLiabilityInsuranceEffectiveDate` (string | null, date) - `rentersInsuranceCompany` (string | null) - `rentersInsurancePolicyNumber` (string | null) - `rentersInsuranceExpirationDate` (string | null, date) - `rentersInsuranceFileID` (string | null, pattern `^-?[0-9]+$`) - `leaseFeeTransactionID` (string | null, pattern `^-?[0-9]+$`) - `leaseFeeBillID` (string | null, pattern `^-?[0-9]+$`) - `dateTimeCreated` (string, required): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `lateFeeSettingID` (string, required, pattern `^-?[0-9]+$`) - `isPortalDisabled` (string, required, one of "0", "1") - `isPortalPaymentDisabled` (string, required, one of "0", "1") - `isLateFeesActive` (string, required, one of "0", "1") - `allowedPaymentAmountTypeID` (string | null, pattern `^-?[0-9]+$`) - `isAchDisabled` (string | null, one of "0", "1", null) - `isCreditCardDisabled` (string | null, one of "0", "1", null) - `closedDate` (string | null, date) - `closedDescription` (string | null) - `noticeDate` (string | null, date) - `expectedMoveOutDate` (string | null, date) - `moveOutDate` (string | null, date) - `depositRefundDueDate` (string | null, date) - `leaseReturnChargeAmount` (string, decimal, required) - `moveOutReasonID` (string | null, pattern `^-?[0-9]+$`) - `moveOutUnitAvailabilityDate` (string | null, date) - `moveOutTenantRemarks` (string | null) - `moveOutLeaseTenantID` (string | null, pattern `^-?[0-9]+$`) - `isLeaseAgreementViolated` (string, required, one of "0", "1") - `forwardingName` (string | null) - `forwardingCountryID` (string | null) - `forwardingAddress` (string | null) - `forwardingAddress2` (string | null) - `forwardingCity` (string | null) - `forwardingStateID` (string | null) - `forwardingPostalCode` (string | null) - `forwardingEmail` (string | null) - `forwardingPhone` (string | null) - `moveOutTenantReason` (string | null) - `tenantRefundPayoutTypeID` (`tenant_refund_payout_types`, required) - `isFromImport` (string, required, one of "0", "1") - `importSourceKey` (string | null) - `isTenantPastDueNoticeEnabled` (string, required, one of "0", "1") - `rentvineInsuranceEnrollmentID` (string | null, pattern `^-?[0-9]+$`) - `rentvineInsuranceEnrollmentStatusID` (string | null, pattern `^-?[0-9]+$`) - `rentvineInsurancePackageID` (string | null, pattern `^-?[0-9]+$`) - `rentvineInsuranceRecurringChargeID` (string | null, pattern `^-?[0-9]+$`) - `rentvineInsuranceChargeID` (string | null, pattern `^-?[0-9]+$`) - `isCertifiedFundsRequired` (string, required, one of "0", "1"): Whether certified funds are required for this lease (0 or 1). - `isCashDisabled` (string | null, one of "0", "1", null): Whether cash payments are disabled for this lease (0 or 1). - `statementSettingID` (string | null, pattern `^-?[0-9]+$`): Statement setting override for this lease. - `sendStatements` (string | null, one of "0", "1", null): Whether statements are sent to tenants (0 or 1). - `leaseActivationOptionID` (string | null, pattern `^-?[0-9]+$`): Controls when the lease becomes active. - `increaseEligibilityDate` (string | null, date): Date after which the lease is eligible for a rent increase. - `dateTimeModified` (string, required, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `isAutoClosed` (string, required, read-only, one of "0", "1"): Whether the lease was automatically closed by the system (0 or 1). - `isPublicStatementEnabled` (string, required, one of "0", "1"): Whether public statements are enabled for this lease (0 or 1). - `isMarkedToVacate` (string, required, read-only, one of "0", "1"): Whether the lease has a notice to vacate recorded (0 or 1). - `rentAmount` (number, read-only): Sum of all active recurring charges on the lease. Computed field returned as a number. ### tenant A lease tenant row from the `tenants` include — the `lease_tenants` link joined to its `contact`. The contact's tax identifier is returned **truncated** (last 4) only; the raw value is never serialized. The `hasPortal*` / `hasApplicantUser` flags are present only when portal data is requested. - `leaseTenant` (object, required): The `lease_tenants` link row. - `leaseTenantID` (string, read-only, pattern `^-?[0-9]+$`) - `leaseID` (string, pattern `^-?[0-9]+$`) - `contactID` (string, pattern `^-?[0-9]+$`) - `isPrimary` (string, one of "0", "1"): Whether this is the primary tenant (`1`/`0`). - `isCosigner` (string, one of "0", "1"): Whether this tenant is a cosigner (`1`/`0`). - `isActive` (string, one of "0", "1"): Whether the tenant is active on the lease (`1`/`0`). - `moveInDate` (string | null, date) - `moveOutDate` (string | null, date) - `contact` (object, required): The tenant's contact (`contact_contacts`), augmented with a truncated tax id and (optionally) portal flags. - `contactID` (string, read-only, pattern `^-?[0-9]+$`) - `contactTypeID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `email` (string | null) - `phone` (string | null) - `birthDate` (string | null, date) - `applicantID` (string | null, pattern `^-?[0-9]+$`) - `identificationTypeID` (string | null, pattern `^-?[0-9]+$`) - `identificationNumber` (string | null) - `identificationIssuingLocation` (string | null) - `identificationExpirationDate` (string | null, date) - `identificationCountryID` (string | null) - `taxIdentifierTruncated` (string | null): Last 4 of the decrypted tax identifier, or null. The raw/encrypted value is never returned. - `hasPortalAccess` (integer): Present only with portal data — whether the tenant has a portal account (`1`/`0`). - `hasPortalInvitation` (integer): Present only with portal data — whether an unexpired portal invitation exists (`1`/`0`). - `invitationDateTimeCreated` (string | null, date-time): Present only with portal data — when the latest invitation was created, or null. - `hasApplicantUser` (integer): Present only with portal data — whether the contact resolves to an applicant user (`1`/`0`). ### lease_resident_package A lease's REP (Resident Experience Package) enrollment — a row in `lease_resident_packages`. A lease has at most one; it's never deleted, only turned off/back on via its status. `leaseRecurringChargeID` bridges to the resident's single bundled recurring charge. - `leaseResidentPackageID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the enrollment row. - `leaseID` (string, required, pattern `^-?[0-9]+$`): The lease this enrollment belongs to. - `residentPackageID` (string, required, pattern `^-?[0-9]+$`): The catalog package (`resident_packages`) the lease is enrolled in. - `leaseResidentPackageStatusID` (string, pattern `^-?[0-9]+$`): Enrollment status: `1` Active, `2` Cancelled. - `leaseRecurringChargeID` (string | null, pattern `^-?[0-9]+$`): The lease recurring charge (`lease_recurring_charges`) for the bundled package charge. - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### package A REP (Resident Experience Package) package — a PM-built bundle in `resident_packages`. A package groups services (see `packageServices`) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource). - `residentPackageID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the package. - `name` (string, required): Display name of the package. - `recurringChargeDescription` (string | null): Ledger-line text for the resident's bundled recurring charge. - `recurringChargeAccountID` (string | null, pattern `^-?[0-9]+$`): GL account (chart-of-accounts) the bundled charge posts to. Returned as the bare account id — resolve its name/number from the GL-account cache; the response does not embed the account. - `defaultRecurringChargeAmount` (string, decimal): Monthly retail amount charged to the resident for the bundle (must be greater than $0.00). - `isActive` (string, one of "0", "1"): Whether the PM offers this package (`1` = active, `0` = inactive). - `dateTimeCreated` (string, read-only): Timestamp when the package was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, read-only): Timestamp when the package was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease_resident_service A lease's REP service entitlement — a row in `lease_resident_services`. Either a package member (`residentPackageID` set, covered by the bundled charge) or à la carte (its own `leaseRecurringChargeID`). Never deleted, only turned off/back on via its status. - `leaseResidentServiceID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the entitlement row. - `leaseID` (string, required, pattern `^-?[0-9]+$`): The lease this entitlement belongs to. - `residentPackageID` (string | null, pattern `^-?[0-9]+$`): The catalog package this entitlement came from, when it's a package member; null for à la carte. - `residentServiceID` (string, required, pattern `^-?[0-9]+$`): The catalog service (`resident_services`) this entitlement is for. - `leaseResidentServiceStatusID` (string, pattern `^-?[0-9]+$`): Entitlement status: `1` Active, `2` Cancelled. - `leaseRecurringChargeID` (string | null, pattern `^-?[0-9]+$`): The à la carte recurring charge for this service; null for package members (covered by the bundle). - `dateTimeCreated` (string, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, read-only): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### service A REP (Resident Experience Package) service definition — a per-account catalog entry in `resident_services`. A service is either a **system** type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined **Custom** service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge. - `residentServiceID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the service. - `serviceTypeID` (string, required, pattern `^-?[0-9]+$`): Service type. System types are seeded; `1` (Custom) is a fully PM-defined service. `1` Custom, `2` Filter Delivery, `3` Pest Control, `4` ID Protection & Rewards, `5` Positive Credit Reporting, `6` Utility Connection, `7` Group Internet. - `name` (string | null): Display name. Required for a Custom service; a system service may leave it null, in which case the name resolves from the service type. - `description` (string | null): Optional resident-facing description of the service. - `recurringChargeDescription` (string | null): Ledger-line text for the resident's recurring charge. - `recurringChargeAccountID` (string | null, pattern `^-?[0-9]+$`): GL account (chart-of-accounts) the recurring charge posts to. Returned as the bare account id — resolve its name/number from the GL-account cache; the response does not embed the account. - `defaultRecurringChargeAmount` (string, decimal): Default monthly retail amount charged to the resident (must be greater than $0.00). - `isActive` (string, one of "0", "1"): Whether the PM offers this service (`1` = active, `0` = inactive). - `dateTimeCreated` (string, read-only): Timestamp when the service was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, read-only): Timestamp when the service was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### lease_pet An animal living at the lease's unit, as the lease's Animals card shows it. Each pet belongs to one lease; the flags are `1` (yes), `0` (no) or `null` (not answered). - `leasePetID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier of the pet. - `leaseID` (string, required, read-only, pattern `^-?[0-9]+$`): The lease the pet belongs to. - `type` (string, required, max length 100): Kind of animal, free text (`Dog`, `Cat`). - `name` (string | null, required, max length 100): The pet's name. - `age` (string | null, required, pattern `^[0-9]+$`): Age in whole years. - `weight` (string | null, required, max length 100): Weight, free text with its unit (`45 lbs`). - `isTrained` (string | null, required, one of "0", "1", null): Whether the pet is house-trained. - `color` (string | null, required, max length 100): Color, free text. - `hasShots` (string | null, required, pattern `^[0-9]+$`): Whether the pet's vaccinations are current: `1` yes, `0` no. Unlike the other flags, the API doesn't refuse another number on a write, so a pet saved with one (`2`) sends it back here. - `isNeutered` (string | null, required, one of "0", "1", null): Whether the pet is spayed or neutered. - `isDeclawed` (string | null, required, one of "0", "1", null): Whether the pet is declawed. - `isEmotionalSupportAnimal` (string | null, required, one of "0", "1", null): Whether the pet is an emotional support animal. - `isServiceAnimal` (string | null, required, one of "0", "1", null): Whether the pet is a service animal. - `gender` (string | null, required, max length 100): Gender, free text. - `dateTimeCreated` (string, required, read-only): When the pet was added. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `petScreeningAnimalID` (string | null, required, read-only, pattern `^-?[0-9]+$`): The animal's ID at the pet-screening provider, set when the pet came from the applicant's pet screening or was sent with the pet when the lease was created; `null` otherwise. The pet operations can't set it. ### lease_pet_request The pet's fields. Only these keys are read; any other key is ignored (the lease comes from the path, and `petScreeningAnimalID` can't be set here). `{}` counts as empty and is refused. Text is trimmed, and a value of only spaces is stored as `null`. The text fields are stored in a Latin-1 column, so a character outside Latin-1 (an emoji, CJK) isn't kept as sent. Each flag (`hasShots` and the `is*` keys) takes `1`, `true`, `"1"`, `"true"` or `"yes"` for yes and `0`, `false`, `"0"`, `"false"` or `"no"` for no (strings in any case), or `null` to clear it. Any other string is stored as `null` without an error; any other number is refused with a validation message, except on `hasShots`. - `type` (string, max length 100): Kind of animal, free text (`Dog`, `Cat`). Required on a create; can't be empty or only spaces. - `name` (string | null, max length 100): The pet's name. - `age` (string | integer | null, minimum 0, pattern `^[0-9]+$`): Age in whole years; digits only (`3.5` and `-1` are refused). The column holds 0 to 65535: a larger number passes validation, and what the database then does with it (store 65535, or refuse it as a 400) depends on its SQL mode, so keep to that range. - `weight` (string | null, max length 100): Weight, free text with its unit (`45 lbs`). - `color` (string | null, max length 100): Color, free text. - `gender` (string | null, max length 100): Gender, free text. - `hasShots` (string | integer | boolean | null): Whether the pet's vaccinations are current; the flag values above. Unlike the other flags, no check refuses another number: `2` is stored and sent back as `"2"`. The column holds 0 to 255; a larger number is clamped or refused by the database, as for `age`. - `isTrained` (string | integer | boolean | null): Whether the pet is house-trained; the flag values above. - `isNeutered` (string | integer | boolean | null): Whether the pet is spayed or neutered; the flag values above. - `isDeclawed` (string | integer | boolean | null): Whether the pet is declawed; the flag values above. - `isEmotionalSupportAnimal` (string | integer | boolean | null): Whether the pet is an emotional support animal; the flag values above. - `isServiceAnimal` (string | integer | boolean | null): Whether the pet is a service animal; the flag values above. ### lease_pet_detail One pet under `pet`, plus the pet's lease under `lease` when the `lease` include is asked for. - `pet` (`lease_pet`, required) - `lease` (`included_lease`): The pet's lease, every column of the lease row. Sent only with the `lease` include. ### schema - Any of: - One message: object - `error` (string, required): Why the request was refused. - `message` (string): A longer explanation, sent by a few refusals alongside `error`. - Validation messages: object ### application_submission The application, one key per section of the template, each named as below. A single section is an object of fields; a section that holds a list (occupants, vehicles, employment history and the like) is `{"items": [...]}`. Keys the template doesn't use are ignored. A manager-created application requires only the fields marked required here, in the sections the template has turned on; the template's own "required" choices and minimum item counts apply to applicants only. The four sections a template can't turn off are required, and each item of a list section needs its own required fields. A section the template turned off is ignored; a field it turned off within a section that is on isn't checked, but its value is still saved as sent. `GET /screening/templates/{templateID}/submission` (undocumented) lists the sections a template has on, each by its key here, with their fields. - `applyingFor` (object, required): The address applied for. Required even with a `unitID`, but then replaced by the unit's address. - `address` (string, required): Address. Replaced by the unit's when `unitID` is sent. At most 100 characters when no `unitID` is sent. - `address2` (string): Unit/Apt #. Replaced by the unit's when `unitID` is sent. At most 100 characters when no `unitID` is sent. - `city` (string, required): City. Replaced by the unit's when `unitID` is sent. At most 50 characters when no `unitID` is sent. - `stateID` (string, required): State. A state or province code, such as `FL`, from `GET /states` (undocumented); not checked. Replaced by the unit's when `unitID` is sent. - `postalCode` (string): Postal Code. Replaced by the unit's when `unitID` is sent. - `countryID` (string, required): Country. A two-letter country code, such as `US`, from `GET /countries` (undocumented); not checked. Replaced by the unit's when `unitID` is sent. - `leaseInfo` (object, required): Lease Info. - `agentName` (string, max length 100): Agent. - `agentContactInformation` (string, max length 100): Contact Info. - `rent` (string | number, required): Rent Amount. An amount, such as `1500` or `1500.00`. - `deposit` (string | number): Security Deposit. An amount, such as `1500` or `1500.00`. - `moveInDate` (string): Move In Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `leaseMonths` (string | integer): Length of Lease (months). The default options are `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`; a template can set its own, and a value must be one of the template's. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `personalInfo` (object, required): Personal Info. - `firstName` (string, required, max length 50): First Name. - `middleName` (string, max length 50): Middle Name. - `lastName` (string, required, max length 50): Last Name. - `applicantType` (string, one of "Applicant", "Cosigner", max length 200): I Am The. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `maritalStatus` (string, one of "Single", "Married", "Engaged", "Separated", "Divorced", "Widowed", "Unmarried Partners", max length 200): Marital Status. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `maidenName` (string, max length 50): Maiden Name. - `height` (string, max length 25): Height. - `weight` (string, max length 25): Weight. - `eyeColor` (string, max length 25): Eye Color. - `hairColor` (string, max length 25): Hair Color. - `homePhone` (string, max length 20): Home Phone. A phone number. - `workPhone` (string, max length 20): Work Phone. A phone number. - `cellPhone` (string, max length 20): Cell Phone. A phone number. - `email` (string, required, max length 75): Email. An email address. - `birthDate` (string, required): Date of Birth. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. Must be before today. - `ssn` (string, required): SSN / ITIN. A nine-digit Social Security or taxpayer number, with or without dashes. Stored encrypted; responses show only its last four digits. - `citizenship` (string, max length 100): Citizenship. - `birthPlace` (string, max length 50): Birth Place. - `passportID` (string, max length 50): Passport #. - `studentID` (string, max length 50): Student #. - `licenseNumber` (string, max length 50): Drivers License #. - `licenseState` (string): License State. - `referredBy` (string, max length 1000): How were you referred to us? - `emergencyContacts` (object): Emergency Contacts (a template can turn this section off). - `items` (object[]): One object per emergency contact. - `name` (string, required): Contact Name. - `relationship` (string): Relationship. - `address` (string): Full Address. - `phone` (string): Phone. A phone number. - `phone2` (string): Phone. A phone number. - `email` (string): Email. An email address. - `emergencyCustom1` (string): Custom 1. - `emergencyCustom2` (string): Custom 2. - `emergencyCustom3` (string): Custom 3. - `references` (object): References (a template can turn this section off). - `items` (object[]): One object per reference. - `name` (string, required): Reference Name. - `relationship` (string): Relationship. - `address` (string): Full Address. - `phone` (string): Phone. A phone number. - `vehicles` (object): Vehicles (a template can turn this section off). - `items` (object[]): One object per vehicle. - `make` (string, required): Make. - `model` (string, required): Model. - `yearBuilt` (string): Year Built. - `color` (string): Color. - `plateNumber` (string): Plate #. - `state` (string): Plate State. - `monthlyPayment` (string | number): Monthly Payment. An amount, such as `1500` or `1500.00`. - `insuranceCarrier` (string): Insurance Carrier. - `vehicleCustom1` (string): Custom 1. - `vehicleCustom2` (string): Custom 2. - `vehicleCustom3` (string): Custom 3. - `occupants` (object): Occupants (a template can turn this section off). - `items` (object[]): One object per occupant. - `name` (string, required): Name. - `birthDate` (string, required): Date of Birth. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. Must be before today. - `relationship` (string): Relationship. - `occupantCustom1` (string): Custom 1. - `occupantCustom2` (string): Custom 2. - `occupantCustom3` (string): Custom 3. - `pets` (object): Animals (a template can turn this section off). - `items` (object[]): One object per animal. - `name` (string, required): Animal Name. - `type` (string, required): Type / Breed. - `age` (string | integer): Age (years). A number; not checked. - `weight` (string | integer): Weight (lbs). A number; not checked. - `trained` (string, one of "Yes", "No"): House Trained? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `color` (string): Color. - `gender` (string, one of "Male", "Female", "Unspecified"): Gender. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `declawed` (string, one of "Yes", "No"): Declawed? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `shots` (string, one of "Yes", "No"): Has Shots? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `neutered` (string, one of "Yes", "No"): Spayed/Neutered? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `assistanceAnimal` (string, one of "Yes", "No"): Assistance Animal? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `petLicenseNumber` (string): License Number. - `hasBiteHistory` (string, one of "Yes", "No"): Has Bite History? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `biteHistoryDetails` (string): If Animal has bite history, please explain. - `petCustom1` (string): Custom 1. - `petCustom2` (string): Custom 2. - `petCustom3` (string): Custom 3. - `photos` (object[]): Photos. Each entry is an object with a `fileID`. Each file is attached to the applicant as an animal photo. - `fileID` (string | integer, required, pattern `^[0-9]+$`): A file uploaded with `POST /files`, or one from `GET /files`. - `name` (string): The file's name, kept with the photo. - `currentAddress` (object, required): Current Address. - `primaryAddress` (string, required, max length 100): Address. - `primaryAddress2` (string, max length 100): Unit/Apt #. - `primaryCity` (string, required, max length 100): City. - `primaryStateID` (string, required): State. A state or province code, such as `FL`, from `GET /states` (undocumented); not checked. - `primaryPostalCode` (string, required, max length 20): Postal Code. - `primaryCountryID` (string, required): Country. A two-letter country code, such as `US`, from `GET /countries` (undocumented); not checked. - `primaryRentOwn` (string, one of "Rent", "Own", max length 200): Rent / Own. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `primaryMonthlyPayment` (string | number): Monthly Payment. An amount, such as `1500` or `1500.00`. - `primaryMoveInDate` (string): Move In Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `primaryManagerName` (string, max length 100): Manager Name. - `primaryManagerPhone` (string, max length 20): Manager Phone. A phone number. - `primaryManagerEmail` (string, max length 75): Manager Email. An email address. - `primaryReasonForLeaving` (string): Reason for Leaving. - `addressHistory` (object): Address History (a template can turn this section off). - `items` (object[]): One object per address. - `address` (string, required): Address. - `address2` (string): Unit/Apt #. - `city` (string, required): City. - `stateID` (string, required): State. A state or province code, such as `FL`, from `GET /states` (undocumented); not checked. - `postalCode` (string): Postal Code. - `countryID` (string, required): Country. A two-letter country code, such as `US`, from `GET /countries` (undocumented); not checked. - `rentOwn` (string, one of "Rent", "Own"): Rent / Own. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `monthlyPayment` (string | number): Monthly Payment. An amount, such as `1500` or `1500.00`. - `moveInDate` (string): Move In Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `moveOutDate` (string): Move Out Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `managerName` (string): Manager Name. - `managerPhone` (string): Manager Phone. A phone number. - `managerEmail` (string): Manager Email. An email address. - `reasonForLeaving` (string): Reason for Leaving. - `managerType` (string, one of "Landlord", "Property Manager", "Relative", "Friend", "Apartment"): Manager Type. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `employmentHistory` (object): Employment History. - `items` (object[]): One object per employment history. - `isCurrentEmployer` (string, required, one of "Yes", "No"): Is This Your Current Employer? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `name` (string, required): Employer Name. - `phone` (string): Employer Phone. A phone number. - `address` (string): Employer Address. - `supervisorName` (string): Supervisor Name. - `supervisorTitle` (string): Supervisor Title. - `supervisorPhone` (string): Supervisor Phone. A phone number. - `supervisorEmail` (string): Supervisor Email. An email address. - `position` (string): Position / Job Description. - `monthlySalary` (string | number, required): Monthly Salary. An amount, such as `1500` or `1500.00`. - `startDate` (string): Start Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `endDate` (string): End Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `income` (object): Other Sources of Income (a template can turn this section off). - `items` (object[]): One object per income. - `name` (string, required): Income Source. - `monthlyAmount` (string | number, required): Monthly Amount. An amount, such as `1500` or `1500.00`. - `phone` (string): Phone #. A phone number. - `bankAccounts` (object): Bank Accounts (a template can turn this section off). - `items` (object[]): One object per bank account. - `name` (string, required): Name. - `accountType` (string, one of "Savings", "Checking"): Account Type. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `accountNumber` (string): Account #. - `balance` (string | number): Balance. An amount, such as `1500` or `1500.00`. - `creditCards` (object): Credit Cards (a template can turn this section off). - `items` (object[]): One object per credit card. - `name` (string, required): Issuer. - `balance` (string | number): Balance. An amount, such as `1500` or `1500.00`. - `assistance` (object): Assistance (a template can turn this section off). - `assistanceAgency` (string, max length 45): Agency. - `assistanceCounty` (string, max length 100): County. - `assistanceTechnician` (string, max length 100): Technician. - `assistancePhone` (string, max length 20): Phone. A phone number. - `assistanceAmount` (string | number): Assistance Amount. An amount, such as `1500` or `1500.00`. - `assistanceBeds` (string): Beds Allowed. - `assistanceUtility` (string, one of "Yes", "No", max length 200): Utilities Included. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `questions` (object[]): Answers to the template's questions, when its questions section is on. Each question's `variableFieldID` and label are in `GET /screening/templates/{templateID}/submission` (undocumented). Only the answers sent are checked; a question left out of the list isn't asked for. - `variableFieldID` (string | integer, required, pattern `^[0-9]+$`): The question, from `GET /screening/templates/{templateID}/submission` (undocumented). An ID that isn't any template's answers an empty 500. - `answer` (string | integer | boolean, required, one of "yes", "no", "true", "false", "1", "0", 1, 0, true, false): The answer, yes or no. - `reason` (string): The explanation; required when `answer` is yes. - `terms` (object[]): Acceptances of the template's terms, when its terms section is on. Each term's `variableFieldID` and text are in `GET /screening/templates/{templateID}/submission` (undocumented). Only the acceptances sent are checked; a term left out of the list isn't asked for. - `variableFieldID` (string | integer, required, pattern `^[0-9]+$`): The term, from `GET /screening/templates/{templateID}/submission` (undocumented). An ID that isn't any template's answers an empty 500. - `initials` (string, required): The applicant's initials, accepting the term. ### verification_report_statuses * `1` - Processing * `2` - Completed * `3` - Failed * `4` - Not Enabled * `5` - Skipped * `6` - Resent ### applicant An applicant: one person on a rental application, with what they entered. `POST /screening/applications` returns the applicant it created, with the values it was sent, not re-read from the database. - `applicantID` (string, required, read-only, pattern `^-?[0-9]+$`): The primary key of the applicant. - `applicationID` (string, required, pattern `^-?[0-9]+$`): The application the applicant belongs to, readable at `GET /screening/applications/{applicationID}`. - `number` (integer, required): The applicant's number on the account, assigned when it is created. A JSON number, unlike the IDs. - `templateID` (string, required, pattern `^-?[0-9]+$`): The template the application was created from. - `userID` (string | null, required, pattern `^-?[0-9]+$`): The applicant portal user who submitted it; null for an application a manager created. - `applicantContactID` (string, required, pattern `^-?[0-9]+$`): The applicant's contact record, created with the application from its name, email and phones. - `unitID` (string | integer | null, required, pattern `^[0-9]+$`): The unit applied for, as sent (a JSON number when sent as one); null when none was sent. - `countryID` (string | null, required, max length 2): Country of the address applied for: the unit's (always `US`) when `unitID` was sent, otherwise as sent under `application.applyingFor`. - `address` (string | null, required, max length 100): The address applied for: the unit's when `unitID` was sent, otherwise as sent under `application.applyingFor`. - `address2` (string | null, required, max length 100): Second line of the address applied for; the unit's, or as sent. - `city` (string | null, required, max length 50): City of the address applied for; the unit's, or as sent. - `stateID` (string | null, required, max length 3): State of the address applied for; the unit's, or as sent. - `postalCode` (string | null, required, max length 20): Postal code of the address applied for; the unit's, or as sent. - `rent` (string | number | null, required): Rent amount, as sent under `application.leaseInfo` (a JSON number when sent as one). - `deposit` (string | number | null, required): Security deposit, as sent (a JSON number when sent as one); null when not sent. - `moveInDate` (string | null, date, required): Move In Date, as sent under `application.leaseInfo.moveInDate`; null when not sent. - `leaseMonths` (string | integer | null, required): Length of the lease in months, as sent (a JSON number when sent as one); null when not sent. - `agentName` (string | null, required, max length 100): Agent, as sent under `application.leaseInfo.agentName`; null when not sent. - `agentContactInformation` (string | null, required, max length 100): Contact Info, as sent under `application.leaseInfo.agentContactInformation`; null when not sent. - `firstName` (string | null, required, max length 50): First Name, as sent under `application.personalInfo.firstName`; null when not sent. - `middleName` (string | null, required, max length 50): Middle Name, as sent under `application.personalInfo.middleName`; null when not sent. - `lastName` (string | null, required, max length 50): Last Name, as sent under `application.personalInfo.lastName`; null when not sent. - `email` (string | null, required, max length 75): Email, as sent under `application.personalInfo.email`; null when not sent. - `homePhone` (string | null, required, max length 20): Home Phone, as sent under `application.personalInfo.homePhone`; null when not sent. - `cellPhone` (string | null, required, max length 20): Cell Phone, as sent under `application.personalInfo.cellPhone`; null when not sent. - `workPhone` (string | null, required, max length 20): Work Phone, as sent under `application.personalInfo.workPhone`; null when not sent. - `birthDate` (string | null, date, required): Date of Birth, as sent under `application.personalInfo.birthDate`; null when not sent. - `birthPlace` (string | null, required, max length 50): Birth Place, as sent under `application.personalInfo.birthPlace`; null when not sent. - `ssnCiphertextID` (string | null, required, pattern `^-?[0-9]+$`): The stored, encrypted Social Security or taxpayer number. The number itself isn't returned. - `ssnTruncated` (string | null, required, max length 20): The last four digits of the Social Security or taxpayer number sent. - `licenseNumber` (string | null, required, max length 50): Drivers License #, as sent under `application.personalInfo.licenseNumber`; null when not sent. - `licenseState` (string | null, required, max length 50): License State, as sent under `application.personalInfo.licenseState`; null when not sent. - `passportID` (string | null, required, max length 50): Passport #, as sent under `application.personalInfo.passportID`; null when not sent. - `studentID` (string | null, required, max length 50): Student #, as sent under `application.personalInfo.studentID`; null when not sent. - `maidenName` (string | null, required, max length 50): Maiden Name, as sent under `application.personalInfo.maidenName`; null when not sent. - `height` (string | null, required, max length 25): Height, as sent under `application.personalInfo.height`; null when not sent. - `weight` (string | null, required, max length 25): Weight, as sent under `application.personalInfo.weight`; null when not sent. - `eyeColor` (string | null, required, max length 25): Eye Color, as sent under `application.personalInfo.eyeColor`; null when not sent. - `hairColor` (string | null, required, max length 25): Hair Color, as sent under `application.personalInfo.hairColor`; null when not sent. - `maritalStatus` (string | null, required, max length 200): Marital Status, as sent under `application.personalInfo.maritalStatus`; null when not sent. - `citizenship` (string | null, required, max length 100): Citizenship, as sent under `application.personalInfo.citizenship`; null when not sent. - `referredBy` (string | null, required, max length 1000): How were you referred to us?, as sent under `application.personalInfo.referredBy`; null when not sent. - `assistanceAgency` (string | null, required, max length 45): Agency, as sent under `application.assistance.assistanceAgency`; null when not sent. - `assistanceCounty` (string | null, required, max length 100): County, as sent under `application.assistance.assistanceCounty`; null when not sent. - `assistanceTechnician` (string | null, required, max length 100): Technician, as sent under `application.assistance.assistanceTechnician`; null when not sent. - `assistancePhone` (string | null, required, max length 20): Phone, as sent under `application.assistance.assistancePhone`; null when not sent. - `assistanceAmount` (string | number | null, required): Assistance amount, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. - `assistanceUtility` (string | null, required, max length 200): Utilities Included, as sent under `application.assistance.assistanceUtility`; null when not sent. - `assistanceBeds` (string | integer | null, required): Bedrooms the assistance covers, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. - `applicantType` (string | null, required, max length 200): I Am The, as sent under `application.personalInfo.applicantType`; null when not sent. - `primaryAddress` (string | null, required, max length 100): Address, as sent under `application.currentAddress.primaryAddress`; null when not sent. - `primaryAddress2` (string | null, required, max length 100): Unit/Apt #, as sent under `application.currentAddress.primaryAddress2`; null when not sent. - `primaryCity` (string | null, required, max length 100): City, as sent under `application.currentAddress.primaryCity`; null when not sent. - `primaryStateID` (string | null, required, max length 3): State, as sent under `application.currentAddress.primaryStateID`; null when not sent. - `primaryPostalCode` (string | null, required, max length 20): Postal Code, as sent under `application.currentAddress.primaryPostalCode`; null when not sent. - `primaryCountryID` (string | null, required, max length 2): ID of the country this record points to. - `primaryRentOwn` (string | null, required, max length 200): Rent / Own, as sent under `application.currentAddress.primaryRentOwn`; null when not sent. - `primaryMonthlyPayment` (string | number | null, required): Monthly payment at the current address, as sent (a JSON number when sent as one); null when not sent. - `primaryMoveInDate` (string | null, date, required): Move In Date, as sent under `application.currentAddress.primaryMoveInDate`; null when not sent. - `primaryManagerName` (string | null, required, max length 100): Manager Name, as sent under `application.currentAddress.primaryManagerName`; null when not sent. - `primaryManagerPhone` (string | null, required, max length 20): Manager Phone, as sent under `application.currentAddress.primaryManagerPhone`; null when not sent. - `primaryManagerEmail` (string | null, required, max length 75): Manager Email, as sent under `application.currentAddress.primaryManagerEmail`; null when not sent. - `primaryReasonForLeaving` (string | null, required): Reason for Leaving, as sent under `application.currentAddress.primaryReasonForLeaving`; null when not sent. - `signature` (string | null, required, max length 100): The applicant's signature; null for an application a manager created. - `questions` (object[] | null, required): The answers to the template's questions, as sent under `application.questions`; null when none were sent. - `variableFieldID` (string | integer, required): The question, as sent. - `answer` (string | integer | boolean): The answer, as sent. - `reason` (string): The explanation, as sent. - `terms` (object[] | null, required): The acceptances of the template's terms, as sent under `application.terms`; null when none were sent. - `variableFieldID` (string | integer, required): The term, as sent. - `initials` (string): The initials, as sent. - `addendumSignature` (string | null, required, max length 100): The applicant's signature on the addenda; null for an application a manager created. - `addendumInitials` (string | null, required, max length 100): The applicant's initials on the addenda; null for an application a manager created. - `incomeVerificationReportToken` (string | null, required, max length 200): Income verification's report token; null for an application a manager created. - `incomeVerificationReportStatusID` (one of several shapes, required): Income verification status; null for an application a manager created. - One of: - Option 1: `verification_report_statuses` - Option 2: null - `incomeVerificationReportData` (null, required): The income verification report. Always null for an application a manager created: verification runs only on applications applicants submit. - `incomeVerificationReportError` (null, required): The income verification error. Always null for an application a manager created: verification runs only on applications applicants submit. - `identityVerificationReportStatusID` (one of several shapes, required): Identity verification status; null for an application a manager created. - One of: - Option 1: `verification_report_statuses` - Option 2: null - `identityVerificationReportData` (null, required): The identity verification report. Always null for an application a manager created: verification runs only on applications applicants submit. - `identityVerificationReportToken` (string | null, required, max length 200): Identity verification's report token; null for an application a manager created. - `identityVerificationPlaidTemplate` (string | null, required, max length 200): The identity verification template used; null for an application a manager created. - `dateTimeCreated` (string, required, read-only): When the applicant was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string, required, read-only): When the applicant was last changed. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `startedApplicationID` (string | null, required, pattern `^-?[0-9]+$`): ID of the started application this record points to. - `creditReportDocumentID` (string | null, required, pattern `^-?[0-9]+$`): ID of the report document this record points to. - `criminalReportDocumentID` (string | null, required, pattern `^-?[0-9]+$`): ID of the report document this record points to. - `evictionReportDocumentID` (string | null, required, pattern `^-?[0-9]+$`): ID of the report document this record points to. - `emergencyContacts` (one of several shapes, required): The emergency contacts as sent under `application.emergencyContacts`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per emergency contact, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Contact Name. - `relationship` (string): Relationship. - `address` (string): Full Address. - `phone` (string): Phone. A phone number. - `phone2` (string): Phone. A phone number. - `email` (string): Email. An email address. - `emergencyCustom1` (string): Custom 1. - `emergencyCustom2` (string): Custom 2. - `emergencyCustom3` (string): Custom 3. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `references` (one of several shapes, required): The references as sent under `application.references`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per reference, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Reference Name. - `relationship` (string): Relationship. - `address` (string): Full Address. - `phone` (string): Phone. A phone number. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `vehicles` (one of several shapes, required): The vehicles as sent under `application.vehicles`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per vehicle, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `make` (string): Make. - `model` (string): Model. - `yearBuilt` (string): Year Built. - `color` (string): Color. - `plateNumber` (string): Plate #. - `state` (string): Plate State. - `monthlyPayment` (string | number): Monthly Payment. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `insuranceCarrier` (string): Insurance Carrier. - `vehicleCustom1` (string): Custom 1. - `vehicleCustom2` (string): Custom 2. - `vehicleCustom3` (string): Custom 3. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `occupants` (one of several shapes, required): The occupants as sent under `application.occupants`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per occupant, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Name. - `birthDate` (string): Date of Birth. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. Must be before today. - `relationship` (string): Relationship. - `occupantCustom1` (string): Custom 1. - `occupantCustom2` (string): Custom 2. - `occupantCustom3` (string): Custom 3. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `pets` (one of several shapes, required): The animals as sent under `application.pets`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per animal, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Animal Name. - `type` (string): Type / Breed. - `age` (string | integer): Age (years). A number; not checked. Comes back in the JSON type it was sent in. - `weight` (string | integer): Weight (lbs). A number; not checked. Comes back in the JSON type it was sent in. - `trained` (string): House Trained? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `color` (string): Color. - `gender` (string): Gender. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `declawed` (string): Declawed? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `shots` (string): Has Shots? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `neutered` (string): Spayed/Neutered? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `assistanceAnimal` (string): Assistance Animal? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `petLicenseNumber` (string): License Number. - `hasBiteHistory` (string): Has Bite History? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `biteHistoryDetails` (string): If Animal has bite history, please explain. - `petCustom1` (string): Custom 1. - `petCustom2` (string): Custom 2. - `petCustom3` (string): Custom 3. - `photos` (object[]): Photos. Each entry is an object with a `fileID`. Each file is attached to the applicant as an animal photo. - `fileID` (string | integer, required, pattern `^[0-9]+$`): A file uploaded with `POST /files`, or one from `GET /files`. - `name` (string): The file's name, kept with the photo. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `addressHistory` (one of several shapes, required): The address history as sent under `application.addressHistory`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per address, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `address` (string): Address. - `address2` (string): Unit/Apt #. - `city` (string): City. - `stateID` (string): State. A state or province code, such as `FL`, from `GET /states` (undocumented); not checked. - `postalCode` (string): Postal Code. - `countryID` (string): Country. A two-letter country code, such as `US`, from `GET /countries` (undocumented); not checked. - `rentOwn` (string): Rent / Own. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `monthlyPayment` (string | number): Monthly Payment. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `moveInDate` (string): Move In Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `moveOutDate` (string): Move Out Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `managerName` (string): Manager Name. - `managerPhone` (string): Manager Phone. A phone number. - `managerEmail` (string): Manager Email. An email address. - `reasonForLeaving` (string): Reason for Leaving. - `managerType` (string): Manager Type. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `employmentHistory` (one of several shapes, required): The employment history as sent under `application.employmentHistory`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per employment history, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `isCurrentEmployer` (string): Is This Your Current Employer? One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `name` (string): Employer Name. - `phone` (string): Employer Phone. A phone number. - `address` (string): Employer Address. - `supervisorName` (string): Supervisor Name. - `supervisorTitle` (string): Supervisor Title. - `supervisorPhone` (string): Supervisor Phone. A phone number. - `supervisorEmail` (string): Supervisor Email. An email address. - `position` (string): Position / Job Description. - `monthlySalary` (string | number): Monthly Salary. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `startDate` (string): Start Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `endDate` (string): End Date. A date, `YYYY-MM-DD` or `MM/DD/YYYY`. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `income` (one of several shapes, required): The other sources of income as sent under `application.income`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per income, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Income Source. - `monthlyAmount` (string | number): Monthly Amount. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `phone` (string): Phone #. A phone number. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `bankAccounts` (one of several shapes, required): The bank accounts as sent under `application.bankAccounts`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per bank account, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Name. - `accountType` (string): Account Type. One of the values listed, matched exactly. A template can mark it required; then leaving it out answers 400 `:field not valid for the defined list`. - `accountNumber` (string): Account #. - `balance` (string | number): Balance. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. - `creditCards` (one of several shapes, required): The credit cards as sent under `application.creditCards`, values and dates exactly as sent, each item given an `_id`; null when the request had none or the template has the section off. - One of: - Option 1: null - Option 2: object - `items` (object[], required): One object per credit card, as sent. - `_id` (integer, required): The item's number within the section, from 1, assigned to an item sent without one. Don't send it. - `name` (string): Issuer. - `balance` (string | number): Balance. An amount, such as `1500` or `1500.00`. Comes back in the JSON type it was sent in. - `maxID` (integer): The highest `_id` in `items`; sent when the API assigned one. ### custom_field_category_object_types * `1` - Owner * `2` - Tenant * `3` - Vendor * `4` - Lease * `5` - Property * `6` - Unit * `8` - Work Order * `9` - Portfolio * `10` - Listing * `11` - Appliance * `12` - Association * `13` - Maintenance Technician ### custom_field_category A custom field category, which groups an account's custom fields for one record type. - `customFieldCategoryID` (string, required, read-only, pattern `^-?[0-9]+$`): The primary key of the category. - `customFieldCategoryObjectTypeID` (`custom_field_category_object_types`, required): The record type the category's fields belong to. * `1` - Owner * `2` - Tenant * `3` - Vendor * `4` - Lease * `5` - Property * `6` - Unit * `8` - Work Order * `9` - Portfolio * `10` - Listing * `11` - Appliance * `12` - Association * `13` - Maintenance Technician - `name` (string, required, max length 200): The category's name. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): The category's position among the record type's categories, from `0`. ### custom_field_types * `1` - Single Line Text * `2` - Paragraph * `3` - Dropdown * `4` - Toggle * `5` - Date * `6` - Numeric * `7` - Currency * `8` - Whole Number ### custom_field A custom field, one field an account added to a record type (owners, properties, leases and the others `customFieldCategoryObjectTypeID` lists), grouped under a custom field category. - `customFieldID` (string, required, read-only, pattern `^-?[0-9]+$`): The primary key of the custom field. - `customFieldCategoryID` (string, required, pattern `^-?[0-9]+$`): The category the field is grouped under. - `name` (string, required, max length 200): The field's name, shown as its label. - `fieldTypeID` (`custom_field_types`, required): The kind of value the field holds. * `1` - Single Line Text * `2` - Paragraph * `3` - Dropdown * `4` - Toggle * `5` - Date * `6` - Numeric * `7` - Currency * `8` - Whole Number - `customFieldCategoryObjectTypeID` (`custom_field_category_object_types`, required): The record type the field belongs to, from its category. * `1` - Owner * `2` - Tenant * `3` - Vendor * `4` - Lease * `5` - Property * `6` - Unit * `8` - Work Order * `9` - Portfolio * `10` - Listing * `11` - Appliance * `12` - Association * `13` - Maintenance Technician - `settings` (string | null, required): The field's settings (its description, and a dropdown's options) as a JSON-encoded string, such as `{"description":"Gate code"}`; null when it has none. - `orderIndex` (string, required, pattern `^-?[0-9]+$`): The field's position within its category, from `0`. - `valueColumn` (string | null, required, max length 20): The internal column the field's values are stored in (`text_1`). ### package_service A service's membership in a package — a row in `resident_package_services` linking a package to one of its services. Returned (with the joined service) by the `packageServices` include on the package detail endpoint. - `residentPackageServiceID` (string, required, read-only, pattern `^-?[0-9]+$`): Unique identifier for the membership row. - `residentPackageID` (string, required, pattern `^-?[0-9]+$`): ID of the package. - `residentServiceID` (string, required, pattern `^-?[0-9]+$`): ID of the service that belongs to the package. - `dateTimeCreated` (string, read-only): Timestamp when the membership was created. UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string | null, read-only): Timestamp when the membership was last modified. UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### primary_lease_statuses_request * `1` - Pending * `2` - Active * `3` - Closed ### contact_simplified - `name` (string) - `email` (string) - `phone` (string) - `isActive` (boolean) - `contactID` (integer) ### lease_export - `leaseID` (string, pattern `^-?[0-9]+$`) - `code` (string | null) - `propertyID` (string, pattern `^-?[0-9]+$`) - `unitID` (string, pattern `^-?[0-9]+$`) - `primaryLeaseStatusID` (`primary_lease_statuses`) - `leaseStatusID` (string, pattern `^-?[0-9]+$`) - `moveInDate` (string, date) - `moveOutDate` (string | null, date) - `startDate` (string, date) - `endDate` (string | null, date) - `closedDate` (string | null, date) - `expectedMoveOutDate` (string | null, date) - `increaseEligibilityDate` (string | null, date) - `tenants` (`contact_simplified`[] | null) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. ### balances - `unpaidTotalAmount` (number, double) - `unpaidRentAmount` (number, double) - `pastDueTotalAmount` (number, double) - `pastDueRentAmount` (number, double) ### unpaid_charges - `amount` (number, double) - `isRent` (boolean) - `amountPaid` (number, double) - `datePosted` (string, date) - `accountName` (string) - `description` (string) - `transactionID` (integer) - `isOverdue` (boolean) ### property_export - `propertyID` (string, pattern `^-?[0-9]+$`) - `propertyTypeID` (`property_types`) - `isMultiUnit` (string, one of "0", "1") - `isActive` (string, one of "0", "1") - `name` (string | null) - `countryID` (string): 2-digit country code for the property, ex. `US` - `address` (string) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `latitude` (string, decimal) - `longitude` (string, decimal) - `reserveAmount` (string, decimal) ### unit_export - `unitID` (string, pattern `^-?[0-9]+$`) - `isActive` (string, one of "0", "1") - `name` (string | null) - `address` (string) - `streetNumber` (string | null, pattern `^-?[0-9]+$`) - `streetName` (string | null) - `address2` (string | null) - `city` (string) - `stateID` (string) - `postalCode` (string | null) - `latitude` (string, decimal) - `longitude` (string, decimal) - `rent` (string, decimal) - `deposit` (string | null, decimal) - `size` (string | null, pattern `^-?[0-9]+$`) - `beds` (string | null, pattern `^-?[0-9]+$`) - `fullBaths` (string | null, pattern `^-?[0-9]+$`) - `halfBaths` (string | null, pattern `^-?[0-9]+$`) ### portfolio_export - `portfolioID` (string, pattern `^-?[0-9]+$`) - `name` (string) - `isActive` (string, one of "0", "1") - `reserveAmount` (string, decimal) - `additionalReserveAmount` (string, decimal) - `owners` (object[]) - `name` (string) - `email` (string) - `isActive` (boolean) - `contactID` (integer) ### primary_application_statuses * `1` - Pending * `2` - Submitted * `3` - Screening * `4` - Processing * `5` - On Hold * `6` - Approved * `7` - Declined * `8` - Withdrawn ### applicant_simplified - `applicantID` (integer) - `name` (string) - `email` (string) - `phone` (string) ### application_export - `applicationID` (string, pattern `^-?[0-9]+$`) - `number` (string, pattern `^-?[0-9]+$`) - `primaryApplicationStatusID` (`primary_application_statuses`) - `applicationStatusID` (string, pattern `^-?[0-9]+$`) - `unitID` (string | null, pattern `^-?[0-9]+$`) - `address` (string | null) - `address2` (string | null) - `city` (string | null) - `stateID` (string | null) - `postalCode` (string | null) - `applicants` (`applicant_simplified`[]) - `dateTimeCreated` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`. - `dateTimeModified` (string): Date and time in UTC, formatted `YYYY-MM-DD HH:MM:SS`.