Download OpenAPI specification:
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.
Requests are made using HTTP Basic Authentication with the access key as the username and secret as the password.
# Use the -u flag with {access key}:{secret}
curl https://example.rentvine.com/api/manager/properties \
-u eba2c5e402e1476cb8ce5083a671d528:bd804fe81fd043598600939b9a257b2e
Settings > Users, Roles and API > APINew API KeyName field and select a predefined role in the Role dropdownℹ️ Roles need to be setup before creating an API key. Create Roles via the
Rolestab.
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.
Responses carry two headers, as the IETF rate-limit headers draft defines them: each an RFC 8941 list with one item per limit, named as in the table.
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.
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.
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.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.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.
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
lists each limit and how to back off.Reference only.
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.POST /accounting/accounts; GET, POST and PUT /accounting/accounts/{accountID}; and
GET /accounting/bank-accounts.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.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.GET and POST /leases/{leaseID}/pets, and GET, POST and
DELETE /leases/{leaseID}/pets/{leasePetID}.GET /files, GET /files/search, and GET, POST and DELETE /files/{fileID}.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.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.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.leaseBalances and portfolioBalances includes are objects, not arrays.GET /properties pages 15 items by default, not 25.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.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./search operations carries search.rank when search is sent.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.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.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.Reference only.
Response types match what the API sends. Response fields are now documented with the JSON types the API returns:
"117"."0" and "1"."1600.00".YYYY-MM-DD HH:MM:SS, and dates are YYYY-MM-DD. 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.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.transactionID and ledgerID as required; the API doesn't send them.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./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.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.
/accounting/bills/{billID}
(GET, POST and DELETE). The reference listed them under /accounting/{billID}, which doesn't exist.payoutTypeID and achAccountTypeID now list their values; the reference had pointed them at a file that
doesn't exist.type: [..., 'null'] instead of the OpenAPI 3.0 keyword nullable.datePostedMin and datePostedMax are strings in date format.search parameter is a string.*IDs[] array parameters declare integer items.primaryWorkOrderStatusID values are strings, as the API sends them.List Leases for Export
The Last Modified Timestamp on Leases is updated by multiple actions including, but not limited to, the following.
| leaseIDs[] | Array of integers Filter by Lease IDs |
| primaryLeaseStatusIDs[] | Array of strings or integers (primary_lease_statuses_request) Items Enum: "1" "2" "3" 1 2 3 Filter by Primary Lease Status |
| leaseStatusIDs[] | Array of integers Filter by Lease Status |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (lease_export) | |
object (balances) | |
object (unpaid_charges) | |
object (property_export) | |
object (unit_export) | |
object (portfolio_export) |
[- {
- "lease": {
- "leaseID": "string",
- "code": "string",
- "propertyID": "string",
- "unitID": "string",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "string",
- "moveInDate": "2019-08-24",
- "moveOutDate": "2019-08-24",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "closedDate": "2019-08-24",
- "expectedMoveOutDate": "2019-08-24",
- "increaseEligibilityDate": "2019-08-24",
- "tenants": [
- {
- "name": "string",
- "email": "string",
- "phone": "string",
- "isActive": true,
- "contactID": 0
}
], - "dateTimeCreated": "string",
- "dateTimeModified": "string"
}, - "balances": {
- "unpaidTotalAmount": 0.1,
- "unpaidRentAmount": 0.1,
- "pastDueTotalAmount": 0.1,
- "pastDueRentAmount": 0.1
}, - "unpaidCharges": {
- "amount": 0.1,
- "isRent": true,
- "amountPaid": 0.1,
- "datePosted": "2019-08-24",
- "accountName": "string",
- "description": "string",
- "transactionID": 0,
- "isOverdue": true
}, - "property": {
- "propertyID": "string",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "0",
- "name": "string",
- "countryID": "US",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "reserveAmount": "string"
}, - "unit": {
- "unitID": "string",
- "isActive": "0",
- "name": "string",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "rent": "string",
- "deposit": "string",
- "size": "string",
- "beds": "string",
- "fullBaths": "string",
- "halfBaths": "string"
}, - "portfolio": {
- "portfolioID": "string",
- "name": "string",
- "isActive": "0",
- "reserveAmount": "string",
- "additionalReserveAmount": "string",
- "owners": [
- {
- "name": "string",
- "email": "string",
- "isActive": true,
- "contactID": 0
}
]
}
}
]List Properties for Export
The Last Modified Timestamp on Properties is updated by multiple actions including, but not limited to, the following.
| isActive | boolean |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object | |
object (portfolio_export) |
[- {
- "property": {
- "propertyID": "string",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "0",
- "name": "string",
- "countryID": "US",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "reserveAmount": "string",
- "groups": [
- {
- "name": "string",
- "propertyGroupID": 0
}
], - "dateTimeCreated": "string",
- "dateTimeModified": "string"
}, - "portfolio": {
- "portfolioID": "string",
- "name": "string",
- "isActive": "0",
- "reserveAmount": "string",
- "additionalReserveAmount": "string",
- "owners": [
- {
- "name": "string",
- "email": "string",
- "isActive": true,
- "contactID": 0
}
]
}
}
]List Units for Export
The Last Modified Timestamp on Units is updated by multiple actions including, but not limited to, the following.
| isActive | boolean |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (property_export) | |
object |
[- {
- "property": {
- "propertyID": "string",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "0",
- "name": "string",
- "countryID": "US",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "reserveAmount": "string"
}, - "unit": {
- "unitID": "string",
- "isActive": "0",
- "name": "string",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "rent": "string",
- "deposit": "string",
- "size": "string",
- "beds": "string",
- "fullBaths": "string",
- "halfBaths": "string",
- "dateTimeCreated": "string",
- "dateTimeModified": "string"
}
}
]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.
| primaryApplicationStatusIDs[] | Array of strings or integers (primary_application_statuses) Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8 Filter by Primary Application Status |
| applicationStatusIDs[] | Array of integers Filter by Application Status |
| hasLease | boolean Filter by if there is a Lease Attached |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (application_export) | |
object (unit_export) | |
object |
[- {
- "application": {
- "applicationID": "string",
- "number": "string",
- "primaryApplicationStatusID": "1",
- "applicationStatusID": "string",
- "unitID": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "applicants": [
- {
- "applicantID": 0,
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "dateTimeCreated": "string",
- "dateTimeModified": "string"
}, - "unit": {
- "unitID": "string",
- "isActive": "0",
- "name": "string",
- "address": "string",
- "streetNumber": "string",
- "streetName": "string",
- "address2": "string",
- "city": "string",
- "stateID": "string",
- "postalCode": "string",
- "latitude": "string",
- "longitude": "string",
- "rent": "string",
- "deposit": "string",
- "size": "string",
- "beds": "string",
- "fullBaths": "string",
- "halfBaths": "string"
}, - "lease": {
- "leaseID": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "tenants": [
- {
- "name": "string",
- "email": "string",
- "phone": "string",
- "isActive": true,
- "contactID": 0
}
]
}
}
]Returns a paginated list of chart-of-accounts records. Each item contains a full account
object.
accountTypeID or accountTypeIDs.isActive and isEscrow.GET /accounting/accounts/search - Search with additional filters (accountID, dateTimeModified range).GET /accounting/accounts/{accountID} - Retrieve a single account with optional includes.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 5000 Example: pageSize=25 Number of results per page. Defaults to 5000. |
| search | string Example: search=Receivable Full-text search against account name and account number. |
| accountTypeID | string Example: accountTypeID=3,7 Filter by account type. Accepts a single integer or a comma-separated list.
|
| accountTypeIDs | Array of integers Example: accountTypeIDs=3&accountTypeIDs=7 Array form of the account type filter. Takes precedence over |
| isActive | boolean Example: isActive=true Filter by active status. |
| isEscrow | boolean Filter to accounts flagged as escrow accounts. |
| pagination-page-size | integer Example: "25" Number of results per page. |
| pagination-total-items | integer Example: "199" Total number of accounts matching the filters. |
| pagination-total-pages | integer Example: "8" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Example: "2" Next page number, or null on the last page. |
| pagination-before-page | integer or null Previous page number, or null on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "8" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (account) |
| token required | string Session token associated with this response. |
[- {
- "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"
}
]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.
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.<field>.
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.
bankAccountCiphertextID), and bankAccountNumberTruncated is set to the account number's last 4 digits.defaultBankAccountID in GET /accounting/settings (undocumented)).GET /logs/{objectTypeID}/{objectID} (undocumented) lists for object type 54.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.| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID required | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account type. It can't be changed later, and it decides which other fields the account keeps.
|
| number required | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name required | string [ 1 .. 100 ] characters Display name. |
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account: an account of the same type, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. Default |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. Default |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. Default |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. Default |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. Default |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. Default |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. Default |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. Default |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. Default |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. Default |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. Default |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. Default |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. Default |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Default |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. Default |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| isFromImport | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account came from an import. Default |
| importSourceKey | string or null The import's key for the account, unique among imported accounts. Kept only when |
| creditCardGatewayID | string or integer or null^-?[0-9]+$ Credit card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| achGatewayID | string or integer or null^-?[0-9]+$ ACH gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| cashCardGatewayID | string or integer or null^-?[0-9]+$ Cash card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| remoteCheckGatewayID | string or integer or null^-?[0-9]+$ Remote check printing gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
object The bank account's routing and account numbers. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
account_category (object) or null The account's category, or null when it has none. Requires the | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) 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: | |
| unprintedCheckCount | integer >= 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 |
object or null 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 |
{- "accountTypeID": 7,
- "number": "4150",
- "name": "Pet Rent Income",
- "isRent": 1,
- "isSubjectToManagementFees": 1,
- "isSubjectToLateFees": 1,
- "isTaxable": 0
}{- "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
}
}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.
accountID.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.GET /accounting/accounts - Simpler list endpoint with a 5000 default page size.GET /accounting/accounts/{accountID} - Retrieve a single account with optional includes.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=Operating Full-text search against account name and account number. |
| isActive | boolean Example: isActive=true Filter by active status. |
| isEscrow | boolean Filter to accounts flagged as escrow accounts. |
| accountTypeIDs | Array of integers Example: accountTypeIDs=3&accountTypeIDs=7 Filter by one or more account type IDs (array form).
|
| accountID | integer Example: accountID=31 Look up a single account by its ID. |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| pagination-page-size | integer Example: "25" Number of results per page. |
| pagination-total-items | integer Example: "199" Total number of accounts matching the filters. |
| pagination-total-pages | integer Example: "8" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Example: "2" Next page number, or null on the last page. |
| pagination-before-page | integer or null Previous page number, or null on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "8" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (account) |
required | object or null Account category associated with this account, or null fields when uncategorized. |
[- {
- "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
}
}
]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).
POST /accounting/accounts/{accountID}.{"error": "Account <id> not found"}; so does 0.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.GET /accounting/accounts - List accounts.GET /accounting/bank-accounts - List the bank accounts.POST /accounting/accounts/{accountID} - Change the account.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
account_category (object) or null The account's category, or null when it has none. Requires the | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) 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: | |
| unprintedCheckCount | integer >= 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 |
object or null 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 |
{- "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
}
}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.
Administration › ManageChartOfAccounts). Changing a
bank account also requires Manage Bank Accounts (Administration › ManageBankAccounts). Either missing
answers 403 {"error": "Permission Denied"}.{"error": "Account <id> not found"}, after the empty-body check.accountTypeID is refused
(Cannot change the account type).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.POST /accounting/accounts: fields its type
doesn't keep go back to 0 or null whatever the request sends.includes to get the account's includes in the response. Without it the response has only account.GET /logs/{objectTypeID}/{objectID} (undocumented), object type 54) when anything changed.checkSignatory deletes that gateway and emails
Rentvine support that remote check printing was turned off for the bank account.GET /accounting/accounts/{accountID} - Read the account.PUT /accounting/accounts/{accountID} - The same operation as a PUT.POST /accounting/accounts - Create an account.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account's current type. Another type is refused (
|
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| number | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name | string [ 1 .. 100 ] characters Display name. |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Set to |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
account_category (object) or null The account's category, or null when it has none. Requires the | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) 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: | |
| unprintedCheckCount | integer >= 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 |
object or null 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 |
{- "name": "Application Fees",
- "isSubjectToManagementFees": 1,
- "isTaxable": 1
}{- "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
}
}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.
POST /accounting/accounts/{accountID} - The full description of the update.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account's current type. Another type is refused (
|
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| number | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name | string [ 1 .. 100 ] characters Display name. |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Set to |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
account_category (object) or null The account's category, or null when it has none. Requires the | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) 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: | |
| unprintedCheckCount | integer >= 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 |
object or null 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 |
{- "name": "Application Fees",
- "isSubjectToManagementFees": 1,
- "isTaxable": 1
}{- "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
}
}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.
number (as text), then name, then accountID.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.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.| search | string Example: search=Operating Keeps the bank accounts whose |
| isActive | string Example: isActive=true
|
| isEscrow | string Example: isEscrow=false
|
| bankAccountIDs[] | Array of integers Example: bankAccountIDs[]=31&bankAccountIDs[]=32 Keeps only these accounts. Send each ID as a separate |
| pagination-page-size | integer Example: "1" The number of bank accounts returned; 15 when none match. |
| pagination-total-items | integer Example: "1" The number of bank accounts returned. |
| pagination-total-pages | integer Example: "1" 1, or 0 when none match. |
| pagination-current-page | integer Example: "1" Always 1. |
| pagination-next-page | integer Example: "1" 1, or 0 when none match. |
| pagination-before-page | integer Example: "1" Always 1. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "1" 1, or 0 when none match. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object A bank account's summary fields. |
[- {
- "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"
}
}
]Returns a paginated list of bills. Each item in the response includes the bill record and its associated payee contact.
contact object is always returned alongside each bill — it is not opt-in.page and pageSize query parameters to navigate pages.GET /accounting/bills/{billID} - Retrieve a single bill with full includes support.POST /accounting/bills - Create a bill.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "142" Total number of bills matching the query. |
| pagination-total-pages | integer Example: "6" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null Example: "2" The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "6" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
required | object The payee contact associated with this bill. |
[- {
- "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"
}
}
]Creates a new bill in the system.
leaseCharges.payeeContactID, billDate, and dateDue are required.workOrderID on
this request. Optionally set workOrderStatusID to update the work order's status at the
same time the bill is created.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.charges must include ledgerID, chargeAccountID, and amount.leaseCharges must include leaseID, chargeAccountID, and amount.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.| payeeContactID required | string or integer^-?[0-9]+$ |
| billDate required | string <date> |
| dateDue required | string <date> |
| billBatchID | string or integer or null^-?[0-9]+$ |
| parentBillID | string or integer or null^-?[0-9]+$ |
| reference | string or null |
| paymentMemo | string or null |
| description | string or null |
| workOrderID | string or integer or null^-?[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 |
| bankAccountID | string or integer or null^-?[0-9]+$ The bank account to use for this bill. Only applicable when |
| serviceAccountNumber | string or null |
| utilityPeriodStartDate | string or null <date> |
| utilityPeriodEndDate | string or null <date> |
| discountPercent | string or number or null <decimal> |
| markupPercent | string or number or null <decimal> |
Array of objects Line-item charges applied to ledger accounts. | |
Array of objects Charges posted directly to lease ledgers (tenant-responsible amounts). | |
| tenantAmount | number or null The portion of the bill to be collected from the tenant. |
| workOrderStatusID | string or integer or null^-?[0-9]+$ The status to set on the linked work order when the bill is created. |
| markupOverridePercentage | string or null Overrides the default markup percentage for this bill (decimal string). |
| overrideBankAccount | boolean When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
{- "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
}{- "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
}
}Retrieves a single bill by ID, with optional related data via includes.
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. |
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.| billID required | integer Example: 15054 |
| includes | string Example: includes=contact,charges,bankAccount,leaseCharges,payouts,workOrder,discountBill,markupBill,markupDiscount Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
object or null Payee contact details (if includes=contact). | |
Array of objects Ledger charge lines (if includes=charges). | |
object or null Bank account used for payment (if includes=bankAccount). | |
Array of objects Tenant-responsible charge transactions (if includes=leaseCharges). | |
| payouts | Array of objects Payouts applied to this bill (if includes=payouts). |
object or null Linked work order (if includes=workOrder). | |
bill (object) or null The parent bill when this is a child discount/markup bill (if includes=parentBill). | |
bill (object) or null Associated discount bill (if includes=discountBill). | |
bill (object) or null Associated markup bill (if includes=markupBill). | |
object or null Computed markup and discount totals (if includes=markupDiscount). | |
| utility | object or null Linked utility (if includes=utility). |
| property | object or null Linked property (if includes=property). |
object Access restrictions for the current user. | |
| approvalRequirementType | string or null The type of approval requirement for this bill, if any. |
{- "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": "<p>sfgsf</p>",
- "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
}Updates an existing bill. All fields are optional — only the fields provided in the
request body are changed. Charges are matched by transactionID.
charges must include transactionID to identify the charge being updated.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. |
GET /accounting/bills/{billID} - Retrieve the updated bill.POST /accounting/bills - Create a new bill.DELETE /accounting/bills/{billID} - Void a bill.| billID required | integer Example: 15026 |
| includes | string Example: includes=charges,contact,payouts,workOrder Comma-separated list of related data to include in the response.
Available values: |
| payeeContactID | string or integer^-?[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 or number <decimal> Total bill amount. |
| discountPercent | string or number <decimal> Discount percentage applied to the bill. |
| markupPercent | string or number <decimal> Markup percentage applied to the bill. |
| bankAccountID | string or integer^-?[0-9]+$ The bank account used to pay this bill. |
| reference | string or null External reference number (e.g. invoice number, check number). |
| paymentMemo | string or null Memo to include with the payment. |
| description | string or null Internal description for the bill. |
| workOrderID | string or integer or null^-?[0-9]+$ The ID of the work order to link to this bill. |
Array of objects Charge lines to update on this bill. Each entry must include | |
| serviceAccountNumber | string or null Utility service account number, if applicable. |
| utilityPeriodStartDate | string or null <date> Start date of the utility billing period. |
| utilityPeriodEndDate | string or null <date> End date of the utility billing period. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
object or null Payee contact details (if includes=contact). | |
Array of objects Updated charge line items with full transaction details (if includes=charges). | |
| payouts | Array of objects Payouts applied to this bill (if includes=payouts). |
object or null Linked work order (if includes=workOrder). |
{- "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"
}{- "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": "<p> c</p>",
- "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"
}
}Voids a bill, reversing its accounting impact. The bill remains in the system with
isVoided: "1" and cannot be deleted.
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.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. |
GET /accounting/bills/{billID} - Retrieve a bill and its current state.POST /accounting/bills - Create a new bill.| billID required | integer Example: 15051 |
| includes | string Example: includes=contact,charges,workOrder,discountBill,markupBill,leaseCharges Comma-separated list of related data to include in the response.
Available values: |
| voidLinkedBills | boolean When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
object or null Payee contact details (if includes=contact). | |
| charges | Array of objects Ledger charge lines (if includes=charges). |
object or null Bank account used for payment (if includes=bankAccount). | |
Array of objects Tenant-responsible charge transactions (if includes=leaseCharges). | |
| payouts | Array of objects Payouts applied to this bill (if includes=payouts). |
object or null Linked work order (if includes=workOrder). | |
object (bill) | |
bill (object) or null The companion discount bill linked to this bill, if any.
Voided alongside the parent when | |
bill (object) or null The companion markup bill linked to this bill, if any.
Voided alongside the parent when | |
object or null Computed markup and discount totals (if includes=markupDiscount). | |
| utility | object or null Linked utility (if includes=utility). |
| property | object or null Linked property (if includes=property). |
{- "voidLinkedBills": true
}{- "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": "<p>test</p>",
- "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
}Approves a bill, marking it as authorized for payment. Once approved, the bill's
isApproved flag is set to 1 and approvedByUserID is recorded.
Accounting component).400 is returned if the billID is not found.GET /accounting/bills/{billID} — the same includes
query parameter is supported.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.| billID required | integer Example: 14973 |
| includes | string Example: includes=contact,charges,workOrder Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (bill) |
{- "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
}
}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.
{billID} does not match any bill, a 400 error is returned.portfolioID query parameter is optional. When omitted, the PDF is rendered without
portfolio-specific branding.application/pdf. Clients should treat the body as a binary
stream, not JSON.GET /accounting/bills/{billID} - Retrieve bill data as JSON.GET /accounting/bills - List all bills.| billID required | integer Example: 15054 Unique identifier of the bill to print. |
| portfolioID | integer Example: portfolioID=42 Portfolio ID used to apply branded letterhead/styling to the rendered PDF. |
| Cache-Control | string Example: "no-cache" Cache directive set to |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
Raw PDF binary data of the bill.
{- "error": "Bill 15054 not found"
}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.
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).payeeContactID / payeeContactIDs, portfolioID / portfolioIDs,
propertyID / propertyIDs, unitID / unitIDs). Pass multiple values as a
comma-separated string: propertyIDs=101,102,103.transaction.datePosted descending. Append |asc or |desc to any
orderBy value to control direction (e.g. orderBy=transaction.amount|asc).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.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=HVAC repair Full-text search applied across multiple fields. Matches any transaction or bill where the search string appears in:
Also matches rows where |
| isVoided | boolean Filter by voided status of the transaction.
Omit to return both. |
| isApproved | boolean Filter by the bill's approval status.
Omit to return both. |
| isPaid | boolean Filter by payment status of the transaction.
Omit to return both paid and unpaid. |
| amountMin | number <double> Example: amountMin=100 Return only transactions where |
| amountMax | number <double> Example: amountMax=5000 Return only transactions where |
| datePostedMin | string <date> Example: datePostedMin=2026-01-01 Return only transactions posted on or after this date ( |
| datePostedMax | string <date> Example: datePostedMax=2026-04-30 Return only transactions posted on or before this date ( |
| billDateMin | string <date> Example: billDateMin=2026-01-01 Return only transactions whose bill date ( |
| billDateMax | string <date> Example: billDateMax=2026-04-30 Return only transactions whose bill date ( |
| dateDueMin | string <date> Example: dateDueMin=2026-04-01 Return only transactions whose bill due date ( |
| dateDueMax | string <date> Example: dateDueMax=2026-04-30 Return only transactions whose bill due date ( |
| ledgerTypeID | string or integer (ledger_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Example: ledgerTypeID=3 Return only transactions posted to ledgers of this type. |
| payeeContactIDs | string Example: payeeContactIDs=200,201 Comma-separated list of payee contact IDs to filter by. Also accepted as singular
Example: |
| portfolioIDs | string Example: portfolioIDs=50,51 Comma-separated list of portfolio IDs to filter by. Also accepted as singular
Example: |
| propertyIDs | string Example: propertyIDs=101,102 Comma-separated list of property IDs to filter by. Also accepted as singular
Example: |
| unitIDs | string Example: unitIDs=310,311 Comma-separated list of unit IDs to filter by. Also accepted as singular Example: |
| requiresMasterApproval | boolean Example: requiresMasterApproval=true When |
| orderBy | string Example: orderBy=transaction.amount|asc Sort the results by a specific column. Append Sortable columns:
|
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "87" Total number of transactions matching the query. |
| pagination-total-pages | integer Example: "4" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null Example: "2" The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "4" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The parent bill record for this transaction line. |
required | object The individual transaction (bill charge line) for this row. |
required | object The ledger (property, portfolio, or manager account) charged. |
required | object The payee contact (vendor or other payee) for the bill. |
object or null The portfolio associated with the transaction. May be null if the ledger is not portfolio-linked. | |
object or null The property associated with the transaction. May be null for manager-level charges. | |
object or null The unit associated with the transaction. Null when the charge is at the property or portfolio level. |
[- {
- "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"
}
}
]Returns a paginated list of bank deposits. Each item in the response includes the deposit record and its associated bank account.
account object is always included in each list item.GET /accounting/deposits/search for richer filtering with min/max amounts and date ranges.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.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=DEP-2024 Full-text search against deposit number and description. |
| bankAccountID | integer Example: bankAccountID=12 Filter by a specific bank account ID. |
| reconciliationID | integer Example: reconciliationID=88 Filter deposits associated with a specific reconciliation ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
| token required | string Session token associated with this response. |
{- "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"
}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}).
Accounting > ModifyDeposit permission.transactionID in transactions must exist and pass portfolio restrictions.bulkPaymentID in bulkPayments must exist.attachments array contains fileID values for pre-uploaded files.GET /accounting/deposits/{depositID} and
returns the full deposit detail.GET /accounting/deposits/transactions/undeposited - Retrieve undeposited transactions to include.GET /accounting/deposits/{depositID} - View the created deposit.| bankAccountID required | string or integer^-?[0-9]+$ The bank account to deposit into. |
| dateDeposited required | string <date> The date of the deposit. |
| amount required | string or number <decimal> Total deposit amount as a decimal string. |
| depositNumber | string or null Optional reference number. |
| description | string or null Optional description. |
Array of objects List of transactions to include in this deposit. | |
Array of objects List of bulk payments to include in this deposit. | |
| attachments | Array of integers File IDs of documents to attach to this deposit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
| transactions | Array of objects Deposited transactions (if includes=transactions). |
{- "bankAccountID": 146,
- "depositNumber": "27",
- "description": null,
- "dateDeposited": "2026-04-24",
- "attachments": [ ],
- "transactions": [
- {
- "transactionID": 80911
}, - {
- "transactionID": 78052
}
], - "bulkPayments": [ ],
- "amount": "1400.00"
}{- "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"
}
}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).
isReconciled=false to find deposits pending reconciliation.bankAccountIDs to scope results to specific bank accounts.search.bankAccountIDs (comma-separated) and bankAccountID (single integer) are
accepted; bankAccountIDs takes precedence.reconciliationIDs takes precedence over reconciliationID.dateDeposited DESC, then depositID DESC.GET /accounting/deposits - Simple list with basic filters.GET /accounting/deposits/{depositID} - Retrieve a single deposit with includes support.| search | string Filter by term in description, name, amount, or address |
| bankAccountIDs | string Example: bankAccountIDs=12,15 Comma-separated list of bank account IDs to filter by. |
| bankAccountID | integer Example: bankAccountID=31 Single bank account ID to filter by (use |
| isVoided | boolean Filter by voided state. |
| showVoided | boolean When |
| isReconciled | boolean Filter by reconciliation state. |
| amountMin | string Example: amountMin=1000.00 Minimum deposit amount (inclusive). |
| amountMax | string Example: amountMax=10000.00 Maximum deposit amount (inclusive). |
| dateDepositedMin | string <date> Example: dateDepositedMin=2024-01-01 Earliest deposit date (inclusive), ISO 8601 date. |
| dateDepositedMax | string <date> Example: dateDepositedMax=2024-12-31 Latest deposit date (inclusive), ISO 8601 date. |
| reconciliationIDs | string Example: reconciliationIDs=88,89 Comma-separated list of reconciliation IDs to filter by. |
| reconciliationID | integer Example: reconciliationID=88 Single reconciliation ID to filter by (use |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "18" Total number of deposits matching the query. |
| pagination-total-pages | integer Example: "1" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "1" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
required | object The bank account associated with this deposit. |
required | object The reconciliation this deposit is linked to. All fields are |
[- {
- "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"
}
}
]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:
depositTransactionTypeID: 1, objectTypeID: 9) — lease
payments, owner payments, and other payments that have not been deposited and are
not routed through a bank gateway.depositTransactionTypeID: 2, objectTypeID: 84) — undeposited
bulk payment batches. For bulk payments the ledger, property, and unit objects
will be null.transactionTypeID to show only specific payment types (e.g. lease payments only).createdByUserID to show transactions entered by a specific user.bankAccountID is required and must refer to an account of type Bank.depositID IS NOT NULL) are excluded.bankAccountGatewayID IS NOT NULL) are excluded.datePosted DESC.POST /accounting/deposits - Create a deposit using transactions from this list.POST /accounting/deposits/{depositID}/transactions - Add transactions to an existing deposit.| bankAccountID required | integer Example: bankAccountID=31 The bank account to retrieve undeposited transactions for. Must be a Bank-type account. |
| createdByUserID | integer Example: createdByUserID=901735 Filter by the ID of the user who created the transactions. |
| transactionTypeID | integer Example: transactionTypeID=2 Filter by a specific transaction type ID (e.g. 2 = LeasePayment). Only applies to regular transactions, not bulk payments. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object or null Ledger associated with the transaction. Null for bulk payments. |
required | object Payer information. For OtherPayment transactions the name comes from |
required | object or null Property associated with the transaction. Null for bulk payments. |
required | object or null Unit associated with the transaction. Null for bulk payments. |
required | object User who created the transaction or bulk payment. |
[- {
- "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"
}
}
]Retrieves a single deposit by ID. The base response always includes the deposit
record. Additional data can be requested via the includes query parameter.
restrictions include adds access-control metadata (read/write/void permissions)
derived from the user's license for this deposit.Use ?includes=transactions,reconciliation to request additional data.
null
if unreconciled).null).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.| depositID required | integer Example: 4210 The ID of the deposit to retrieve. |
| includes | string Example: includes=transactions,reconciliation Comma-separated list of additional data to include. Available values:
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
Array of objects Transactions in this deposit (if includes=transactions). Each item contains the transaction record plus denormalized ledger, payer, property, and unit context. | |
reconciliation (object) or null The reconciliation record this deposit is linked to (if includes=reconciliation), or null if unreconciled. | |
reconciliation (object) or null The previous reconciliation record if the deposit was moved during re-reconciliation (if includes=previousReconciliation), or null. | |
object Access-control metadata for this deposit (if includes=restrictions). |
{- "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"
}
}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}).
Accounting › ModifyDeposit), checked first: a key without it
gets the 403 even for a deposit that doesn't exist.Access Denied for a deposit outside them.{"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.depositID answers the stock 404.GET /accounting/deposits/{depositID} and honours its includes (transactions,
reconciliation, previousReconciliation, restrictions), whose objects aren't documented on this
operation yet.Deposit Updated entry to the deposit's history log when a field changes. No transaction or ledger
entry is written.PUT /accounting/deposits/{depositID} - the same update with PUTPOST /accounting/deposits/{depositID}/transactions - Add/remove transactions.DELETE /accounting/deposits/{depositID} - Void the deposit.| depositID required | integer Example: 4210 The ID of the deposit to update, from |
| depositNumber | string [ 1 .. 100 ] characters Updated reference number, up to 100 characters. The deposit must always have one: |
| description | string or null <= 1000 characters Updated description, up to 1000 characters. |
| dateDeposited | string <date> Updated deposit date. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
{- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "dateDeposited": "2024-10-23"
}{- "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"
}
}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.
POST /accounting/deposits/{depositID} - the same update with POST| depositID required | integer Example: 4210 The ID of the deposit to update, from |
| depositNumber | string [ 1 .. 100 ] characters Updated reference number, up to 100 characters. The deposit must always have one: |
| description | string or null <= 1000 characters Updated description, up to 1000 characters. |
| dateDeposited | string <date> Updated deposit date. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
{- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "dateDeposited": "2024-10-23"
}{- "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"
}
}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.
Accounting > VoidDeposit permission.POST /accounting/deposits/{depositID}/reconcile - Reconcile a deposit instead of voiding.GET /accounting/deposits/{depositID} - Check deposit state before voiding.| depositID required | integer Example: 4210 The ID of the deposit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| depositID required | string^-?[0-9]+$ Unique identifier for the deposit. |
| bankAccountID required | string^-?[0-9]+$ The bank account this deposit belongs to. |
| amount required | string <decimal> Total deposited amount as a decimal string. |
| isVoided required | string Enum: "0" "1"
|
| dateDeposited required | string <date> The date the deposit was made. |
| dateTimeCreated required | string Timestamp when the deposit record was created (MySQL datetime format, e.g. "2021-04-14 13:40:48"). UTC, formatted |
| reconciliationID | string or null^-?[0-9]+$ The reconciliation this deposit is linked to, or null if unreconciled. |
| previousReconciliationID | string or null^-?[0-9]+$ The previous reconciliation ID if the deposit was moved, or null. |
| depositNumber | string or null A user-assigned reference number for the deposit. |
| description | string or null Optional free-text description. |
{- "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"
}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.
Accounting > ModifyDeposit permission.transactionID in transactions must exist and pass portfolio access checks.bulkPaymentID in bulkPayments must exist.{ "success": true } on success, not the updated deposit. Fetch the deposit
separately via GET /accounting/deposits/{depositID}?includes=transactions to see
the updated state.GET /accounting/deposits/transactions/undeposited - Get available undeposited transactions.GET /accounting/deposits/{depositID} - View the deposit with transactions included.| depositID required | integer Example: 4210 The ID of the deposit to add transactions to. |
| transactions | Array of integers List of transaction IDs to add to the deposit. |
| bulkPayments | Array of integers List of bulk payment IDs to add to the deposit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| success required | boolean |
{- "transactions": [
- 9903,
- 9904
]
}{- "success": true
}Renders a printable PDF for the given deposit and streams it as the response body.
The response Content-Type is application/pdf.
GET /accounting/deposits/{depositID} - Retrieve deposit data in JSON format.| depositID required | integer Example: 4210 The ID of the deposit to print. |
| Cache-Control | string Example: "no-cache" |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
{- "error": "Deposit 9999 not found"
}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.
reconciliationID.Accounting > ModifyDeposit and Accounting > ModifyReconciliations
permissions.reconciliationID is provided and the reconciliation exists, the deposit is
linked to it. If no ID is provided, a new reconciliation record is created.isSingleTransaction flag is set internally — this action reconciles this
deposit only, not all items in a reconciliation batch.GET /accounting/deposits/{depositID}.POST /accounting/deposits/{depositID}/unreconcile - Reverse this reconciliation.GET /accounting/deposits/{depositID}?includes=reconciliation - Check reconciliation state.| depositID required | integer Example: 4210 The ID of the deposit to reconcile. |
| reconciliationID | string or integer or null^-?[0-9]+$ The ID of an existing reconciliation to link this deposit to. If omitted or null, a new reconciliation record is created. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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": 88
}{- "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"
}
}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.
Accounting > ModifyDeposit and Accounting > ModifyReconciliations
permissions.previousReconciliationID field on the deposit will record the reconciliation
that was removed.GET /accounting/deposits/{depositID}.POST /accounting/deposits/{depositID}/reconcile - Reconcile the deposit again.GET /accounting/deposits/{depositID}?includes=reconciliation - Check current reconciliation state.| depositID required | integer Example: 4210 The ID of the deposit to unreconcile. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
{- "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"
}
}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.
invoiceStatusID=2).invoiceStatusID
and invoiceStatusIDs); the plural form takes precedence.GET /accounting/invoices/{invoiceID} - Retrieve a single invoice with full detail.POST /accounting/invoices/upload - Upload a new invoice PDF.| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=Acme Plumbing Full-text search against invoice reference and payee name. |
| invoiceStatusIDs | string Example: invoiceStatusIDs=1,2 Comma-separated list of invoice status IDs to filter by. |
| invoiceStatusID | integer Example: invoiceStatusID=2 Single invoice status ID filter. |
| payeeContactIDs | string Example: payeeContactIDs=210,211 Comma-separated list of payee contact IDs to filter by. |
| payeeContactID | integer Example: payeeContactID=210 Single payee contact ID filter. |
| assignedToUserIDs | string Example: assignedToUserIDs=55,56 Comma-separated list of user IDs the invoice is assigned to. |
| assignedToUserID | integer Example: assignedToUserID=55 Single assigned user ID filter. |
| workOrderIDs | string Example: workOrderIDs=1001,1002 Comma-separated list of work order IDs to filter by. |
| workOrderID | integer Example: workOrderID=1001 Single work order ID filter. |
| dateCreatedMin | string <date> Example: dateCreatedMin=2024-10-01 Earliest creation date (inclusive), ISO 8601 date. |
| dateCreatedMax | string <date> Example: dateCreatedMax=2024-10-31 Latest creation date (inclusive), ISO 8601 date. |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "74" Total number of invoices matching the query. |
| pagination-total-pages | integer Example: "3" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null Example: "2" The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "3" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object Core invoice record fields. |
required | object or null File record for the uploaded invoice PDF, or null if no file. |
required | object Confirmed payee contact, or null values if not yet assigned. |
required | object Property assignment context derived from the predicted ledger. |
required | object Associated work order summary, or null values if not linked. |
required | object Bill this invoice was converted to, or null values if not yet converted. |
required | object User who submitted the invoice. |
required | object Address and ledger context for manually-created invoices (invoiceTypeID=2). |
[- {
- "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": ""
}
}
]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.
multipart/form-data with the file as the first upload.invoiceStatusID=1 (Processing) and
invoiceSourceID=2 (Upload).GET /accounting/invoices/{invoiceID} and returns the
full invoice detail.predicted* fields will
be populated after a short delay.GET /accounting/invoices/{invoiceID} - Poll for updated prediction results.POST /accounting/invoices/{invoiceID}/decline - Decline an invoice after review.| file required | string <binary> The invoice PDF or image file to upload. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
| lineItems required | Array of objects Line items (empty until AI extraction completes). |
{- "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": [ ]
}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.
lineItems are always returned — for invoiceTypeID=2 (Created) these come from
InvoiceLineItems; for uploaded invoices they come from the AI prediction data.workOrder, unit, property, lease, and ledger includes are nested:
unit, property, lease, and ledger require workOrder to also be included.Use ?includes=contact,workOrder,property to request additional data.
workOrder).workOrder).workOrder).workOrder).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.| invoiceID required | integer Example: 8850 The ID of the invoice to retrieve. |
| includes | string Example: includes=contact,workOrder,property Comma-separated list of additional data to include. Available values:
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
required | Array of Created invoice line item (object) or Predicted line item (object) Line items, in one of two shapes depending on the invoice type. A Created invoice
( |
object or null The payee contact (if includes=contact). | |
| predictedInvoice | object or null Raw AI extraction result (if includes=predictedInvoice). |
object or null The uploaded invoice PDF file record (if includes=invoiceFile). | |
| files | Array of objects or null Attachments shared with the vendor (if includes=files). |
object or null The associated work order (if includes=workOrder). | |
| unit | object or null The unit from the work order (if includes=unit and workOrder). |
| property | object or null The property from the work order (if includes=property and workOrder). |
| lease | object or null The lease from the work order (if includes=lease and workOrder). |
| ledger | object or null The ledger for the unit or property (if includes=ledger and workOrder). |
{- "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": [ ]
}Renders a printable PDF for the given invoice and streams it as the response body.
The response Content-Type is application/pdf.
GET /accounting/invoices/{invoiceID} - Retrieve invoice data in JSON format.| invoiceID required | integer Example: 8850 The ID of the invoice to print. |
| Cache-Control | string Example: "no-cache" |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
{- "error": "Invoice not found"
}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.
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.GET /accounting/invoices/{invoiceID} and returns the
full invoice detail.GET /accounting/invoices/{invoiceID} - View the declined invoice.POST /accounting/invoices/upload - Upload a replacement invoice.| invoiceID required | integer Example: 8850 The ID of the invoice to decline. |
| declinedMessage | string or null Message explaining why the invoice was declined. Sent to the vendor if |
| sendNotification | boolean Default: true Whether to send a decline notification email to the vendor. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
| lineItems required | Array of objects |
{- "declinedMessage": "Invoice amount does not match the approved work order estimate.",
- "sendNotification": true
}{- "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": [ ]
}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".
search to find ledgers by name.ledgerIDs to fetch a known set of ledgers by ID.ledgerTypeID with search to narrow results to
a specific ledger type (e.g. only property operating accounts).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).1) are left
out. This is an account setting, not a permission: every key on the account gets the same rows.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 theledgerIDs=100 (no brackets) is read as a one-item list; a comma list (100,101) isn't split.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 [].GET /accounting/ledgers/search — Paginated ledger search with extended filters.GET /accounting/ledgers/{ledgerID} (undocumented) — Retrieve a single ledger with optional includes.| search | string Example: search=Operating Search string matched against the ledger name. |
| ledgerTypeID | integer Enum: 1 2 3 4 Example: ledgerTypeID=2 Filter results to a single ledger type.
|
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=100&ledgerIDs[]=101 Filter by one or more ledger IDs. Pass each value as a separate
query parameter: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (ledger) |
[- {
- "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"
}
}
]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).
ledgerID to confirm its current state.search + ledgerTypeIDs to power a filtered autocomplete when exact IDs are not known.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.unit object is always present in each item but its fields will be null for non-unit ledgers.GET /accounting/ledgers — Lightweight, non-paginated ledger lookup (typeahead / batch ID lookup).GET /accounting/ledgers/{ledgerID} — Single ledger detail with optional includes.| search | string Filter by term in description, name, amount, or address |
| isActive | boolean |
| ledgerID | integer Example: ledgerID=100 Filter to a single ledger by its primary key. |
| ledgerTypeIDs[] | Array of integers Filter by an array of ledgerTypeIDs |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "120" Total number of items across all pages. |
| pagination-total-pages | integer Example: "5" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page. |
| pagination-before-page | integer or null Previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" First page number (always 1). |
| pagination-last-page | integer Example: "5" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object or null Unit details joined from |
[- {
- "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
}
}
]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.
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.
bankAccountID with isCurrent=true) before reconciling a
transaction into it.excludeInBalanceReconciliations=true).{"error": "Access Denied"}: a reconciliation spans every
portfolio that uses the bank account, so restricted keys can't read reconciliations at all.statementEndDate, newest first, then by reconciliationID, highest first.true/false/1/0/yes/no) is ignored, and the list comes back unfiltered by it.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.| search | string Example: search=Operating 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 ( |
| bankAccountID | integer Example: bankAccountID=124 Keeps one bank account's reconciliations. Bank account IDs come from |
| bankAccountIDs[] | Array of integers Keeps the reconciliations of any of these bank accounts. Send each ID as its own |
| isCurrent | string Example: isCurrent=true
|
| isVoided | string Example: isVoided=false
|
| statementEndingBalanceMin | string Example: statementEndingBalanceMin=1000.00 Keeps the reconciliations whose statement ending balance is at least this amount. Ignored when it isn't a number. |
| statementEndingBalanceMax | string Example: statementEndingBalanceMax=50000.00 Keeps the reconciliations whose statement ending balance is at most this amount. Ignored when it isn't a number. |
| statementStartDateMin | string Example: statementStartDateMin=2026-01-01 Keeps the statements that start on or after this date ( |
| statementStartDateMax | string Example: statementStartDateMax=2026-12-31 Keeps the statements that start on or before this date ( |
| statementEndDateMin | string Example: statementEndDateMin=2026-01-01 Keeps the statements that end on or after this date ( |
| statementEndDateMax | string Example: statementEndDateMax=2026-12-31 Keeps the statements that end on or before this date ( |
| excludeInBalanceReconciliations | string Example: excludeInBalanceReconciliations=true
|
| page | integer Default: 1 The page to return. A value below 1 is read as 1. |
| pageSize | 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. |
| pagination-page-size | integer Example: "3" The page size used, or the number of matching reconciliations when that is smaller; 15 when nothing matches. |
| pagination-total-items | integer Example: "3" Total number of matching reconciliations across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (reconciliation_list_item) A reconciliation as |
required | object The bank account the reconciliation belongs to. |
[- {
- "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"
}
}
]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.
POST /files).Accounting › ModifyReconciliations); without it the
API answers 403 {"error": "Permission Denied"}.{"error": "Access Denied"}.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.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.This reconciliation is being updated, please try again. Retry a moment later.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.transactions is marked reconciled with the new reconciliation's ID.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.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.matchedBankTransactions) needs matches, which this reference leaves out, so a reconciliation created without
it links none.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.| bankAccountID required | string or integer^-?[0-9]+$ The bank account being reconciled, from |
| statementEndDate required | string Last day of the statement period ( |
| statementEndingBalance required | string or number <decimal> ^-?[0-9]+(\.[0-9]+)?$ The ending balance on the bank statement, as a decimal number. |
required | Array of objects The items the statement cleared. Send an empty array when it cleared none. |
| statementStartDate | string First day of the statement period ( |
| attachments | Array of strings or integers[ items^-?[0-9]+$ ] Files to attach to the reconciliation, by |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| reconciliationID required | string^-?[0-9]+$ Unique identifier for the reconciliation record. |
| reconciliationVersionID required | integer Value: 2 Always |
| bankAccountID required | string or integer^-?[0-9]+$ The bank account, exactly as the request sent it (a string or a number). |
| statementStartDate required | string <date> Start of the statement period, as |
| statementEndDate required | string <date> End of the statement period, as |
| statementEndingBalance required | string or number <decimal> The statement's ending balance, exactly as the request sent it (a string or a number). |
| isCurrent required | integer Value: 1 Always |
| isVoided required | integer Value: 0 Always |
| previousStatementEndingBalance required | string or number <decimal> The previous reconciliation's ending balance: a decimal string read from it, or the number |
| moneyInTotal required | number Total money-in (credits) for the period. Computed by the API and sent as a JSON number ( |
| moneyOutTotal required | number Total money-out (debits) for the period. Computed by the API and sent as a JSON number ( |
| reconciledMoneyInTotal required | number Total reconciled credits for the period. Computed by the API and sent as a JSON number ( |
| reconciledMoneyOutTotal required | number Total reconciled debits for the period. Computed by the API and sent as a JSON number ( |
| unreconciledMoneyInTotal required | number Total unreconciled credits remaining. Computed by the API and sent as a JSON number ( |
| unreconciledMoneyOutTotal required | number Total unreconciled debits remaining. Computed by the API and sent as a JSON number ( |
| reconciledBalance required | number Net reconciled balance (credits minus debits). Computed by the API and sent as a JSON number ( |
| adjustedCashBalance required | number Adjusted cash balance after reconciliation adjustments. Computed by the API and sent as a JSON number ( |
| bankAccountBalance required | string <decimal> Current bank account balance as of the statement end date. |
| undepositedPaymentsBalance required | string <decimal> Total value of payments not yet deposited. |
| paymentsDepositedAfterStatementEndDateBalance required | string <decimal> Payments deposited after the statement end date. |
| unsettledElectronicTransactionsBalance required | string <decimal> Balance of electronic transactions not yet settled. |
| electronicTransactionsSettledAfterStatementEndDateBalance required | string <decimal> Electronic transactions settled after the statement end date. |
| adjustmentsTotal required | number Value: 0 Total value of all reconciliation adjustments. Always |
| reconciledAdjustmentsTotal required | number Value: 0 Total value of reconciled adjustments. Always |
| unreconciledAdjustmentsTotal required | number Value: 0 Total value of unreconciled adjustments. Always |
| bankAdjustmentBalance required | number Value: 0 Net bank adjustment balance. Always |
| bankAccountUndepositedBalance required | number Value: 0 Undeposited balance in the bank account. Always |
| unsettledPaymentBalance required | number Value: 0 Balance of unsettled incoming payments. Always |
| unsettledPaymentReturnBalance required | number Value: 0 Balance of unsettled returned payments. Always |
| unsettledPayoutBalance required | number Value: 0 Balance of unsettled outgoing payouts. Always |
| unsettledPayoutReturnBalance required | number Value: 0 Balance of unsettled returned payouts. Always |
| createdByUserID required | string^-?[0-9]+$ ID of the user who created this reconciliation ( |
| dateTimeCreated required | string When the reconciliation was created. UTC, formatted |
{- "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
]
}{- "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"
}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.
transactions and ledgerBalances.reconciliationChangeTransactions, changeTransactionBalance).{"error": "Access Denied"}.{"error": "Reconciliation <id> not found"}.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.GET /accounting/reconciliations - List reconciliations.DELETE /accounting/reconciliations/{reconciliationID} - Void this reconciliation.POST /accounting/transactions/{transactionID}/reconcile - Reconcile one more transaction into it.| reconciliationID required | integer Example: 116 The reconciliation's ID, from |
| includes | string Example: includes=transactions,ledgerBalances Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
object (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. | |
Array of objects The unreconciled items dated on or before the statement end date at completion. Requires the | |
object The period's payments and payouts that couldn't be reconciled at completion, by reason. Requires the | |
Array of objects The changes made after completion, without the voided ones. Requires the | |
| changeTransactionBalance | number Net of the changes in |
Array of objects 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 | |
object or Array of reconciliation_matched_bank_transaction (objects) The Bank Sync transactions confirmed as matches for the items this reconciliation cleared, keyed by the
item ( |
{- "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
}
]
}
}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.
Accounting › VoidReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.{"error": "Access Denied"}.Only the most current reconciliation can be deleted.{"error": "Reconciliation <id> not found"}.This reconciliation is being updated, please try again.previousReconciliationID.reconciliationChangeTransactions include no longer lists them.GET /accounting/reconciliations/{reconciliationID} - Read the voided reconciliation.POST /accounting/reconciliations - Complete the reconciliation again.| reconciliationID required | integer Example: 52 The reconciliation's ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| reconciliationID required | string^-?[0-9]+$ Unique identifier for the reconciliation record. |
| reconciliationVersionID required | string (reconciliation_versions) Enum: "1" "2" Version identifier for the reconciliation.
|
| bankAccountID required | string^-?[0-9]+$ The bank account this reconciliation belongs to. |
| statementStartDate required | string <date> Start date of the bank statement period. |
| statementEndDate required | string <date> End date of the bank statement period. |
| statementEndingBalance required | string <decimal> Ending balance from the bank statement. |
| isCurrent required | integer Value: 0 Always |
| isVoided required | integer Value: 1 Always |
| previousStatementEndingBalance required | string <decimal> Ending balance from the previous statement period. |
| moneyInTotal required | string <decimal> Total money-in (credits) for the period. |
| moneyOutTotal required | string <decimal> Total money-out (debits) for the period. |
| reconciledMoneyInTotal required | string <decimal> Total reconciled credits for the period. |
| reconciledMoneyOutTotal required | string <decimal> Total reconciled debits for the period. |
| unreconciledMoneyInTotal required | string <decimal> Total unreconciled credits remaining. |
| unreconciledMoneyOutTotal required | string <decimal> Total unreconciled debits remaining. |
| reconciledBalance required | string <decimal> Net reconciled balance (credits minus debits). |
| adjustedCashBalance required | string <decimal> Adjusted cash balance after reconciliation adjustments. |
| bankAccountBalance required | string <decimal> Current bank account balance as of the statement end date. |
| undepositedPaymentsBalance required | string <decimal> Total value of payments not yet deposited. |
| paymentsDepositedAfterStatementEndDateBalance required | string <decimal> Payments deposited after the statement end date. |
| unsettledElectronicTransactionsBalance required | string <decimal> Balance of electronic transactions not yet settled. |
| electronicTransactionsSettledAfterStatementEndDateBalance required | string <decimal> Electronic transactions settled after the statement end date. |
| adjustmentsTotal required | string <decimal> Total value of all reconciliation adjustments. |
| reconciledAdjustmentsTotal required | string <decimal> Total value of reconciled adjustments. |
| unreconciledAdjustmentsTotal required | string <decimal> Total value of unreconciled adjustments. |
| bankAdjustmentBalance required | string <decimal> Net bank adjustment balance. |
| bankAccountUndepositedBalance required | string <decimal> Undeposited balance in the bank account. |
| unsettledPaymentBalance required | string <decimal> Balance of unsettled incoming payments. |
| unsettledPaymentReturnBalance required | string <decimal> Balance of unsettled returned payments. |
| unsettledPayoutBalance required | string <decimal> Balance of unsettled outgoing payouts. |
| unsettledPayoutReturnBalance required | string <decimal> Balance of unsettled returned payouts. |
| createdByUserID required | string^-?[0-9]+$ ID of the user who created this reconciliation ( |
| dateTimeCreated required | string When the reconciliation was created. UTC, formatted |
{- "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"
}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.
transactionTypeIDs to show only specific payment types (e.g. rent payments).primaryLedgerIDs to scope results to a specific bank account ledger.propertyIDs (comma-separated) and propertyID (single integer) are accepted;
propertyIDs takes precedence.transactionTypeIDs takes precedence over transactionTypeID.ledger, property, portfolio, and unit fields are joined from related
tables and may be null if the transaction has no associated property or unit.GET /accounting/transactions/entries/search - Search individual debit/credit entries.| search | string Filter by term in description, name, amount, or address |
| isVoided | boolean Filter by isVoided |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| datePostedMin | string <date> Filter by minumum datePosted |
| datePostedMax | string <date> Filter by maximum datePosted |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| transactionTypeIDs[] | Array of integers Filter by an array of transactionTypeIDs |
| propertyIDs[] | Array of integers Filter by an array of propertyIDs |
| transactionEntriesLedgerIDs[] | Array of integers Filter by an array of transactionEntriesLedgerIDs |
| primaryLedgerIDs[] | Array of integers Filter by an array of primaryLedgerIDs |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "15" Number of items per page. |
| pagination-total-items | integer Example: "320" Total number of transactions matching the query. |
| pagination-total-pages | integer Example: "22" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null Example: "2" The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "22" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (transaction) |
object or null | |
object or null | |
object or null | |
object or null | |
object Aggregated data from the transaction's debit/credit entries. |
[- {
- "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"
}
}
]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.
entries) and history (transactionLogs,
cashEntryArchives).returnedTransaction), or a payment to its bulk receipt.{"error": "Access Denied"} for a transaction whose primary ledger
it can't access (a manager-ledger transaction needs an unrestricted key).{"error": "Transaction <id> not found"}.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.GET /accounting/transactions/search - Search transactions.GET /accounting/journal-entries/search - Search journal entries.DELETE /accounting/journal-entries/{transactionID} - Void a journal entry.| transactionID required | integer Example: 80980 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects 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
| |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "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"
}
}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.
Accounting › ModifyReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.Transaction type cannot be reconciled.{"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.previousReconciliationID of a transaction it removed.{"error": "Transaction <id> not found"}.reconciliationID is set, and its previousReconciliationID cleared.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.transactionLogs include.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.| transactionID required | integer Example: 99 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| reconciliationID required | string or integer^-?[0-9]+$ The reconciliation to add the transaction to, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects 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
| |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "reconciliationID": 73
}{- "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"
}
}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.
POST /accounting/transactions/{transactionID}/reconcile, or take a transaction out of a completed
reconciliation it shouldn't be in.Accounting › ModifyReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.Transaction is not reconciled.{"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.{"error": "Transaction <id> not found"}.reconciliationID is cleared, and its previousReconciliationID set to the reconciliation it
was removed from.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.transactionLogs include.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.| transactionID required | integer Example: 99 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects 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
| |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "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"
}
}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.
attachments (array of fileID values).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).GET /accounting/other-payments/{transactionID}.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.| ledgerID required | string or integer^-?[0-9]+$ ID of the ledger to post the payment against. |
| amount required | string or number <decimal> Payment amount. |
| chargeAccountID required | string or integer^-?[0-9]+$ Income account ID to credit. |
| datePosted required | string <date> Date the payment was received. |
| bankAccountID required | string or integer^-?[0-9]+$ Bank account ID to debit. |
required | (payment_types_request (string or integer)) or null |
| receivedFrom | string or null Name or description of the payer. |
| reference | string or null Check number, transaction reference, or other identifier. |
| description | string or null Internal memo describing the payment. |
| attachments | Array of integers Array of |
| depositID | string or integer or null^-?[0-9]+$ Deposit ID to associate this payment with, if applicable. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "ledgerID": 1165,
- "receivedFrom": "123pm",
- "amount": 1000,
- "chargeAccountID": 106,
- "datePosted": "2026-05-15",
- "reference": "Test Reference",
- "description": "Test Description",
- "bankAccountID": 31,
- "attachments": [ ],
- "paymentTypeID": 4
}{- "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"
}
}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.
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").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.| leaseID required | integer Example: 2982 ID of the lease to post the charge against. |
| datePosted required | string <date> Date the charge should be posted to the ledger ( |
| amount required | string or number <decimal> Charge amount as a decimal string. |
| chargeAccountID required | string or integer^-?[0-9]+$ Chart-of-account ID to post this charge against. Must be an income-type account enabled for lease charges. |
| description required | string Label for the charge as it appears on statements and the tenant ledger. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "datePosted": "2026-04-25",
- "amount": "1500.00",
- "chargeAccountID": "9",
- "description": "April Rent"
}{- "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"
}
}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.
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.applyAutomatically is true, the server allocates the payment to outstanding charges
from oldest to newest, ignoring the receipts array.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.receipts[].amount plus prepaymentAmount should equal amount.emailReceipt: true triggers an email receipt to the tenant identified by leaseTenantID.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.| leaseID required | integer Example: 2982 ID of the lease to record the payment against. |
| amount required | string or number <decimal> Total payment amount as a decimal string. |
| datePosted required | string <date> Date the payment should be posted to the ledger ( |
| leaseTenantID required | string or integer^-?[0-9]+$ ID of the lease-tenant record identifying the paying tenant. Controls |
| bankAccountID | string or integer or null^-?[0-9]+$ ID of the bank account to deposit the payment into. Pass |
| emailReceipt | boolean Default: false Whether to send a payment receipt email to the tenant identified by |
| leaseID | string or integer^-?[0-9]+$ ID of the lease (must match the |
| prepaymentAccountID | string or integer or null^-?[0-9]+$ Account to hold unallocated (prepayment) funds. Use |
| prepaymentAmount | string or number or null <decimal> Portion of |
| reference | string or null External reference number such as a check number or ACH trace ID. |
| description | string or null Free-text label for this payment as it appears on the tenant ledger. |
| applyAutomatically | boolean Default: false When |
Array of objects List of charge transactions to apply this payment to. Required when
| |
| hasPrepayment | boolean Default: false Whether any portion of this payment should be held as a prepayment.
When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "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
}{- "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"
}
}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.
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} 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.<field> (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).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.amount answers 500 with no body.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:
property - the lease's propertyunit - the lease's unitlease - the leaseDELETE /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.| leaseID required | integer Example: 2982 ID of the lease to credit. |
| includes | string Example: includes=lease Comma-separated related records to add to the response, each under its own key: |
| amount required | string or number <decimal> > 0 Amount to credit; must be above |
| datePosted required | string Date the refunded return posts to the ledger ( |
| description required | string non-empty Free-text description shown on the ledger; required, and can't be blank. |
| equityAccountID required | string or integer^-?[0-9]+$ Equity account that funds the credit (debited); the Manager app defaults to the owner distribution
account. The IDs come from |
| unallocatedAccountID required | string or integer^-?[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 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
object (included_lease) The lease, with the |
{- "amount": "120.00",
- "datePosted": "2026-11-09",
- "description": "Refunded payment returned",
- "equityAccountID": "453",
- "unallocatedAccountID": "3"
}{- "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"
}
}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.
POST /accounting/leases/{leaseID}/payouts.Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}.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"]}.Cannot release a deposit that has not been collected.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).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.amount answers 500 with no body.19) is posted for amount, and one deposit-release row is written per
depositReleases entry; the collected deposit left to release drops by amount.receipts entry applies the credit to that charge.From the code, not covered by a contract test:
managementFeeAmountPaid rise (seen on a live call, where 12.50 was taken on a 125.00 charge).account - always false: the include looks up a column these transactions don't havecontact - always false: a deposit-release credit has no contactlease - the leaseproperty - the lease's propertyunit - the lease's unitreceipts - the charges the credit was applied todepositReleases - the credit's deposit-release rowsDELETE /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.| leaseID required | integer Example: 2982 ID of the lease whose deposit is released. |
| includes | string Example: includes=receipts,depositReleases Comma-separated related records to add to the response, each under its own key: |
| amount required | string or number <decimal> Amount to release; must equal the sum of |
| datePosted required | string Date the credit posts to the ledger ( |
| description required | string non-empty Free-text description shown on the ledger; required, and can't be blank. |
required | Array of objects non-empty The deposit accounts to release from, and how much from each. |
Array of objects Open charges on the lease to apply the credit to, and how much to each. Optional. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
| account | boolean Value: false With the |
| contact | boolean Value: false With the |
object (included_lease) The lease, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects The credit's receipts that aren't voided, with the | |
Array of objects (included_deposit_release) The credit's deposit-release rows, with the |
{- "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"
}
]
}{- "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"
}
}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).
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}.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.isMFACodeRequiredForPayoutApproval is on: then
isApproved: true without mfaCode answers 400 {"mfaCode": ["MFA Code is Required"]}, and a wrong code
{"mfaCode": ["MFA Code is Invalid"]}.amount exactly, and no receipt may apply more than what is left of the payment
or credit it names; otherwise 400 (see the examples).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).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).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].<field>.amount answers 500 with no body.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.amount.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:
isMoveOutTransaction defaults to whether the lease is in move-out (active or completed), unless
the body sets it.checkNumber in the body is used as is, and the bank account's next check number isn't advanced.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).| leaseID required | integer Example: 2982 ID of the lease whose tenant is refunded. |
| bankAccountID required | string or integer^-?[0-9]+$ Bank account the payout is paid from; a missing or unknown one answers |
| datePosted required | string Date the payout batch posts ( |
| amount required | string or number <decimal> Payout amount; must equal the sum of |
required | Array of objects non-empty The tenant payments or credits the payout refunds, and how much from each. |
| payoutTypeID | string or integer Default: 2 Enum: "1" "2" "3" "4" 1 2 3 4 How the payout is paid; defaults to a check:
|
| leaseTenantID | string or integer^-?[0-9]+$ Tenant on this lease to pay, when |
| contactID | string or integer^-?[0-9]+$ Contact to pay. The tenants' contact IDs come from |
| description | string or null Ignored; a payout has no description. Its ledger transaction is described with |
| memo | string or null Memo printed on the check; it also describes the payout's ledger transaction. |
| checkPayeeName | string or null Name printed on the check. |
| checkNumber | string or null Check number to use instead of the bank account's next check number. |
| payeeAddress | string or null Mailing address of the payee. |
| payeeAddress2 | string or null Second address line of the payee. |
| payeeCity | string or null City of the payee. |
| payeeStateID | string or null State of the payee; checked against |
| payeePostalCode | string or null Postal code of the payee. |
| payeeCountryID | string or null Country of the payee. The values come from |
| isApproved | boolean Default: false Approve the batch now. Honoured only when the API key's role has Approve Payout Batch; otherwise ignored. |
| mfaCode | string or null The approver's MFA code, needed with |
| isMoveOutTransaction | boolean or 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 or integer or null^-?[0-9]+$ For an ACH payout ( |
(bank_account_types_request (string or integer)) or null For an ACH payout without
| |
| refundAchRoutingNumber | string or null For an ACH payout without |
| refundAchAccountNumber | string or null For an ACH payout without |
| refundAchIsCorporateAccount | string or integer or boolean or null For an ACH payout without |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The payout batch the request created. |
{- "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"
}
]
}{- "payoutBatch": {
- "payoutBatchID": "22",
- "payoutBundleID": null,
- "bankAccountID": "437",
- "payoutBatchStatusID": 1,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:07:14"
}
}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.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.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.400 {"isVoided": ["Cannot modify a voided transaction"]}.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.From the code, not covered by a contract test:
updateLeaseCharge event is recorded, and the lease's last-activity date is updated.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).| transactionID required | integer Example: 80980 ID of the lease charge to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[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 required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 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 |
| amountAllocated required | integer or null Enum: 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 |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "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"
}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.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.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.400 {"isVoided": ["Cannot modify a voided transaction"]}.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).From the code, not covered by a contract test:
POST /accounting/leases/{leaseID}/credits (undocumented) - Post a credit.GET /accounting/transactions/search - Find the credit to void (transactionTypeIDs[] 3).| transactionID required | integer Example: 80980 ID of the lease credit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[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 required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 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 |
| amountAllocated required | integer or null Enum: 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 |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "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"
}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.
POST /accounting/leases/payments/{transactionID}/return), which keeps the payment and records the return.Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.400 with a validation map:{"isVoided": ["Cannot modify a voided transaction"]};{"isVoided": ["Cannot void a gateway connected transaction"]};{"isVoided": ["Transaction has been returned and cannot be voided"]};{"depositID": [...], "deposit.transaction.depositID": [...]}, both
Cannot remove deposit from reconciled transaction;{"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;{"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).depositID becomes null).From the code, not covered by a contract test:
deposit - the bank deposit; always false after a void, which takes the payment out of its depositcontact - the paying tenant's contactlease - the leaseportfolio - the portfolio the payment posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreturnTransaction - the return transaction; always null here, since a returned payment can't be voidedbulkPayment - the bulk payment it belongs to, or nulltransactionLogs - the payment's change log, the void includedreceipts - receipts that aren't voided; always empty after a voidmanagementFees - management fees that aren't voided; empty after a voidPOST /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).| transactionID required | integer Example: 80981 ID of the lease payment to void. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "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"
}
}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.
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} 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.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.{"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.{"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.400 with an empty array [] and no message.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.Refunded Payment Returned) and a matching charge
(Refunded Payment Return Recovery) are posted for the refunded amount.bankFee under ledger management fees, a bank fee is posted on the payment's bank account.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:
createLeasePaymentReturn event is recorded, and the lease's last-activity date is updated.deposit - the bank deposit the payment is incontact - the paying tenant's contactlease - the leaseportfolio - the portfolio the payment posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreturnTransaction - the return transaction this request createdbulkPayment - the bulk payment it belongs to, or nulltransactionLogs - the payment's change logreceipts - receipts that aren't voided: after a return, only refund (payout) receiptsmanagementFees - management fees that aren't voided; empty after a returnDELETE /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).| transactionID required | integer Example: 80981 ID of the lease payment that was returned. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
required | object The return transaction. |
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. | |
object A charge to the tenant for the return (an NSF fee), posted on the lease with the return's date and the
description |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "return": {
- "datePosted": "2026-11-09",
- "description": "Returned check: insufficient funds"
}, - "charge": {
- "chargeAccountID": "9",
- "amount": "35.00"
}
}{- "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"
}
}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.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.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.400 {"isVoided": ["Cannot modify a voided transaction"]}.POST /accounting/leases/{leaseID}/refunded-returns - Record a refunded return.GET /accounting/transactions/search - Find the refunded return to void (transactionTypeIDs[] 25).| transactionID required | integer Example: 80980 ID of the lease refunded return to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[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 required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 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 |
| amountAllocated required | integer or null Enum: 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 |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "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"
}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.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.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.400 {"isVoided": ["Cannot modify a voided transaction"]}.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).depositReleases include still lists them). A void entry is added to its
transaction log.From the code, not covered by a contract test:
POST /accounting/leases/{leaseID}/deposit-release-credits - Release a collected deposit.GET /accounting/transactions/search - Find the deposit-release credit to void (transactionTypeIDs[] 19).| transactionID required | integer Example: 80980 ID of the lease deposit-release credit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[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 required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 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 |
| amountAllocated required | integer or null Enum: 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 |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "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"
}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.
propertyIDs to see transfers affecting specific properties.transactionEntriesLedgerIDs to find transfers that touched a given ledger.isVoided=1.amountMin and amountMax filter on the absolute transaction amount as a decimal.GET /accounting/recurring-ledger-transfers/search — Search recurring ledger transfer schedules.GET /accounting/transactions/search — Broad transaction search across all types.| search | string Filter by term in description, name, amount, or address |
| isVoided | boolean Filter by isVoided |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| datePostedMin | string <date> Filter by minumum datePosted |
| datePostedMax | string <date> Filter by maximum datePosted |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| propertyIDs[] | Array of integers Filter by an array of propertyIDs |
| transactionEntriesLedgerIDs[] | Array of integers Filter by an array of transactionEntriesLedgerIDs |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "940" Total number of items across all pages. |
| pagination-total-pages | integer Example: "38" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page. |
| pagination-before-page | integer or null Previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" First page number (always 1). |
| pagination-last-page | integer Example: "38" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (transaction) |
required | object |
required | object |
required | object |
required | object |
required | object |
[- {
- "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"
}
}
]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.
Accounting › ModifyJournalEntries); without it, 403
{"error": "Permission Denied"}.{"error": "Access Denied"}.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.debitEntry.<field> or creditEntry.<field> 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.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.primaryLedgerID is the portfolio's
ledger, with propertyID (and unitID) set.Cannot create a journal entry on the manager ledger when in billed management fee mode).managementFeeMode).includes to get related records in the response, as GET /accounting/transactions/{transactionID}
takes them.transactionLogs include) and one cash-and-accrual entry
per line (entries, cashEntries and accrualEntries includes).isSuppressed 1.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.| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| ledgerID required | string or integer^-?[0-9]+$ The ledger to post on, from |
| datePosted required | string The date the entry posts on, |
| description required | string [ 1 .. 4000 ] characters What the entry is for. |
required | Array of objects >= 2 items 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 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects 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
| |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (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 | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "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"
}
]
}{- "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"
}
}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.
propertyIDs to find journal entries affecting a specific property.transactionEntriesLedgerIDs to find entries that touched a given ledger.isVoided=1.amountMin and amountMax filter on the absolute transaction amount as a decimal.GET /accounting/recurring-journal-entries/search — Search recurring journal entry schedules.GET /accounting/transactions/search — Broad transaction search across all types.| search | string Filter by term in description, name, amount, or address |
| isVoided | boolean Filter by isVoided |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| datePostedMin | string <date> Filter by minumum datePosted |
| datePostedMax | string <date> Filter by maximum datePosted |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| propertyIDs[] | Array of integers Filter by an array of propertyIDs |
| transactionEntriesLedgerIDs[] | Array of integers Filter by an array of transactionEntriesLedgerIDs |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "200" Total number of items across all pages. |
| pagination-total-pages | integer Example: "8" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page. |
| pagination-before-page | integer or null Previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" First page number (always 1). |
| pagination-last-page | integer Example: "8" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (transaction) |
required | object |
required | object |
required | object |
required | object |
required | object |
[- {
- "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"
}
}
]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.
Accounting › VoidJournalEntries); without it, 403
{"error": "Permission Denied"}. Modify Journal Entries alone isn't enough.{"error": "Journal Entry <id> not found"}.{"error": "Access Denied"} for an entry outside them.{"isVoided": ["Cannot modify a voided transaction"]}), and so is one with a
reconciled line ({"reconciliationID": ["Cannot modify a journal entry that has been reconciled"]}).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).transactionLogs include).GET /accounting/transactions/{transactionID} - Read the voided entry and its lines.POST /accounting/journal-entries - Post a corrected entry.| transactionID required | integer Example: 80980 The journal entry's transaction ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID required | string^-?[0-9]+$ Unique identifier for the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25"
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee calculation mode applied to this transaction.
|
| primaryLedgerID required | string or null^-?[0-9]+$ The ledger the transaction posts on ( |
| portfolioID required | string or null^-?[0-9]+$ Portfolio this transaction belongs to. |
| propertyID required | string or null^-?[0-9]+$ Property associated with this transaction. |
| unitID required | string or null^-?[0-9]+$ Unit associated with this transaction. |
| leaseID required | string or null^-?[0-9]+$ Lease this transaction is posted against. |
| billID required | string or null^-?[0-9]+$ Bill linked to this transaction, if any. |
| contactID required | string or null^-?[0-9]+$ The contact (tenant, owner or vendor) the transaction belongs to, or null. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the payment was deposited into, if applicable. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-account ID the charge posts against (present for charge transactions). |
| equityAccountID required | string or null^-?[0-9]+$ Equity account ID, if applicable. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account for transfer transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account used for management fee recording. |
required | account_filter_types (string) or null Filter type controlling which prepayment account is used.
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment/unapplied account ID. Use |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account used to hold unallocated payment funds. |
| payoutID required | string or null^-?[0-9]+$ Payout linked to this transaction, if any. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return linked to this transaction, if any. |
| amount required | string <decimal> Transaction amount as a decimal string. |
| amountPaid required | string or null <decimal> Amount of the charge that has been paid so far. |
| amountAllocated required | string or null <decimal> Portion of a payment that has been applied to charges. |
| processingFee required | string or null <decimal> Processing fee amount collected on this payment, if any. |
| convenienceFee required | string or null <decimal> Convenience fee charged on online payments. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Transaction ID of the associated convenience fee transaction. |
| description required | string or null <= 4000 characters Free-text label for this transaction. |
| reference required | string or null <= 200 characters External reference number (e.g. check number, ACH trace ID). |
| receivedFrom required | string or null <= 100 characters Name of the payer as recorded on the transaction. |
| returnTransactionID required | string or null^-?[0-9]+$ On a transaction that was returned (a payment), the ID of the return transaction that reversed it; null otherwise. The |
required | return_types (string) or null Return type code when this is a returned payment.
|
| returnDescription required | string or null <= 200 characters Reason for the return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment batch this transaction belongs to, if any. |
required | payment_types (string) or null How the payment was made, or null on a transaction that isn't a payment.
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Charge transaction on a bill that this payment is applied to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Credit transaction on a bill associated with this transaction. |
| discountAmount required | string or null <decimal> Discount amount applied to this transaction. |
| markupAmount required | string or null <decimal> Markup amount applied to this transaction. |
| managementFeeAmountPaid required | string or null <decimal> Management fee portion that has been paid. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether this transaction is an additional management fee charge ( |
| managementFeePercent required | string or null <decimal> Management fee percentage applied to this transaction. |
| isSuppressed required | string Enum: "0" "1" Whether this transaction is suppressed from certain reports ( |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account used for management fee disbursements. |
| managementFeePeriodDate required | string or null <date> Period date for management fee calculation. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee on this transaction. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax amount on the management fee that has been paid. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percentage applied to the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account for management fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account for management fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch this transaction belongs to, if any. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether this transaction is a sales tax charge ( |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to this charge transaction. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ ID of the parent transaction that triggered this sales tax charge. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment gateway ID associated with the bank account. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Gateway-assigned transaction identifier. |
| settlementID required | string or null^-?[0-9]+$ Settlement batch this transaction was settled in. |
| paymentAccountName required | string or null <= 200 characters Bank account name of the payer (for ACH/card transactions). |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last 4 digits of the payer's account number. |
| depositID required | string or null^-?[0-9]+$ Deposit batch this payment was included in. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation this transaction has been reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Previous reconciliation ID if the transaction was moved between reconciliations. |
required | transaction_statuses (string) or null ACH processing status code for electronic payments.
|
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer record ID for ACH transactions. |
| lateFeePeriod required | string or null^-?[0-9]+$ On a late fee charge, the period the late fee was assessed for; null otherwise. |
| isFromManager required | string or null Enum: "0" "1" null Whether this transaction was entered directly by a manager ( |
| isMoveInCharge required | integer Value: 0 Always |
| isProrated required | integer Value: 0 Always |
| isMoveOutTransaction required | integer Value: 0 Always |
| moveOutAmount required | string or null <decimal> Amount applied during move-out settlement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge transaction ID for discount or markup adjustments. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge object that generated this transaction, if any. |
| residentServiceID required | string or null^-?[0-9]+$ ID of the service this record points to. |
| residentPackageID required | string or null^-?[0-9]+$ ID of the package this record points to. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency for withholding tax, if applicable. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact associated with withholding tax, if applicable. |
| datePosted required | string <date> Date the transaction was posted to the ledger. |
| dateTimeCreated required | string Timestamp when the transaction record was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the transaction record was last modified. UTC, formatted |
{- "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"
}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.
bankAccountIDs to find transfers associated with a specific bank account.nextRunDateMin/nextRunDateMax to see transfers running in the next N days.ledgerIDs to find transfers that involve a specific ledger.amountMin and amountMax filter on the transfer amount as a decimal.endDate is nullable; a null value means the schedule runs indefinitely.GET /accounting/ledger-transfers/search — Search posted ledger transfer transactions.| search | string Filter by term in description, name, amount, or address |
| ledgerIDs[] | Array of integers Filter by an array of ledgerIDs |
| bankAccountIDs[] | Array of integers Filter by an array of bankAccountIDs |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| endDateMin | string <date> Filter by minimum end date (inclusive) |
| endDateMax | string <date> Filter by maximum end date (inclusive) |
| nextRunDateMin | string <date> Filter by minimum next run date (inclusive) |
| nextRunDateMax | string <date> Filter by maximum next run date (inclusive) |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "12" Total number of items across all pages. |
| pagination-total-pages | integer Example: "1" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Next page number, or null if on the last page. |
| pagination-before-page | integer or null Previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" First page number (always 1). |
| pagination-last-page | integer Example: "1" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
[- {
- "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"
}
}
]Paginated search for recurring journal entry schedules. Each result contains the recurring journal entry record alongside the full ledger object it is associated with.
ledgerIDs to find recurring entries associated with a specific ledger.nextRunDateMin/nextRunDateMax to see entries posting in the next N days.endDateMin/endDateMax to find schedules expiring in a given window.amountMin and amountMax filter on the entry amount as a decimal.endDate is nullable; a null value means the schedule runs indefinitely.GET /accounting/journal-entries/search — Search posted journal entry transactions.| search | string Filter by term in description, name, amount, or address |
| ledgerIDs[] | Array of integers Filter by an array of ledgerIDs |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| endDateMin | string <date> Filter by minimum end date (inclusive) |
| endDateMax | string <date> Filter by maximum end date (inclusive) |
| nextRunDateMin | string <date> Filter by minimum next run date (inclusive) |
| nextRunDateMax | string <date> Filter by maximum next run date (inclusive) |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page. |
| pagination-total-items | integer Example: "8" Total number of items across all pages. |
| pagination-total-pages | integer Example: "1" Total number of pages. |
| pagination-current-page | integer Example: "1" Current page number. |
| pagination-next-page | integer or null Next page number, or null if on the last page. |
| pagination-before-page | integer or null Previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" First page number (always 1). |
| pagination-last-page | integer Example: "1" Last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
[- {
- "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"
}
}
]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.
isCash or isAccrual for cash vs. accrual basis reporting.isSuppressed to show or exclude management-fee suppressed entries.propertyIDs (comma-separated) and propertyID (single integer) are accepted;
propertyIDs takes precedence.ledgerIDs takes precedence over ledgerID.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.ledger (the account being debited/credited) and
the primaryLedger (the bank account of the parent transaction).GET /accounting/transactions/search - Search parent transactions.| search | string Filter by term in description, name, amount, or address |
| isVoided | boolean Filter by isVoided |
| isSuppressed | boolean Filter by isSuppressed |
| isCash | boolean Filter by isCash |
| isAccrual | boolean Filter by isAccrual |
| amountMin | number <double> Filter by minumum amount |
| amountMax | number <double> Filter by maximum amount |
| datePostedMin | string <date> Filter by minumum datePosted |
| datePostedMax | string <date> Filter by maximum datePosted |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only records last modified on or after this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only records last modified on or before this date and time, in UTC. Any time-zone offset is ignored, not applied:
|
| transactionTypeIDs[] | Array of integers Filter by an array of transactionTypeIDs |
| propertyIDs[] | Array of integers Filter by an array of propertyIDs |
| ledgerIDs[] | Array of integers Filter by an array of ledgerIDs |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 15 Number of items per page |
| pagination-page-size | integer Example: "15" Number of items per page. |
| pagination-total-items | integer Example: "580" Total number of entries matching the query. |
| pagination-total-pages | integer Example: "39" Total number of pages. |
| pagination-current-page | integer Example: "1" The current page number. |
| pagination-next-page | integer or null Example: "2" The next page number, or null if on the last page. |
| pagination-before-page | integer or null The previous page number, or null if on the first page. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "39" The last page number. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (transaction_entry) |
required | object (transaction) |
object or null | |
object or null | |
object or null | |
object or null | |
object or null |
[- {
- "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"
}
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID | string^-?[0-9]+$ |
| primaryLedgerID | string or null^-?[0-9]+$ |
| portfolioID | string or null^-?[0-9]+$ |
| ledgerName | string |
| propertyID | string or null^-?[0-9]+$ |
| propertyAddress | string |
| propertyAddress2 | string or null |
| propertyCity | string |
| propertyStateID | string |
| propertyPostalCode | string |
| chargeAccountID | string or null^-?[0-9]+$ |
| contactID | string or null^-?[0-9]+$ |
| contactTypeID | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| contactName | string |
| amount | string <decimal> |
| amountAllocated | string or null <decimal> |
| description | string or null |
| isSuppressed | string Enum: "0" "1" |
| datePosted | string <date> |
[- {
- "transactionID": "string",
- "primaryLedgerID": "string",
- "portfolioID": "string",
- "ledgerName": "string",
- "propertyID": "string",
- "propertyAddress": "string",
- "propertyAddress2": "string",
- "propertyCity": "string",
- "propertyStateID": "string",
- "propertyPostalCode": "string",
- "chargeAccountID": "string",
- "contactID": "string",
- "contactTypeID": "1",
- "contactName": "string",
- "amount": "string",
- "amountAllocated": "string",
- "description": "string",
- "isSuppressed": "0",
- "datePosted": "2019-08-24"
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| propertyID | string^-?[0-9]+$ |
| propertyName | string or null |
| propertyStreetName | string |
| propertyStreetNumber | string |
| propertyAddress | string or null |
| propertyAddress2 | string or null |
| propertyCity | string |
| propertyStateID | string |
| propertyPostalCode | string |
| accountID | string^-?[0-9]+$ |
| balance | number <double> |
| managerLedgerID | integer |
[- {
- "propertyID": "string",
- "propertyName": "string",
- "propertyStreetName": "string",
- "propertyStreetNumber": "string",
- "propertyAddress": "string",
- "propertyAddress2": "string",
- "propertyCity": "string",
- "propertyStateID": "string",
- "propertyPostalCode": "string",
- "accountID": "string",
- "balance": 0.1,
- "managerLedgerID": 0
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| ledgerID | string^-?[0-9]+$ |
| ledgerName | string |
| ledgerTypeID | string (ledger_types) Enum: "1" "2" "3" "4"
|
| ledgerObjectID | integer |
| accountID | string^-?[0-9]+$ |
| accountName | string |
| accountNumber | string |
| balance | number <double> |
[- {
- "ledgerID": "string",
- "ledgerName": "string",
- "ledgerTypeID": "1",
- "ledgerObjectID": 0,
- "accountID": "string",
- "accountName": "string",
- "accountNumber": "string",
- "balance": 0.1
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| ledgerID | string^-?[0-9]+$ |
| ledgerName | string |
| ledgerTypeID | string (ledger_types) Enum: "1" "2" "3" "4"
|
| ledgerObjectID | integer |
| operatingBalance | number <double> |
| reserveAmount | string <decimal> |
[- {
- "ledgerID": "string",
- "ledgerName": "string",
- "ledgerTypeID": "1",
- "ledgerObjectID": 0,
- "operatingBalance": 0.1,
- "reserveAmount": "string"
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| ledgerID | string^-?[0-9]+$ |
| ledgerName | string |
| ledgerTypeID | string (ledger_types) Enum: "1" "2" "3" "4"
|
| ledgerObjectID | integer |
| depositBalance | number <double> |
| escrowBalance | number <double> |
[- {
- "ledgerID": "string",
- "ledgerName": "string",
- "ledgerTypeID": "1",
- "ledgerObjectID": 0,
- "depositBalance": 0.1,
- "escrowBalance": 0.1
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| ledgerID | string^-?[0-9]+$ |
| ledgerName | string |
| ledgerTypeID | string (ledger_types) Enum: "1" "2" "3" "4"
|
| ledgerObjectID | integer |
| operatingBalance | number <double> |
| prepaymentBalance | number <double> |
[- {
- "ledgerID": "string",
- "ledgerName": "string",
- "ledgerTypeID": "1",
- "ledgerObjectID": 0,
- "operatingBalance": 0.1,
- "prepaymentBalance": 0.1
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| leaseID | string^-?[0-9]+$ |
| tenants | Array of strings or null |
| unitID | string^-?[0-9]+$ |
| unitAddress | string |
| unitAddress2 | string |
| unitCity | string |
| unitStateID | string |
| unitPostalCode | string |
| unitName | string |
| propertyID | string^-?[0-9]+$ |
| propertyAddress | string |
| propertyAddress2 | string |
| propertyCity | string |
| propertyStateID | string |
| propertyPostalCode | string |
| propertyName | string |
| prepaymentBalance | number <double> |
[- {
- "leaseID": "string",
- "tenants": [
- "string"
], - "unitID": "string",
- "unitAddress": "string",
- "unitAddress2": "string",
- "unitCity": "string",
- "unitStateID": "string",
- "unitPostalCode": "string",
- "unitName": "string",
- "propertyID": "string",
- "propertyAddress": "string",
- "propertyAddress2": "string",
- "propertyCity": "string",
- "propertyStateID": "string",
- "propertyPostalCode": "string",
- "propertyName": "string",
- "prepaymentBalance": 0.1
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| accountID | string^-?[0-9]+$ |
| name | string |
| number | string |
| lastReconciliationDate | string <date> |
[- {
- "accountID": "string",
- "name": "string",
- "number": "string",
- "lastReconciliationDate": "2019-08-24"
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID | string^-?[0-9]+$ |
| name | string |
| contactTypeID | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceExpiresDate | string or null <date> |
[- {
- "contactID": "string",
- "name": "string",
- "contactTypeID": "1",
- "liabilityInsuranceExpiresDate": "2019-08-24",
- "workersCompInsuranceExpiresDate": "2019-08-24"
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| transactionID | string^-?[0-9]+$ |
| transactionTypeID | string^-?[0-9]+$ |
| primaryLedgerID | string or null^-?[0-9]+$ |
| primaryLedgerName | string |
| portfolioID | string or null^-?[0-9]+$ |
| propertyID | string or null^-?[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 or null^-?[0-9]+$ |
| leaseID | string or null^-?[0-9]+$ |
| billID | string or null^-?[0-9]+$ |
| datePosted | string <date> |
| cashCredits | number <double> |
| cashDebits | number <double> |
| accrualCredits | number <double> |
| accrualDebits | number <double> |
[- {
- "transactionID": "string",
- "transactionTypeID": "string",
- "primaryLedgerID": "string",
- "primaryLedgerName": "string",
- "portfolioID": "string",
- "propertyID": "string",
- "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",
- "leaseID": "string",
- "billID": "string",
- "datePosted": "2019-08-24",
- "cashCredits": 0.1,
- "cashDebits": 0.1,
- "accrualCredits": 0.1,
- "accrualDebits": 0.1
}
]| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| ledgerID | string^-?[0-9]+$ |
| ledgerName | string |
| ledgerTypeID | string (ledger_types) Enum: "1" "2" "3" "4"
|
| objectID | string^-?[0-9]+$ |
| reserveAmount | string <decimal> |
| additionalReserveAmount | string <decimal> |
| overdraftOverrideAmount | string or 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> |
[- {
- "ledgerID": "string",
- "ledgerName": "string",
- "ledgerTypeID": "1",
- "objectID": "string",
- "reserveAmount": "string",
- "additionalReserveAmount": "string",
- "overdraftOverrideAmount": "string",
- "cashBalance": 0.1,
- "escrowBalance": 0.1,
- "prepaymentBalance": 0.1,
- "depositBalance": 0.1,
- "nonHeldDepositBalance": 0.1,
- "accountsReceivableBalance": 0.1,
- "accountsPayableBalance": 0.1,
- "creditBalance": 0.1,
- "currentCreditBalance": 0.1,
- "currentAccountsPayableBalance": 0.1,
- "liabilityBalance": 0.1,
- "nonHeldLiabilityBalance": 0.1,
- "undepositedReceiptsBalance": 0.1,
- "undepositedEscrowReceiptsBalance": 0.1,
- "workOrderEstimateBalance": 0.1,
- "operatingBalance": 0.1,
- "availableFunds": 0.1
}
]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.
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.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.GET /owners/search - filtered search with computed insurance and tax columnsGET /owners/{contactID} - one owner, with includesPOST /owners - create an owner| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[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. |
[- {
- "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,
- "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"
}
]Creates a new owner contact and returns the full owner detail (same shape as GET /owners/{contactID}).
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.taxPayerName, taxFormTypeID, taxIdentifier) require the Contacts.ManageTaxInfo permission.routingNumber, accountNumber) are stored encrypted; only the last 4 digits of accountNumber are returned in responses.GET /owners/{contactID} — retrieve the created ownerPOST /owners/{contactID} — update owner fields after creationPOST /owners/{contactID}/ach-details (undocumented) — update payout/ACH settings| name required | string Full display name of the owner |
| code | string or null Optional short code for the owner |
| websiteUrl | string or null <uri> Owner website URL |
| birthDate | string or null <date> |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
(bank_account_types_request (string or integer)) or null | |
| achIsCorporateAccount | string or integer^-?[0-9]+$ 1 if ACH account is corporate, 0 otherwise |
| holdPayments | string or integer^-?[0-9]+$ 1 to hold all payments to this owner |
| preventConsolidatedPayments | string or integer^-?[0-9]+$ 1 to prevent consolidated payouts |
| payeeName | string or null Override name for checks and ACH |
| isBillApprovalExempt | string or integer Enum: "0" "1" 0 1 1 to exempt owner from bill approval workflow (requires UpdateBillApprovalExemption permission) |
| taxPayerName | string or null Name on tax documents (requires ManageTaxInfo permission) |
| taxFormTypeID | string or integer or null^-?[0-9]+$ 1099 form type ID (requires ManageTaxInfo permission) |
| taxIdentifier | string or null SSN/EIN stored encrypted (requires ManageTaxInfo permission) |
| routingNumber | string or null ACH routing number — stored encrypted, not returned in responses |
| accountNumber | string or null ACH account number — stored encrypted, only last 4 digits returned |
Array of objects Email records to attach to the owner | |
Array of objects Phone records to attach to the owner | |
| addresses | Array of objects Address records to attach to the owner |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "New User"
}{- "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
}
}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.
code: read it from GET /owners/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive 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.pageSize of 0 or less is served at 15.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.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /owners - the plain list, with the full contact rowGET /owners/{contactID} - one owner, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "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"
}
}
]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.
{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportfolios - 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 accessportalAccounts - the owner portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the owner portal, newest firsttaxAdjustments - the contact's 1099 tax adjustmentsGET /owners - list ownersGET /owners/search - search ownersPOST /owners/{contactID} - update the owner| contactID required | integer Example: 1042 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 | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "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,
- "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"
}
]
}Updates editable fields on an existing owner contact and returns the full owner detail (same shape as GET /owners/{contactID}).
UpdateBillApprovalExemption permission)Update Owner Details permission.400 if the contact is not found or is not an owner.name, code, websiteUrl, birthDate, and isBillApprovalExempt (permission-gated).includes query params to include related data in the response.GET /owners/{contactID} — retrieve current owner detail| contactID required | integer Example: 3513 The unique owner contact ID |
| includes | string Example: includes=portfolios Comma-separated list of related data to include in the response. Available values: |
| name | string Full display name of the owner |
| code | string or null Optional short code |
| websiteUrl | string or null <uri> Owner website URL |
| birthDate | string or null <date> |
| isBillApprovalExempt | string or integer Enum: "0" "1" 0 1 1 to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "Chris Campos",
- "isBillApprovalExempt": "0",
- "birthDate": null,
- "code": null
}{- "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
}
}Permanently deletes an owner contact. Returns the deleted contact as a flat object (not wrapped in a contact key).
Update Owner Details permission.400 if the contact is not found or is not an owner.contact wrapper).POST /owners/{contactID}/deactivate — soft-deactivate instead of permanently deletingGET /owners/{contactID} — verify owner state before deletion| contactID required | integer Example: 5258 The unique owner contact ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID required | string^-?[0-9]+$ |
| contactTypeID required | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| name required | string |
| payoutTypeID required | string (payout_types) Enum: "1" "2" "3" "4"
|
| achIsCorporateAccount required | string^-?[0-9]+$ |
| holdPayments required | string^-?[0-9]+$ |
| isActive required | string Enum: "0" "1" |
| preventConsolidatedPayments required | string^-?[0-9]+$ |
| isFromImport required | string Enum: "0" "1" |
| vendorTypeID | string or null^-?[0-9]+$ |
| firstName | string or null |
| middleName | string or null |
| lastName | string or null |
| suffix | string or null |
| emails | string or null |
| phones | string or null |
| addresses | string or null |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or null^-?[0-9]+$ |
| taxPayerName | string or null |
| taxFormTypeID | string or null^-?[0-9]+$ |
| achDetailsCiphertextID | string or null^-?[0-9]+$ |
| achAccountNumberTruncated | string or null |
bank_account_types (string) or null | |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or null <decimal> |
| discountGraceDays | string or null^-?[0-9]+$ |
| isInsuranceRequiredForPayment | string or null Enum: "0" "1" null |
| importSourceKey | string or null |
| websiteUrl | string or null |
| applicantID | string or null^-?[0-9]+$ |
{- "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"
}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}).
Contacts.UpdateOwner permission.400 if the contact is not found or is not an owner.verifyAccessToContact.isActive = 1 and clears dateTimeDeactivated on the contact record.includes query params to include related data.GET /owners/{contactID} — retrieve owner detailsPOST /owners/{contactID}/deactivate — deactivate an active ownerPOST /owners/{contactID} — update owner fields| contactID required | integer Example: 3513 The unique owner contact ID to activate |
| includes | string Example: includes=portfolios Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}Sets an owner's isActive flag to 0, marking them as inactive. Returns the updated owner detail (same shape as GET /owners/{contactID}).
Contacts.UpdateOwner permission.400 if the contact is not found or is not an owner.verifyAccessToContact.isActive = 0 and updates dateTimeModified and dateTimeDeactivated on the contact record.includes query params to include related data.GET /owners/{contactID} — retrieve owner detailsPOST /owners/{contactID}/activate — re-activate a deactivated ownerPOST /owners/{contactID} — update owner fields| contactID required | integer Example: 3513 The unique owner contact ID to deactivate |
| includes | string Example: includes=portfolios Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}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.
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.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.GET /tenants/search - filtered search with computed insurance and tax columnsGET /tenants/{contactID} - one tenant, with includesPOST /tenants - create a tenant| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[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. |
[- {
- "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,
- "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"
}
]Creates a new tenant contact and returns the full tenant detail (same shape as GET /tenants/{contactID}).
Contacts.UpdateTenant permission.name is required.code, name, websiteUrl, birthDate, identificationTypeID, identificationNumber, identificationCountryID, identificationIssuingLocation, and identificationExpirationDate. Any other fields in the request body are silently ignored.taxPayerName, taxFormTypeID, taxIdentifier) require the Contacts.ManageTaxInfo permission.GET /tenants/{contactID} — retrieve the created tenantPOST /tenants/{contactID} — update tenant fields after creation| name required | string Full display name of the tenant |
| code | string or null Optional short code for the tenant |
| birthDate | string or null <date> |
| identificationTypeID | string or integer or null^-?[0-9]+$ Government ID type identifier |
| identificationNumber | string or null Government ID number |
| identificationCountryID | string or null Country that issued the government ID |
| identificationIssuingLocation | string or null State or location that issued the government ID |
| identificationExpirationDate | string or null <date> Expiration date of the government ID |
Array of objects Email records to attach to the tenant | |
Array of objects Phone records to attach to the tenant | |
| addresses | Array of objects Address records to attach to the tenant |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "Aaron Boone"
}{- "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
}
}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.
code: read it from GET /tenants/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive 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.pageSize of 0 or less is served at 15.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.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /tenants - the plain list, with the full contact rowGET /tenants/{contactID} - one tenant, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "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"
}
}
]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.
{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressleases - 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 contactportalInvitations - the pending, unexpired invitations to the resident portal, newest firstGET /tenants - list tenantsGET /tenants/search - search tenantsPOST /tenants/{contactID} - update the tenant| contactID required | integer Example: 1042 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 | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "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,
- "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"
}
]
}Updates editable fields on an existing tenant contact and returns the full tenant detail (same shape as GET /tenants/{contactID}).
Update Tenant Details permission.400 if the contact is not found or is not a tenant.code, name, birthDate, identificationTypeID, identificationNumber, identificationCountryID, identificationIssuingLocation, identificationExpirationDate. All other fields in the request body are silently ignored.includes query params to include related data in the response.GET /tenants/{contactID} — retrieve current tenant detailPOST /tenants/{contactID}/activate — activate an inactive tenantPOST /tenants/{contactID}/deactivate — deactivate an active tenant| contactID required | integer Example: 4976 The unique tenant contact ID |
| includes | string Example: includes=leases Comma-separated list of related data to include in the response. Available values: |
| name | string Full display name of the tenant |
| code | string or null Optional short code |
| birthDate | string or null <date> |
| identificationTypeID | string or integer or null^-?[0-9]+$ Government ID type identifier |
| identificationNumber | string or null Government ID number |
| identificationCountryID | string or null Country that issued the government ID |
| identificationIssuingLocation | string or null State or location that issued the government ID |
| identificationExpirationDate | string or null <date> Expiration date of the government ID |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "Aaron Boone"
}{- "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
}
}Permanently deletes a tenant contact. Returns the deleted contact as a flat object (not wrapped in a contact key).
Contacts.UpdateTenant permission.400 if the contact is not found or is not a tenant.contact wrapper).POST /tenants/{contactID}/deactivate — soft-deactivate instead of permanently deletingGET /tenants/{contactID} — verify tenant state before deletion| contactID required | integer Example: 2793 The unique tenant contact ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID required | string^-?[0-9]+$ |
| contactTypeID required | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| name required | string |
| payoutTypeID required | string (payout_types) Enum: "1" "2" "3" "4"
|
| achIsCorporateAccount required | string^-?[0-9]+$ |
| holdPayments required | string^-?[0-9]+$ |
| isActive required | string Enum: "0" "1" |
| preventConsolidatedPayments required | string^-?[0-9]+$ |
| isFromImport required | string Enum: "0" "1" |
| vendorTypeID | string or null^-?[0-9]+$ |
| firstName | string or null |
| middleName | string or null |
| lastName | string or null |
| suffix | string or null |
| emails | string or null |
| phones | string or null |
| addresses | string or null |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or null^-?[0-9]+$ |
| taxPayerName | string or null |
| taxFormTypeID | string or null^-?[0-9]+$ |
| achDetailsCiphertextID | string or null^-?[0-9]+$ |
| achAccountNumberTruncated | string or null |
bank_account_types (string) or null | |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or null <decimal> |
| discountGraceDays | string or null^-?[0-9]+$ |
| isInsuranceRequiredForPayment | string or null Enum: "0" "1" null |
| importSourceKey | string or null |
| websiteUrl | string or null |
| applicantID | string or null^-?[0-9]+$ |
{- "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"
}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}).
Update Tenant Details permission.400 if the contact is not found or is not a tenant.isActive = 1GET /tenants/{contactID} — retrieve tenant detailsPOST /tenants/{contactID}/deactivate — deactivate an active tenantPOST /tenants/{contactID} — update tenant fields| contactID required | integer Example: 2793 The unique tenant contact ID to activate |
| includes | string Example: includes=leases Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}Sets a tenant's isActive flag to 0, marking them as inactive. Returns the updated tenant detail (same shape as GET /tenants/{contactID}).
Update Tenant Details permission.400 if the contact is not found or is not a tenant.isActive = 0 and updates dateTimeModified and dateTimeDeactivated on the contact record.includes query params to include related data.GET /tenants/{contactID} — retrieve tenant detailsPOST /tenants/{contactID}/activate — re-activate a deactivated tenantPOST /tenants/{contactID} — update tenant fields| contactID required | integer Example: 2793 The unique tenant contact ID to deactivate |
| includes | string Example: includes=leases Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}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.
contactIDs[]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.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.GET /vendors/search - filtered search with computed insurance and tax columnsGET /vendors/{contactID} - one vendor, with includesPOST /vendors - create a vendor| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 250 Example: pageSize=250 Items per page, from 1 (default 250). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| includeMaintenanceTechnician | string Also list maintenance technicians. |
| vendorTypeID | integer Only contacts of this vendor type, from |
| contactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| vendorContactIDs[] | Array of integers The older name of |
| pagination-page-size | integer Example: "250" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[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. |
[- {
- "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,
- "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"
}
]Creates a new vendor contact and returns the full vendor detail (same shape as GET /vendors/{contactID}).
Update Vendor Details permission.name is the only required field.GET /vendors/{contactID} — retrieve the created vendorPOST /vendors/{contactID} — update vendor fields after creation| name required | string Full display name of the vendor |
| vendorTypeID | string or integer or null^-?[0-9]+$ Vendor trade category type ID |
| code | string or null Optional short code or reference |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ Default chart of accounts ID for bills |
| websiteUrl | string or null <uri> Vendor website URL |
| payeeName | string or null Override name for checks and ACH |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
(bank_account_types_request (string or integer)) or null | |
| achIsCorporateAccount | string or integer^-?[0-9]+$ "1" if ACH account is corporate, "0" otherwise |
| holdPayments | string or integer^-?[0-9]+$ "1" to hold all payments to this vendor |
| preventConsolidatedPayments | string or integer^-?[0-9]+$ "1" to prevent consolidated payouts |
| maxLineItemsOnPayment | string or integer or null^-?[0-9]+$ Maximum number of line items allowed per payment run |
| taxPayerName | string or null Name on 1099 tax documents (requires ManageTaxInfo permission) |
| taxIdentifier | string or null SSN/EIN stored encrypted (requires ManageTaxInfo permission) |
| taxFormTypeID | string or integer or null^-?[0-9]+$ 1099 form type ID (requires ManageTaxInfo permission) |
| discountPercent | string or number or null <decimal> Discount percentage applied to bills from this vendor |
| discountGraceDays | string or integer or null^-?[0-9]+$ Grace days before discount expires |
| routingNumber | string or null ACH routing number — stored encrypted, not returned in responses |
| accountNumber | string or null ACH account number — stored encrypted, only last 4 digits returned |
Array of objects Email records to attach to the vendor | |
Array of objects Phone records to attach to the vendor | |
Array of objects Address records to attach to the vendor | |
| attachments | Array of integers File IDs to attach to the vendor record |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "New Vendor"
}{- "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
}
}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.
code: read it from GET /vendors/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive 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.pageSize of 0 or less is served at 15.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.1, true and yes as yes and 0, false and no as no; any other value is ignored.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.GET /vendors - the plain list, with the full contact rowGET /vendors/{contactID} - one vendor, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| includeManager | string Also return manager contacts. |
| includeMaintenanceTechnician | string Also return maintenance technicians. |
| vendorTypeIDs[] | Array of integers Only contacts of these vendor types, from |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| vendorTradeIDs[] | Array of integers Only contacts assigned to at least one of these trades, from |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| isLiabilityInsuranceExpired | string
|
| daysUntilLiabilityInsuranceExpiresMin | integer Only contacts whose liability insurance expires at least this many days from today. |
| daysUntilLiabilityInsuranceExpiresMax | integer Only contacts whose liability insurance expires at most this many days from today (negative for already expired). |
| isWorkersCompInsuranceExpired | string
|
| daysUntilWorkersCompInsuranceExpiresMin | integer Only contacts whose workers' comp insurance expires at least this many days from today. |
| daysUntilWorkersCompInsuranceExpiresMax | integer Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). |
| isInsuranceExpired | string
|
| daysUntilInsuranceExpiresMin | integer Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. |
| daysUntilInsuranceExpiresMax | integer Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). |
| tagIDs[] | Array of integers Only contacts with at least one of these tags, from |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "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"
}
}
]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.
{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportalAccounts - the vendor portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the vendor portal, newest firstvendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTradetaxAdjustments - the contact's 1099 tax adjustmentscontactPersons - the people on file at the contactreviewStats - one row counting the contact's completed maintenance reviews by ratinginvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /vendors - list vendorsGET /vendors/search - search vendorsPOST /vendors/{contactID} - update the vendor| contactID required | integer Example: 1042 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 | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "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,
- "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"
}
}Updates editable fields on an existing vendor contact and returns the full vendor detail (same shape as GET /vendors/{contactID}).
Update Vendor Details permission.400 if the contact is not found or is not a vendor.isBillApprovalExempt requires the Update Bill Approval Exemption permission to take effect.includes query params to include related data in the response.GET /vendors/{contactID} — retrieve current vendor detail| contactID required | integer Example: 5263 The unique vendor contact ID |
| includes | string Example: includes=vendorTrades Comma-separated list of related data to include in the response. Available values: |
| name | string Full display name of the vendor |
| vendorTypeID | string or integer or null^-?[0-9]+$ Vendor trade category type ID |
| code | string or null Optional short code or reference |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ Default chart of accounts ID for bills |
| websiteUrl | string or null <uri> Vendor website URL |
| ownerPortalNameOverride | string or null Override display name shown in the owner portal |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or number or null <decimal> Discount percentage applied to bills |
| discountAmount | string or number or null <decimal> Flat discount amount applied to bills |
| discountAmountMin | string or number or null <decimal> |
| discountAmountMax | string or number or null <decimal> |
| discountGraceDays | string or integer or null^-?[0-9]+$ Grace days before discount expires |
| isInsuranceRequiredForPayment | string or integer or null Enum: "0" "1" 0 1 null "1" if valid insurance is required before releasing payment |
| isBillingSalesTaxEnabled | string or integer Enum: "0" "1" 0 1 "1" to enable sales tax on invoices billed from this vendor |
| isQuickbooksExportEnabled | string or integer Enum: "0" "1" 0 1 "1" to enable QuickBooks export for this vendor |
| quickbooksCustomerName | string or null |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ ID of the invoice autofill template to link |
| isBillApprovalExempt | string or integer Enum: "0" "1" 0 1 "1" to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "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
}{- "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
}
}Permanently deletes a vendor contact. Returns the deleted contact as a flat object.
Update Vendor Details permission.400 if the contact is not found or is not a vendor.POST /vendors/{contactID}/deactivate — soft-deactivate instead of permanently deletingGET /vendors/{contactID} — verify vendor state before deletion| contactID required | integer Example: 5263 The unique vendor contact ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID required | string^-?[0-9]+$ |
| contactTypeID required | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| name required | string |
| payoutTypeID required | string (payout_types) Enum: "1" "2" "3" "4"
|
| achIsCorporateAccount required | string^-?[0-9]+$ |
| holdPayments required | string^-?[0-9]+$ |
| isActive required | string Enum: "0" "1" |
| preventConsolidatedPayments required | string^-?[0-9]+$ |
| isFromImport required | string Enum: "0" "1" |
| vendorTypeID | string or null^-?[0-9]+$ |
| firstName | string or null |
| middleName | string or null |
| lastName | string or null |
| suffix | string or null |
| emails | string or null |
| phones | string or null |
| addresses | string or null |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or null^-?[0-9]+$ |
| taxPayerName | string or null |
| taxFormTypeID | string or null^-?[0-9]+$ |
| achDetailsCiphertextID | string or null^-?[0-9]+$ |
| achAccountNumberTruncated | string or null |
bank_account_types (string) or null | |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or null <decimal> |
| discountGraceDays | string or null^-?[0-9]+$ |
| isInsuranceRequiredForPayment | string or null Enum: "0" "1" null |
| importSourceKey | string or null |
| websiteUrl | string or null |
| applicantID | string or null^-?[0-9]+$ |
{- "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"
}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}).
Update Vendor Details permission.400 if the contact is not found or is not a vendor.isActive = 1 and clears dateTimeDeactivated on the contact record.includes query params to include related data.GET /vendors/{contactID} — retrieve vendor detailsPOST /vendors/{contactID}/deactivate — deactivate an active vendorPOST /vendors/{contactID} — update vendor fields| contactID required | integer Example: 2888 The unique vendor contact ID to activate |
| includes | string Example: includes=vendorTrades Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}Sets a vendor's isActive flag to 0, soft-deactivating them. Returns the updated vendor detail (same shape as GET /vendors/{contactID}).
Update Vendor Details permission.400 if the contact is not found or is not a vendor.includes query params to include related data.GET /vendors/{contactID} — retrieve vendor detailsPOST /vendors/{contactID}/activate — re-activate a deactivated vendorDELETE /vendors/{contactID} — permanently delete a vendor| contactID required | integer Example: 2888 The unique vendor contact ID to deactivate |
| includes | string Example: includes=vendorTrades Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}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.
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.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.GET /associations/search - filtered search with computed insurance and tax columnsGET /associations/{contactID} - one association, with includesPOST /associations - create an association| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| associationContactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[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. |
[- {
- "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,
- "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"
}
]Creates a new association contact and returns the full association detail
(same shape as GET /associations/{contactID}).
Update Association Details permission.name is the only required field.taxPayerName, taxIdentifier, taxFormTypeID) require the ManageTaxInfo permission.routingNumber, accountNumber) are stored encrypted; only the last 4 digits of the account number are returned.GET /associations/{contactID} — retrieve a created associationPOST /associations/{contactID} — update association fields after creation| name required | string Full display name of the association |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ Default chart of accounts ID for bills charged to this association |
| websiteUrl | string or null <uri> Association website URL |
| taxPayerName | string or null Name on 1099 tax documents (requires ManageTaxInfo permission) |
| taxIdentifier | string or null SSN/EIN stored encrypted (requires ManageTaxInfo permission) |
| taxFormTypeID | string or integer or null^-?[0-9]+$ 1099 form type ID (requires ManageTaxInfo permission) |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
(bank_account_types_request (string or integer)) or null | |
| achIsCorporateAccount | string or integer^-?[0-9]+$ "1" if ACH account is corporate, "0" otherwise |
| holdPayments | string or integer^-?[0-9]+$ "1" to hold all payments to this association |
| preventConsolidatedPayments | string or integer^-?[0-9]+$ "1" to prevent consolidated payouts |
| maxLineItemsOnPayment | string or integer or null^-?[0-9]+$ Maximum number of line items allowed per payment run |
| payeeName | string or null Override name for checks and ACH |
| otherPayoutTypeID | string or integer or null^-?[0-9]+$ Alternative payout type reference |
| code | string or null Optional short code or reference for the association |
| discountPercent | string or number or null <decimal> Discount percentage applied to bills from this association |
| discountGraceDays | string or integer or null^-?[0-9]+$ Grace days before discount expires |
| routingNumber | string or null ACH routing number — stored encrypted, not returned in responses |
| accountNumber | string or null ACH account number — stored encrypted, only last 4 digits returned |
Array of objects Email records to attach to the association | |
Array of objects Phone records to attach to the association | |
Array of objects Address records to attach to the association | |
| attachments | Array of integers File IDs to attach to the association record |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "New Association"
}{- "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
}
}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.
code: read it from GET /associations/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive 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.pageSize of 0 or less is served at 15.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.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /associations - the plain list, with the full contact rowGET /associations/{contactID} - one association, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "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"
}
}
]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.
{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressproperties - the properties linked to the association, each as propertyAssociation and property. A user restricted to portfolio groups gets only the properties in those groups' portfolioscontactPersons - the people on file at the contactinvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /associations - list associationsGET /associations/search - search associationsPOST /associations/{contactID} - update the association| contactID required | integer Example: 1042 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 | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "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,
- "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"
}
}Updates editable fields on an existing association contact and returns the full association
detail (same shape as GET /associations/{contactID}).
Update Association Details permission.400 if the contact is not found or is not an association.isBillApprovalExempt requires the Update Bill Approval Exemption permission to take effect.includes query params to include related data in the response.GET /associations/{contactID} — retrieve current association detail| contactID required | integer Example: 2305 The unique association contact ID |
| includes | string Example: includes=emails,properties Comma-separated list of related data to include in the response. Available values: |
| name | string Full display name of the association |
| code | string or null Optional short code or reference |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ Default chart of accounts ID for bills |
| websiteUrl | string or null <uri> Association website URL |
| ownerPortalNameOverride | string or null Override display name shown in the owner portal |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or number or null <decimal> Discount percentage applied to bills |
| discountGraceDays | string or integer or null^-?[0-9]+$ Grace days before discount expires |
| isBillingSalesTaxEnabled | string or integer Enum: "0" "1" 0 1 "1" to enable sales tax on invoices billed from this association |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ ID of the invoice autofill template to link |
| isBillApprovalExempt | string or integer Enum: "0" "1" 0 1 "1" to exempt from bill approval workflow (requires UpdateBillApprovalExemption permission) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "Sunset Heights HOA Updated",
- "code": null,
- "defaultBillChargeAccountID": null,
- "discountPercent": null,
- "discountGraceDays": null,
- "isBillingSalesTaxEnabled": "0",
- "invoiceAutofillTemplateID": null
}{- "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,
- "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
}
}Permanently deletes an association contact. Returns the deleted contact as a flat object.
Update Association Details permission.400 if the contact is not found or is not an association.400 if contactID is not provided in the path.POST /associations/{contactID}/deactivate — soft-deactivate instead of permanently deletingGET /associations/{contactID} — verify association state before deletion| contactID required | integer Example: 2305 The unique association contact ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID required | string^-?[0-9]+$ |
| contactTypeID required | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| name required | string |
| payoutTypeID required | string (payout_types) Enum: "1" "2" "3" "4"
|
| achIsCorporateAccount required | string^-?[0-9]+$ |
| holdPayments required | string^-?[0-9]+$ |
| isActive required | string Enum: "0" "1" |
| preventConsolidatedPayments required | string^-?[0-9]+$ |
| isFromImport required | string Enum: "0" "1" |
| vendorTypeID | string or null^-?[0-9]+$ |
| firstName | string or null |
| middleName | string or null |
| lastName | string or null |
| suffix | string or null |
| emails | string or null |
| phones | string or null |
| addresses | string or null |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or null^-?[0-9]+$ |
| taxPayerName | string or null |
| taxFormTypeID | string or null^-?[0-9]+$ |
| achDetailsCiphertextID | string or null^-?[0-9]+$ |
| achAccountNumberTruncated | string or null |
bank_account_types (string) or null | |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or null <decimal> |
| discountGraceDays | string or null^-?[0-9]+$ |
| isInsuranceRequiredForPayment | string or null Enum: "0" "1" null |
| importSourceKey | string or null |
| websiteUrl | string or null |
| applicantID | string or null^-?[0-9]+$ |
{- "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"
}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}).
Update Association Details permission.400 if the contact is not found or is not an association.isActive = 1includes query params to include related data.GET /associations/{contactID} — retrieve association detailsPOST /associations/{contactID}/deactivate — deactivate an active associationPOST /associations/{contactID} — update association fields| contactID required | integer Example: 2305 The unique association contact ID to activate |
| includes | string Example: includes=emails,properties Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}Sets an association's isActive flag to 0, soft-deactivating it. Returns the updated
association detail (same shape as GET /associations/{contactID}).
Update Association Details permission.400 if the contact is not found or is not an association.includes query params to include related data.GET /associations/{contactID} — retrieve association detailsPOST /associations/{contactID}/activate — re-activate a deactivated associationDELETE /associations/{contactID} — permanently delete an association| contactID required | integer Example: 2305 The unique association contact ID to deactivate |
| includes | string Example: includes=emails,properties Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}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.
contactIDs[]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.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.GET /maintenance-technicians/search - filtered search with computed insurance and tax columnsGET /maintenance-technicians/{contactID} - one maintenance technician, with includesPOST /maintenance-technicians - create a maintenance technician| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 250 Example: pageSize=250 Items per page, from 1 (default 250). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| includeMaintenanceTechnician | string Changes nothing here: the list already holds maintenance technicians. |
| vendorTypeID | integer Only contacts of this vendor type, from |
| contactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| vendorContactIDs[] | Array of integers The older name of |
| pagination-page-size | integer Example: "250" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[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. |
[- {
- "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"
}
]Creates a new maintenance technician contact and returns the full technician detail (same shape as GET /maintenance-technicians/{contactID}).
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.GET /maintenance-technicians/{contactID} — retrieve the created technicianPOST /maintenance-technicians/{contactID} — update technician fields after creation| name required | string Full display name of the technician |
| code | string or null Optional short code or reference |
| birthDate | string or null <date> Date of birth |
| maxLineItemsOnPayment | string or integer or null^-?[0-9]+$ Maximum number of bill line items allowed per payment run |
| taxPayerName | string or null Name on 1099 tax documents (requires ManageTaxInfo permission) |
| taxIdentifier | string or null SSN/EIN stored encrypted (requires ManageTaxInfo permission) |
| taxFormTypeID | string or integer or null^-?[0-9]+$ 1099 form type ID (requires ManageTaxInfo permission) |
Array of objects Email records to attach to the technician | |
Array of objects Phone records to attach to the technician | |
Array of objects Address records to attach to the technician | |
| attachments | Array of integers File IDs to attach to the technician record |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "New Tech Name"
}{- "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
}
}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.
code: read it from GET /maintenance-technicians/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive 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.pageSize of 0 or less is served at 15.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.1, true and yes as yes and 0, false and no as no; any other value is ignored.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.GET /maintenance-technicians - the plain list, with the full contact rowGET /maintenance-technicians/{contactID} - one maintenance technician, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| includeManager | string Also return manager contacts. |
| includeMaintenanceTechnician | string Changes nothing here: the search already returns maintenance technicians. |
| vendorTypeIDs[] | Array of integers Only contacts of these vendor types, from |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| vendorTradeIDs[] | Array of integers Only contacts assigned to at least one of these trades, from |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| isLiabilityInsuranceExpired | string
|
| daysUntilLiabilityInsuranceExpiresMin | integer Only contacts whose liability insurance expires at least this many days from today. |
| daysUntilLiabilityInsuranceExpiresMax | integer Only contacts whose liability insurance expires at most this many days from today (negative for already expired). |
| isWorkersCompInsuranceExpired | string
|
| daysUntilWorkersCompInsuranceExpiresMin | integer Only contacts whose workers' comp insurance expires at least this many days from today. |
| daysUntilWorkersCompInsuranceExpiresMax | integer Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). |
| isInsuranceExpired | string
|
| daysUntilInsuranceExpiresMin | integer Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. |
| daysUntilInsuranceExpiresMax | integer Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). |
| tagIDs[] | Array of integers Only contacts with at least one of these tags, from |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "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"
}
}
]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.
{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportalAccounts - the maintenance portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the maintenance portal, newest firstvendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTradetaxAdjustments - the contact's 1099 tax adjustmentscontactPersons - the people on file at the contactreviewStats - one row counting the contact's completed maintenance reviews by ratinginvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /maintenance-technicians - list maintenance techniciansGET /maintenance-technicians/search - search maintenance techniciansPOST /maintenance-technicians/{contactID} - update the maintenance technician| contactID required | integer Example: 1042 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 | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "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
}Updates editable fields on an existing maintenance technician contact and returns the full technician detail (same shape as GET /maintenance-technicians/{contactID}).
Update Internal Technician Details permission.400 if the contact is not found or is not a maintenance technician.name, code, and birthDate are writable via this endpoint. All other fields in the request body are silently ignored.includes query params to include related data in the response.GET /maintenance-technicians/{contactID} — retrieve current technician detail| contactID required | integer Example: 5267 The unique maintenance technician contact ID |
| includes | string Example: includes=emails,phones Comma-separated list of related data to include in the response. Available values: |
| name | string Full display name of the technician |
| code | string or null Optional short code or reference |
| birthDate | string or null <date> Date of birth |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (contact) |
{- "name": "new tech names",
- "code": null,
- "birthDate": null
}{- "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
}
}Permanently deletes a maintenance technician contact. Returns the deleted contact as a flat object.
Update Maintenance Technician permission.400 if the contact is not found or is not a maintenance technician.POST /maintenance-technicians/{contactID}/deactivate — soft-deactivate instead of permanently deletingGET /maintenance-technicians/{contactID} — verify technician state before deletion| contactID required | integer Example: 5267 The unique maintenance technician contact ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| contactID required | string^-?[0-9]+$ |
| contactTypeID required | string (contact_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
|
| name required | string |
| payoutTypeID required | string (payout_types) Enum: "1" "2" "3" "4"
|
| achIsCorporateAccount required | string^-?[0-9]+$ |
| holdPayments required | string^-?[0-9]+$ |
| isActive required | string Enum: "0" "1" |
| preventConsolidatedPayments required | string^-?[0-9]+$ |
| isFromImport required | string Enum: "0" "1" |
| vendorTypeID | string or null^-?[0-9]+$ |
| firstName | string or null |
| middleName | string or null |
| lastName | string or null |
| suffix | string or null |
| emails | string or null |
| phones | string or null |
| addresses | string or null |
| birthDate | string or null <date> |
| defaultBillChargeAccountID | string or null^-?[0-9]+$ |
| taxPayerName | string or null |
| taxFormTypeID | string or null^-?[0-9]+$ |
| achDetailsCiphertextID | string or null^-?[0-9]+$ |
| achAccountNumberTruncated | string or null |
bank_account_types (string) or null | |
| liabilityInsuranceName | string or null |
| liabilityInsurancePolicyNumber | string or null |
| liabilityInsuranceExpiresDate | string or null <date> |
| workersCompInsuranceName | string or null |
| workersCompInsurancePolicyNumber | string or null |
| workersCompInsuranceExpiresDate | string or null <date> |
| discountPercent | string or null <decimal> |
| discountGraceDays | string or null^-?[0-9]+$ |
| isInsuranceRequiredForPayment | string or null Enum: "0" "1" null |
| importSourceKey | string or null |
| websiteUrl | string or null |
| applicantID | string or null^-?[0-9]+$ |
{- "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"
}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}).
Update Internal Technician Details permission.400 if the contact is not found or is not a maintenance technician.isActive = 1 includes query params to include related data.GET /maintenance-technicians/{contactID} — retrieve technician detailsPOST /maintenance-technicians/{contactID}/deactivate — deactivate an active technicianPOST /maintenance-technicians/{contactID} — update technician fields| contactID required | integer Example: 5267 The unique maintenance technician contact ID to activate |
| includes | string Example: includes=emails,phones Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}Sets a maintenance technician's isActive flag to 0, soft-deactivating them. Returns the updated technician detail (same shape as GET /maintenance-technicians/{contactID}).
Update Internal Technician Details permission.400 if the contact is not found or is not a maintenance technician.includes query params to include related data.GET /maintenance-technicians/{contactID} — retrieve technician detailsPOST /maintenance-technicians/{contactID}/activate — re-activate a deactivated technicianDELETE /maintenance-technicians/{contactID} — permanently delete a technician| contactID required | integer Example: 5267 The unique maintenance technician contact ID to deactivate |
| includes | string Example: includes=emails,phones Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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
}
}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.
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.dateTimeCreated, newest first, with no tie-breaker: files created in the same second can repeat or
be skipped across pages.GET /files/search - search the account's files, with filtersGET /files/{fileID} - one file, with its attachmentsPOST /files - upload a file| search | string Example: search=front door Part of the file's title, matched anywhere in it and in any case. |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 50 Example: pageSize=50 Items per page, from 1 (default 50). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "50" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the file. |
[- {
- "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"
}
]Uploading a file in Rentvine is generally a 2-step process.
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 for Unit is 7) with unitID of 123.
| objectID | integer The primary key of the object |
| objectTypeID | integer The id of the Object Type |
| includes | string Value: "attachment"
|
| file | string <binary> |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
object (attachment) Included if |
{- "file": {
- "fileID": "60",
- "fileSourceID": "1",
- "isAttachable": "0",
- "title": "string",
- "fileName": "string",
- "fileType": "string",
- "fileSize": "string",
- "userID": "string",
- "isImage": "0",
- "isPublic": "0",
- "previewFileName": "string",
- "dateTimeCreated": "2026-11-14 02:44:30"
}, - "attachment": {
- "fileAttachmentID": "string",
- "fileID": "string",
- "objectTypeID": "1",
- "objectID": "string",
- "isSharedWithOwner": "0",
- "isSharedWithTenant": "0",
- "isSharedWithVendor": "0",
- "isSharedWithApplicant": "0",
- "pathID": "string",
- "portalTypeID": "1",
- "contactID": "string",
- "subObjectTypeID": "1",
- "relatedObjectTypeID": "1",
- "relatedObjectID": "string"
}
}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.
fileSourceIDs[]isAttachable, fileSizeMin or
fileSizeMax value it can't read. A list filter given values that match nothing (fileSourceIDs[]=abc) returns
no files.fileTypes[], fileSourceIDs[], userIDs[]) takes one name[]= per value, and matches any of
them.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.GET /files - the attachable files, newest firstGET /files/{fileID} - one file, with its attachments| search | string Example: search=front door Part of the file's title, matched anywhere in it and in any case. |
| isAttachable | string Example: isAttachable=true
|
| fileType | string Example: fileType=pdf One extension ( |
| fileTypes[] | Array of strings Example: fileTypes[]=pdf&fileTypes[]=jpg Extensions, any of which matches. Send one |
| fileSizeMin | integer Example: fileSizeMin=1 Smallest size in bytes, inclusive. A value that isn't a number doesn't filter. |
| fileSizeMax | integer Example: fileSizeMax=1000000 Largest size in bytes, inclusive. A value that isn't a number doesn't filter. |
| fileSourceIDs[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 Example: fileSourceIDs[]=1 File sources, any of which matches. Send one
|
| userIDs[] | Array of integers Example: userIDs[]=2 The users who uploaded or created the file (a file's |
| attachedToObjectTypeIDs[] | Array of integers Fails with an empty 500 for any value it can use (see Business Rules); don't send it. |
| dateTimeCreatedMin | string Fails with an empty 500 for any value it can use (see Business Rules); don't send it. |
| dateTimeCreatedMax | string Fails with an empty 500 for any value it can use (see Business Rules); don't send it. |
| page | integer Default: 1 Example: page=1 Page number (default 1). |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25), with no upper limit. |
| pagination-page-size | integer Example: "1" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
[- {
- "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"
}
}
]Returns one file's record under file, and with the fileAttachments include, every record the file is attached
to.
fileID of a file attached only to records
outside those portfolios.fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.fileAttachments - every attachment of the file, an empty list when it has nonePOST /files/{fileID} - rename the file or change whether it can be attachedDELETE /files/{fileID} - delete the fileGET /files/{fileID}/download (undocumented) - the file itself| fileID required | integer Example: 60 The file, from |
| includes | string Example: includes=fileAttachments Comma-separated includes. One is available, |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
Array of objects (attachment) Every attachment of the file, an empty list when it has none. Requires the |
{- "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"
}
]
}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).
GET /files) without deleting itFiles › UpdateFile), checked
before anything else: a key without it gets the 403 whatever the body or ID.fileID of a file attached only to records
outside those portfolios.title and isAttachable are read; any other key in the body is ignored.{}, answers 400 invalid input..fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.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.GET /files/{fileID} - the file| fileID required | integer Example: 60 The file, from |
| includes | string Example: includes=fileAttachments
|
| title | string [ 1 .. 200 ] characters The name of the file shown to users; not empty or only spaces. |
| isAttachable | boolean or string or integer Enum: true false "true" "false" "1" "0" "yes" "no" 1 0 Whether the file can be attached to records and is listed by |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
Array of objects (attachment) Every attachment of the file, an empty list when it has none. Requires the |
{- "title": "Front door photo (cropped)",
- "isAttachable": false
}{- "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"
}
}Deletes a file: its record, every attachment of it, and the stored file. Returns the deleted file under file.
Files › UpdateFile), checked
before anything else: a key without it gets the 403 whatever the body or ID.fileID of a file attached only to records
outside those portfolios.fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.imageFileID becomes null).GET /files/{fileID} - the file and its attachments, to check before deleting| fileID required | integer Example: 60 The file, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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 |
{- "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"
}
}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.
orderIndex ascendingprimaryLeaseStatusID groups each status under one of three top-level states: Pending (1), Active (2), or Closed (3)POST /leases/{leaseID}/status - Update the status of a specific lease| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
[- {
- "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"
}
}
]Lists leases
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (lease) | |
object (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, |
[- {
- "lease": {
- "leaseID": "string",
- "propertyID": "string",
- "unitID": "string",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "string",
- "moveOutStatusID": "1",
- "assignedToUserID": "string",
- "applicationID": "string",
- "leaseDocumentTransactionID": "string",
- "code": "string",
- "tenants": [
- "string"
], - "moveInDate": "2019-08-24",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "tenantLiabilityInsuranceProviderID": "string",
- "tenantLiabilityInsuranceEffectiveDate": "2019-08-24",
- "rentersInsuranceCompany": "string",
- "rentersInsurancePolicyNumber": "string",
- "rentersInsuranceExpirationDate": "2019-08-24",
- "rentersInsuranceFileID": "string",
- "leaseFeeTransactionID": "string",
- "leaseFeeBillID": "string",
- "dateTimeCreated": "string",
- "lateFeeSettingID": "string",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isLateFeesActive": "0",
- "allowedPaymentAmountTypeID": "string",
- "isAchDisabled": "0",
- "isCreditCardDisabled": "0",
- "closedDate": "2019-08-24",
- "closedDescription": "string",
- "noticeDate": "2019-08-24",
- "expectedMoveOutDate": "2019-08-24",
- "moveOutDate": "2019-08-24",
- "depositRefundDueDate": "2019-08-24",
- "leaseReturnChargeAmount": "string",
- "moveOutReasonID": "string",
- "moveOutUnitAvailabilityDate": "2019-08-24",
- "moveOutTenantRemarks": "string",
- "moveOutLeaseTenantID": "string",
- "isLeaseAgreementViolated": "0",
- "forwardingName": "string",
- "forwardingCountryID": "string",
- "forwardingAddress": "string",
- "forwardingAddress2": "string",
- "forwardingCity": "string",
- "forwardingStateID": "string",
- "forwardingPostalCode": "string",
- "forwardingEmail": "string",
- "forwardingPhone": "string",
- "moveOutTenantReason": "string",
- "tenantRefundPayoutTypeID": "1",
- "isFromImport": "0",
- "importSourceKey": "string",
- "isTenantPastDueNoticeEnabled": "0",
- "rentvineInsuranceEnrollmentID": "string",
- "rentvineInsuranceEnrollmentStatusID": "string",
- "rentvineInsurancePackageID": "string",
- "rentvineInsuranceRecurringChargeID": "string",
- "rentvineInsuranceChargeID": "string",
- "isCertifiedFundsRequired": "0",
- "isCashDisabled": "0",
- "statementSettingID": "string",
- "sendStatements": "0",
- "leaseActivationOptionID": "string",
- "increaseEligibilityDate": "2019-08-24",
- "dateTimeModified": "string",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "0",
- "isMarkedToVacate": "0",
- "rentAmount": 1500
}, - "unit": {
- "unitID": "477",
- "propertyID": "502",
- "propertyImageID": "string",
- "isActive": "1",
- "name": "Unit A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt A",
- "stateID": "TX",
- "city": "Austin",
- "postalCode": "78701",
- "latitude": "30.2672",
- "longitude": "-97.7431",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "2500.00",
- "deposit": "2500.00",
- "size": "1100",
- "beds": "2",
- "fullBaths": "2",
- "halfBaths": "0",
- "leaseID": "995",
- "propertyManagerID": "14",
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "0",
- "filterDeliveryScheduleID": "string",
- "filterDeliveryAddressTypeID": "1",
- "filterDeliveryAddressID": "string",
- "dateTimeCreated": "2025-09-15 17:38:25",
- "dateTimeModified": "2026-03-12 12:29:52",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": null,
- "entryInstructions": null,
- "vendorEntryInstructions": null,
- "maintenanceNotes": null
}
}
]Creates a new lease with all associated entities: tenants, recurring charges, move-in charges, occupants, pets, emergency contacts, and vehicles.
Update Lease permission in RolesunitID must exist and be activetenants array is requiredapplicationID is provided, the application must exist and be in a compatible statechargeLeaseFee is true, both leaseFeeAmount and leaseFeeDatePosted must be providedGET /leases/{leaseID} and returns the full lease detailGET /leases - List leasesGET /leases/{leaseID} - Get lease detail (same shape as the response here)POST /leases/{leaseID} - Update leaserequired | object |
required | Array of objects non-empty Primary tenants on the lease. At least one is required. |
object Optional application status update when converting an application to a lease. | |
| residentPackageID | string or integer or null^-?[0-9]+$ REP package to enroll the lease in ( |
Array of objects À 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 | |
Array of objects Recurring charges (rent, pet fees, parking, etc.) to attach to the lease at creation. | |
Array of objects Additional recurring charges (utility fees, etc.) using a simplified structure without escalations. | |
Array of objects One-time move-in charges (security deposit, admin fee, etc.) posted when the lease is created. | |
Array of objects Co-signer tenants (guarantors) on the lease. | |
Array of objects Applicants from the linked application to convert to tenants. Only processed when | |
Array of objects Co-signer applicants from the linked application. Only processed when | |
Array of objects Non-tenant occupants (minors, roommates, etc.) listed on the lease. | |
| processPetsFromApplication | boolean Default: true When |
Array of objects Pets on the lease. Only used when | |
| processEmergencyContactsFromApplication | boolean Default: true When |
Array of objects Emergency contacts for the tenant. Only used when | |
| processVehiclesFromApplication | boolean Default: true When |
Array of objects Vehicles registered to the lease. Only used when | |
| sendPortalInvitations | boolean Default: false When |
| deactivateListing | boolean Default: false When |
| chargeLeaseFee | boolean Default: false When |
| leaseFeeAmount | string or number <decimal> Lease fee amount. Required when |
| leaseFeeDatePosted | string <date> Date to post the lease fee. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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"
}{- "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
}
}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.
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 → propertyportfolio → 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 → unitpropertyManager → propertyManager (requires unit)Lease meta
leaseStatus → leaseStatustenants → tenantsoccupants → occupantsvehicles → vehiclesemergencyContacts → emergencyContactsmoveOutContact → moveOutContact (null when none)application → application (only when the lease has an application)leaseDocumentTransaction → leaseDocumentTransactionstatementSetting → statementSetting (null when using the portfolio default)tenantAddresses → tenantAddressesPets
pets → pets, plus petScreeningEnabled, petscreeningData, noPetData when the lease has an applicationBilling & accounting
recurringCharges → recurringChargesleaseRecurringPayments → leaseRecurringPaymentsleaseRecurringCredits → leaseRecurringCreditsoutstandingCharges → outstandingChargesoutstandingCredits → outstandingCreditsoutstandingPayments → outstandingPaymentstransactions → transactionsrefundableTransactions → refundableTransactionsbalances → balanceslateFeeSetting → lateFeeSettingleaseFeeTransaction → leaseFeeTransactionleaseFeeBill → leaseFeeBillleaseFeeBillCharges → leaseFeeBillChargesRenewals
renewals → renewalsactiveRenewal → activeRenewal (the most recent in-progress renewal, or null)Insurance
tenantLiabilityInsuranceProvider → tenantLiabilityInsuranceProvider (null when none)tenantLiabilityInsurance → tenantLiabilityInsurancerentersInsuranceFile → 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| leaseID required | integer Example: 2213 |
| includes | string Example: includes=property,unit,tenants,residentPackage,residentServices 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease) |
object The lease's property. Requires | |
| portfolio | object The property's portfolio. Requires |
| postingSetting | object The portfolio's posting setting. Requires |
| operatingAccount | object The posting setting's operating account. Added alongside |
| portfolioOwners | Array of objects The portfolio's owners (each with their contact). Requires |
| chargesForPayment | Array of objects Unpaid charges available for payment, each wrapped as |
| previousPropertyPortfolio | object The property's prior (non-current) portfolio. Present only when one exists. Requires |
object The lease's unit. Requires | |
| propertyManager | object The unit's property manager. Requires |
object The lease's status record. Requires | |
Array of objects (tenant) The lease's tenants (each lease-tenant link joined to its contact). Requires | |
| occupants | Array of objects or null The lease's occupants. Requires |
| vehicles | Array of objects or null The lease's vehicles. Requires |
| emergencyContacts | Array of objects or null The lease's emergency contacts. Requires |
| moveOutContact | object or null The move-out contact, or null. Requires |
| application | object The originating rental application. Present only when the lease has an application. Requires |
| leaseDocumentTransaction | object The lease's e-sign document transaction. Requires |
| statementSetting | object or null The lease's statement-setting override, or null when using the portfolio default. Requires |
| tenantAddresses | Array of objects The lease's tenant mailing addresses. Requires |
| pets | Array of objects or null The lease's pets. Requires |
| petScreeningEnabled | boolean Whether pet screening is enabled for the lease's application. Added with |
| petscreeningData | object Pet-screening profile data for the application's applicants. Added with |
| noPetData | object No-pet acknowledgement data, when an applicant declared no pets. Added with |
| recurringCharges | Array of objects The lease's recurring charges. Requires |
| leaseRecurringPayments | Array of objects The lease's recurring payments (with payment method). Requires |
| leaseRecurringCredits | Array of objects The lease's recurring credits. Requires |
| outstandingCharges | Array of objects Outstanding charge transactions. Requires |
| outstandingCredits | Array of objects Outstanding credit transactions. Requires |
| outstandingPayments | Array of objects Outstanding payment transactions. Requires |
| transactions | Array of objects The lease's non-voided transactions, newest first. Requires |
| refundableTransactions | Array of objects Transactions eligible for refund. Requires |
| balances | object The lease's account balances as of today (account timezone). Requires |
| lateFeeSetting | object or null The lease's late-fee setting, or null. Requires |
| leaseFeeTransaction | object or null The lease-fee transaction, or null. Requires |
| leaseFeeBill | object or null The lease-fee bill, or null. Requires |
| leaseFeeBillCharges | Array of objects The lease-fee bill's charge transactions (empty when no bill). Requires |
| renewals | Array of objects The lease's renewals, each with a resolved |
| activeRenewal | object or null The most recent in-progress renewal, or null when none is active. Requires |
| tenantLiabilityInsuranceProvider | object or null The lease's TLL provider, or null. Requires |
| tenantLiabilityInsurance | object The lease's tenant liability insurance view. Requires |
| rentersInsuranceFile | object or null The uploaded proof-of-insurance file (non-system policies), or null. Requires |
| rentersInsuranceRequest | object or null A pending renters-insurance request, or null. Requires |
| tenantPolicyStatus | object or null System/provider policy status ( |
object The lease's one REP package enrollment ( | |
object The catalog package ( | |
Array of objects The lease's REP service entitlements ( |
{- "lease": {
- "leaseID": "string",
- "propertyID": "string",
- "unitID": "string",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "string",
- "moveOutStatusID": "1",
- "assignedToUserID": "string",
- "applicationID": "string",
- "leaseDocumentTransactionID": "string",
- "code": "string",
- "tenants": [
- "string"
], - "moveInDate": "2019-08-24",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "tenantLiabilityInsuranceProviderID": "string",
- "tenantLiabilityInsuranceEffectiveDate": "2019-08-24",
- "rentersInsuranceCompany": "string",
- "rentersInsurancePolicyNumber": "string",
- "rentersInsuranceExpirationDate": "2019-08-24",
- "rentersInsuranceFileID": "string",
- "leaseFeeTransactionID": "string",
- "leaseFeeBillID": "string",
- "dateTimeCreated": "string",
- "lateFeeSettingID": "string",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isLateFeesActive": "0",
- "allowedPaymentAmountTypeID": "string",
- "isAchDisabled": "0",
- "isCreditCardDisabled": "0",
- "closedDate": "2019-08-24",
- "closedDescription": "string",
- "noticeDate": "2019-08-24",
- "expectedMoveOutDate": "2019-08-24",
- "moveOutDate": "2019-08-24",
- "depositRefundDueDate": "2019-08-24",
- "leaseReturnChargeAmount": "string",
- "moveOutReasonID": "string",
- "moveOutUnitAvailabilityDate": "2019-08-24",
- "moveOutTenantRemarks": "string",
- "moveOutLeaseTenantID": "string",
- "isLeaseAgreementViolated": "0",
- "forwardingName": "string",
- "forwardingCountryID": "string",
- "forwardingAddress": "string",
- "forwardingAddress2": "string",
- "forwardingCity": "string",
- "forwardingStateID": "string",
- "forwardingPostalCode": "string",
- "forwardingEmail": "string",
- "forwardingPhone": "string",
- "moveOutTenantReason": "string",
- "tenantRefundPayoutTypeID": "1",
- "isFromImport": "0",
- "importSourceKey": "string",
- "isTenantPastDueNoticeEnabled": "0",
- "rentvineInsuranceEnrollmentID": "string",
- "rentvineInsuranceEnrollmentStatusID": "string",
- "rentvineInsurancePackageID": "string",
- "rentvineInsuranceRecurringChargeID": "string",
- "rentvineInsuranceChargeID": "string",
- "isCertifiedFundsRequired": "0",
- "isCashDisabled": "0",
- "statementSettingID": "string",
- "sendStatements": "0",
- "leaseActivationOptionID": "string",
- "increaseEligibilityDate": "2019-08-24",
- "dateTimeModified": "string",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "0",
- "isMarkedToVacate": "0",
- "rentAmount": 1500
}, - "property": {
- "propertyID": "502",
- "propertyImageID": "string",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "88",
- "managementFeeSettingID": "12",
- "name": "123 Main St",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": null,
- "stateID": "TX",
- "city": "Austin",
- "postalCode": "78701",
- "latitude": "30.2672",
- "longitude": "-97.7431",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Travis",
- "assignedToUserID": "131",
- "legalDescription": null,
- "maintenanceLimitAmount": "500.00",
- "yearBuilt": "1998",
- "dateInsuranceExpires": null,
- "dateWarrantyExpires": null,
- "maintenanceNotes": null,
- "applicationTemplateID": null,
- "reserveAmount": "300.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": "35.00",
- "defaultMonthToMonthPremiumSettingID": "string",
- "defaultResidentPackageID": "string",
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2025-09-15 17:38:25",
- "dateTimeModified": "2026-03-12 12:29:52",
- "dateTimeDeactivated": null,
- "deactivationReasonID": "1",
- "deactivationNotes": "string",
- "isFromImport": "0",
- "importSourceKey": null
}, - "portfolio": { },
- "postingSetting": { },
- "operatingAccount": { },
- "portfolioOwners": [
- { }
], - "chargesForPayment": [
- { }
], - "previousPropertyPortfolio": { },
- "unit": {
- "unitID": "477",
- "propertyID": "502",
- "propertyImageID": "string",
- "isActive": "1",
- "name": "Unit A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt A",
- "stateID": "TX",
- "city": "Austin",
- "postalCode": "78701",
- "latitude": "30.2672",
- "longitude": "-97.7431",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "2500.00",
- "deposit": "2500.00",
- "size": "1100",
- "beds": "2",
- "fullBaths": "2",
- "halfBaths": "0",
- "leaseID": "995",
- "propertyManagerID": "14",
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "0",
- "filterDeliveryScheduleID": "string",
- "filterDeliveryAddressTypeID": "1",
- "filterDeliveryAddressID": "string",
- "dateTimeCreated": "2025-09-15 17:38:25",
- "dateTimeModified": "2026-03-12 12:29:52",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": null,
- "entryInstructions": null,
- "vendorEntryInstructions": null,
- "maintenanceNotes": null
}, - "propertyManager": { },
- "leaseStatus": {
- "leaseStatusID": "1",
- "primaryLeaseStatusID": "1",
- "isSystemStatus": "1",
- "name": "Active",
- "isPendingMoveInStatus": "0",
- "isPendingMoveOutStatus": "0",
- "isCompletedMoveOutStatus": "0",
- "orderIndex": "1"
}, - "tenants": [
- {
- "leaseTenant": {
- "leaseTenantID": "41",
- "leaseID": "995",
- "contactID": "318",
- "isPrimary": "1",
- "isCosigner": "0",
- "isActive": "1",
- "moveInDate": "2026-04-04",
- "moveOutDate": null
}, - "contact": {
- "contactID": "318",
- "contactTypeID": "1",
- "name": "Donny Knight",
- "email": "donny@example.com",
- "phone": "5125550199",
- "birthDate": "1990-02-14",
- "applicantID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "identificationCountryID": "US",
- "taxIdentifierTruncated": "6789",
- "hasPortalAccess": 1,
- "hasPortalInvitation": 0,
- "invitationDateTimeCreated": null,
- "hasApplicantUser": 0
}
}
], - "occupants": [
- { }
], - "vehicles": [
- { }
], - "emergencyContacts": [
- { }
], - "moveOutContact": { },
- "application": { },
- "leaseDocumentTransaction": { },
- "statementSetting": { },
- "tenantAddresses": [
- { }
], - "pets": [
- { }
], - "petScreeningEnabled": true,
- "petscreeningData": { },
- "noPetData": { },
- "recurringCharges": [
- { }
], - "leaseRecurringPayments": [
- { }
], - "leaseRecurringCredits": [
- { }
], - "outstandingCharges": [
- { }
], - "outstandingCredits": [
- { }
], - "outstandingPayments": [
- { }
], - "transactions": [
- { }
], - "refundableTransactions": [
- { }
], - "balances": { },
- "lateFeeSetting": { },
- "leaseFeeTransaction": { },
- "leaseFeeBill": { },
- "leaseFeeBillCharges": [
- { }
], - "renewals": [
- { }
], - "activeRenewal": { },
- "tenantLiabilityInsuranceProvider": { },
- "tenantLiabilityInsurance": { },
- "rentersInsuranceFile": { },
- "rentersInsuranceRequest": { },
- "tenantPolicyStatus": { },
- "leaseResidentPackage": {
- "leaseResidentPackageID": "2",
- "leaseID": "995",
- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "1",
- "leaseRecurringChargeID": "3020",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentPackage": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}, - "residentServices": [
- {
- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}
]
}Updates an existing lease's details. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.
assignedToUserID)closedDate and closedDescription within the lease detailsUpdate Lease permission under the Leasing component400 is returned if not foundleaseStatusID is not updated by this endpoint; use POST /leases/{leaseID}/status to change statusGET /leases/{leaseID} - Get full lease detail (same response shape as returned here)POST /leases/{leaseID}/status - Update lease status onlyPOST /leases - Create a new lease| leaseID required | integer Example: 2213 |
| assignedToUserID | string or integer or null^-?[0-9]+$ ID of the user assigned to manage this lease. |
| leaseStatusID | string or integer or null^-?[0-9]+$ Lease status ID. Sent by the frontend but not applied by this endpoint — use |
| noticeDate | string or null <date> Date the tenant gave notice to vacate. |
| expectedMoveOutDate | string or null <date> Expected date the tenant will move out. |
| moveInDate | string or null <date> Tenant move-in date. |
| moveOutDate | string or null <date> Actual move-out date. |
| depositRefundDueDate | string or null <date> Date by which the security deposit refund is due. |
| closedDate | string or null <date> Date the lease was closed. Set along with |
| closedDescription | string or null Reason or notes recorded when the lease is closed. |
| startDate | string <date> Lease start date. |
| endDate | string or null <date> Lease end date. Omit or set null for month-to-month leases. |
| increaseEligibilityDate | string or null <date> Date after which the lease is eligible for a rent increase. |
| leaseReturnChargeAmount | string or number <decimal> Amount charged for returned payments (NSF fee). |
| lateFeeSettingID | string or integer or null^-?[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 or integer or null^-?[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 or integer Enum: "0" "1" 0 1 Whether past-due notice emails are sent for this lease (0 or 1). |
| statementSettingID | string or integer or null^-?[0-9]+$ Statement setting override for this lease. Null uses the portfolio default. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether statements are sent to tenants (0 or 1). |
| code | string or null Optional lease reference code. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease) |
{- "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"
}{- "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
}
}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.
Update Lease permission under the Leasing component400 is returned if not found400 is returned with "Cannot delete a lease that has accounting transactions" if any existGET /leases/{leaseID} - Get the lease detail before deletingPOST /leases/{leaseID}/status - Close or change lease status (for leases with transaction history)| leaseID required | integer Example: 2213 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease) |
{- "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"
}Updates the status of an existing lease. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.
Update Lease permission under the Leasing component400 is returned if not foundleaseStatusID is the only required field; all other fields are optional and will be updated only when providedleaseStatusID references custom statuses configured in the account (see GET /leases/statuses)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| leaseID required | integer Example: 2213 |
| leaseStatusID required | string or integer^-?[0-9]+$ ID of the custom lease status to assign. References the account-configured statuses from |
| noticeDate | string or null <date> Date the tenant gave notice to vacate. |
| expectedMoveOutDate | string or null <date> Expected date the tenant will move out. |
| moveOutDate | string or null <date> Actual date the tenant moved out. |
| depositRefundDueDate | string or null <date> Date by which the security deposit refund must be issued. |
| closedDate | string or null <date> Date the lease was closed. |
| closedDescription | string or null Optional description or reason for closing the lease. |
| isPortalPaymentDisabled | string or integer or null Enum: "0" "1" 0 1 null Whether portal payments are disabled for this lease (0 or 1). |
| isTenantPastDueNoticeEnabled | string or integer or null Enum: "0" "1" 0 1 null Whether past-due notices are sent to tenants (0 or 1). |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease) |
{- "leaseStatusID": 2
}{- "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
}
}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.
400 is returned otherwiseorderIndex, then by leaseTenantIDisActive is omitted, both active and inactive tenants are returnedPOST /leases/{leaseID}/tenants - Add a tenant to the leaseDELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease| leaseID required | integer Example: 2213 |
| isActive | integer Enum: 0 1 Example: isActive=1 Filter by active status. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
[- {
- "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
}
}
]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.
Update Lease permission under the Leasing component400 is returned otherwiseClosed status (primaryLeaseStatusID = 3)contactID is omitted or empty, a new contact is created using name (required), plus optional emails, phones, and addressescontactID is provided, the existing contact is linked directly — name, emails, phones, and addresses are ignoredTenant (contactTypeID = 2) and must be active400moveInDate is requiredGET /leases/{leaseID}/tenants - List all tenants on the leaseGET /leases/{leaseID}/tenants/{leaseTenantID} - Get a single tenant (same response shape returned here)DELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease| leaseID required | integer Example: 2213 |
| moveInDate required | string <date> Date the tenant moves in. Required. |
| name required | string Full name of the new tenant contact. Required when |
| contactID | string or integer or null^-?[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 |
Array of objects Email addresses to attach to the new tenant contact. Ignored when | |
Array of objects Phone numbers to attach to the new tenant contact. Ignored when | |
Array of objects Addresses to attach to the new tenant contact. Ignored when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The newly created lease tenant record. |
required | object The contact record for the tenant. |
{- "moveInDate": "2026-04-21",
- "isCosigner": 0,
- "name": "Testing Doc",
- "emails": [
- {
- "email": "testingdoc@email.com"
}
], - "phones": [
- {
- "phone": "+12399995555",
- "phoneTypeID": "1"
}
]
}{- "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
}
}Removes a tenant from a lease. On success, returns the deleted lease tenant record as it existed at time of deletion.
Update Lease permission under the Leasing component400 is returned otherwiseleaseTenantID must belong to the specified leaseID; a 400 is returned if the lease tenant is not found400 is returned if the lease has no active tenantsGET /leases/{leaseID}/tenants - List all tenants on the leaseGET /leases/{leaseID}/tenants/{leaseTenantID} - Get a single tenant detailPOST /leases/{leaseID}/tenants - Add a tenant to the lease| leaseID required | integer Example: 2213 |
| leaseTenantID required | integer Example: 3391 The |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| leaseTenantID required | string^-?[0-9]+$ Unique identifier for the lease tenant record. |
| leaseID required | string^-?[0-9]+$ ID of the lease this tenant belonged to. |
| contactID required | string^-?[0-9]+$ ID of the linked contact record. |
| isPrimary required | string Enum: "0" "1" Whether this tenant was the primary tenant on the lease ( |
| isCosigner required | string Enum: "0" "1" Whether this tenant was a co-signer ( |
| isActive required | string Enum: "0" "1" Active status at time of deletion ( |
| moveInDate | string or null <date> Date the tenant moved in. |
| moveOutDate | string or null <date> Date the tenant moved out. Null for active tenants. |
| orderIndex | string or null^-?[0-9]+$ Display order index for the tenant on the lease. |
{- "leaseTenantID": "3391",
- "leaseID": "2213",
- "contactID": "5246",
- "isPrimary": "0",
- "isCosigner": "0",
- "isActive": "1",
- "moveInDate": "2026-05-01",
- "moveOutDate": null,
- "orderIndex": "4"
}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.
400 is returned otherwiseaccount is always present in each list item — it cannot be excludedrecurringStatusID is not included in list items — use GET /leases/{leaseID}/recurring-charges/{chargeID} to get the computed status for a specific chargeGET /leases/{leaseID}/recurring-charges/{chargeID} - Get a single recurring charge with computed statusPOST /leases/{leaseID}/recurring-charges - Create a new recurring charge| leaseID required | integer Example: 2213 The lease whose recurring charges to list. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object (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. |
[- {
- "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
}
}
]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.
Update Lease permission under the Leasing component400 is returned otherwiseaccountID must reference a valid chart-of-account entry of a charge typestartDate is the date the charge appears on reports such as the Rent Roll; accepted as MM/DD/YYYYdayDue is the day of the month (1–31) on which recurring charge transactions are generatedfrequency 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 StatusGET /leases/{leaseID}/recurring-charges - List all recurring charges for the leaseGET /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 chargeDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete a recurring charge| leaseID required | integer Example: 2213 |
| dayDue required | string or integer [ 1 .. 31 ] ^-?[0-9]+$ Day of the month (1–31) on which charge transactions are generated. |
| frequency required | string or integer [ 1 .. 24 ] ^-?[0-9]+$ Default: "1" Number of months between charge occurrences. Use |
| accountID required | string or integer^-?[0-9]+$ ID of the chart-of-account entry to post the charge against. Must be a charge-type account. |
| amount required | string or number <decimal> Charge amount as a decimal string. |
| description required | string Label for the charge as it appears on statements and reports. |
| startDate required | string Date the charge begins appearing on reports such as the Rent Roll. Accepted format is |
| endDate | string or null Date the charge stops being generated. Accepted format is |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The newly created recurring charge. |
object or null The previous recurring charge on this lease (immediately before the new one), if any. Does not include |
{- "dayDue": 1,
- "frequency": 1,
- "accountID": "16",
- "amount": "1500.00",
- "description": "Monthly Rent",
- "startDate": "04/20/2027",
- "endDate": "04/12/2028"
}{- "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
}
}Returns a single recurring charge with its computed recurringStatusID and the previous charge on the lease (if one exists).
400 is returned otherwise400 is returnedaccount is only included when includes=account is passedGET /leases/{leaseID}/recurring-charges - List all recurring charges for the leasePOST /leases/{leaseID}/recurring-charges/{chargeID} - Update this recurring chargeDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge| leaseID required | integer Example: 2213 |
| chargeID required | integer Example: 11546 The |
| includes | string Example: includes=account Comma-separated list of related data to include in the response.
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object or null The previous recurring charge on this lease (highest |
object (account-2) The chart-of-accounts entry for this charge (if |
{- "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
}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.
Update Lease permission under the Leasing component400 is returned if either is not foundnull; omit a field to leave it unchangedstartDate and endDate are accepted as MM/DD/YYYY in the requestPOST /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 leaseDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge| leaseID required | integer Example: 2213 |
| chargeID required | integer Example: 12012 The |
| accountID | string or integer^-?[0-9]+$ ID of the chart-of-account entry to post the charge against. Must be a charge-type account. |
| amount | string or number <decimal> Charge amount as a decimal string. |
| description | string Label for the charge as it appears on statements and reports. |
| dayDue | string or integer^-?[0-9]+$ Day of the month (1–31) on which charge transactions are generated. |
| frequency | string or integer^-?[0-9]+$ Number of months between charge occurrences. Use |
| startDate | string Date the charge begins appearing on reports such as the Rent Roll. Accepted format is |
| endDate | string Date the charge stops being generated. Accepted format is |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The updated recurring charge. |
object or null The previous recurring charge on this lease (immediately before this one), if any. Does not include |
{- "amount": "120.00"
}{- "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
}
}Permanently deletes a recurring charge from a lease. On success, returns the deleted recurring charge record as it existed at time of deletion.
Update Lease permission under the Leasing component400 is returned if not foundPOST /leases/{leaseID}/recurring-charges/{chargeID} to set an endDate instead if you want to stop future postings while preserving historyGET /leases/{leaseID}/recurring-charges/{chargeID} - Get the charge detail before deletingGET /leases/{leaseID}/recurring-charges - List all recurring charges for the leasePOST /leases/{leaseID}/recurring-charges/{chargeID} - Update the charge (e.g. set an end date)| leaseID required | integer Example: 2213 |
| chargeID required | integer Example: 12012 The |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| leaseRecurringChargeID required | string^-?[0-9]+$ Unique identifier for the recurring charge. |
| leaseID required | string^-?[0-9]+$ ID of the lease this charge belonged to. |
| accountID required | string^-?[0-9]+$ Chart-of-account ID the charge posted against. |
| amount required | string <decimal> Charge amount as a decimal string. |
| description required | string Label for the charge as it appeared on statements and reports. |
| dayDue required | string^-?[0-9]+$ Day of the month on which charge transactions were generated. |
| frequency required | string^-?[0-9]+$ Number of months between charge occurrences. |
| startDate required | string <date> Date the charge began appearing on reports. |
| isMoveInCharge required | string Enum: "0" "1" Whether this charge was created as a move-in charge ( |
| isFromImport required | string Enum: "0" "1" Whether this charge was created via import ( |
| rentIncreaseID | string or null^-?[0-9]+$ ID of the rent increase that created this charge, if any. |
| endDate | string or null <date> Date the charge was scheduled to stop. Null means it was open-ended. |
| nextChargeDate | string or null <date> Next charge date at time of deletion. |
| importSourceKey | string or null Import source key if the charge came from an import, otherwise null. |
{- "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
}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.
Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.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.GET /leases/{leaseID}/pets/{leasePetID} - get one petPOST /leases/{leaseID}/pets - add a pet to the leaseGET /leases/{leaseID} - the lease| leaseID required | integer Example: 60 The lease, from |
| search | string Example: search=bisc Part of the pet's name, matched anywhere in it and in any case. |
| page | integer Default: 1 Example: page=1 Page number (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number, as requested (1 for |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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
|
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the search to every item. Carries no information about the pet. |
[- {
- "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"
}
]Adds a pet to the lease and returns it as GET /leases/{leaseID}/pets/{leasePetID} does, including any
includes the request asks for.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.{} 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.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.Pet Added entry, naming the pet's type and name, to the lease's history log.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.GET /leases/{leaseID}/pets - list the lease's petsPOST /leases/{leaseID}/pets/{leasePetID} - update a petGET /leases - find the lease| leaseID required | integer Example: 60 The lease to add the pet to, from |
| includes | string Example: includes=lease
|
| type required | string [ 1 .. 100 ] characters Kind of animal, free text ( |
| name | string or null <= 100 characters The pet's name. |
| age | string or integer or null >= 0 ^[0-9]+$ Age in whole years; digits only ( |
| weight | string or null <= 100 characters Weight, free text with its unit ( |
| color | string or null <= 100 characters Color, free text. |
| gender | string or null <= 100 characters Gender, free text. |
| hasShots | string or integer or boolean or null Whether the pet's vaccinations are current; the flag values above. Unlike the other flags, no check refuses
another number: |
| isTrained | string or integer or boolean or null Whether the pet is house-trained; the flag values above. |
| isNeutered | string or integer or boolean or null Whether the pet is spayed or neutered; the flag values above. |
| isDeclawed | string or integer or boolean or null Whether the pet is declawed; the flag values above. |
| isEmotionalSupportAnimal | string or integer or boolean or null Whether the pet is an emotional support animal; the flag values above. |
| isServiceAnimal | string or integer or boolean or null Whether the pet is a service animal; the flag values above. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "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
}{- "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
}
}Returns one of the lease's pets under pet, plus the lease under lease when the lease include is asked for.
Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.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.lease - the pet's lease, every column of the lease rowGET /leases/{leaseID}/pets - list the lease's petsPOST /leases/{leaseID}/pets/{leasePetID} - update the petDELETE /leases/{leaseID}/pets/{leasePetID} - remove the pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet, from |
| includes | string Example: includes=lease
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "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"
}
}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.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.{} answers 400 {"error": "invalid input."}.{"extraKey": "x"}) is accepted: 200, nothing changes.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.Pet Modified entry, listing the changes, to the lease's history log.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.GET /leases/{leaseID}/pets/{leasePetID} - get the petDELETE /leases/{leaseID}/pets/{leasePetID} - remove the petPOST /leases/{leaseID}/pets - add a pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet, from |
| includes | string Example: includes=lease
|
| type | string [ 1 .. 100 ] characters Kind of animal, free text ( |
| name | string or null <= 100 characters The pet's name. |
| age | string or integer or null >= 0 ^[0-9]+$ Age in whole years; digits only ( |
| weight | string or null <= 100 characters Weight, free text with its unit ( |
| color | string or null <= 100 characters Color, free text. |
| gender | string or null <= 100 characters Gender, free text. |
| hasShots | string or integer or boolean or null Whether the pet's vaccinations are current; the flag values above. Unlike the other flags, no check refuses
another number: |
| isTrained | string or integer or boolean or null Whether the pet is house-trained; the flag values above. |
| isNeutered | string or integer or boolean or null Whether the pet is spayed or neutered; the flag values above. |
| isDeclawed | string or integer or boolean or null Whether the pet is declawed; the flag values above. |
| isEmotionalSupportAnimal | string or integer or boolean or null Whether the pet is an emotional support animal; the flag values above. |
| isServiceAnimal | string or integer or boolean or null Whether the pet is a service animal; the flag values above. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "weight": "48 lbs",
- "isTrained": 0
}{- "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"
}
}Removes a pet from the lease for good and returns the removed pet as it was, without the pet wrapper the GET
uses.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.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.GET /leases/{leaseID}/pets.Pet Removed entry, naming the pet's type and name, to the lease's history log.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.GET /leases/{leaseID}/pets - list the lease's remaining petsPOST /leases/{leaseID}/pets - add a pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet to remove, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| leasePetID required | string^-?[0-9]+$ Unique identifier of the pet. |
| leaseID required | string^-?[0-9]+$ The lease the pet belongs to. |
| type required | string <= 100 characters Kind of animal, free text ( |
| name required | string or null <= 100 characters The pet's name. |
| age required | string or null^[0-9]+$ Age in whole years. |
| weight required | string or null <= 100 characters Weight, free text with its unit ( |
| isTrained required | string or null Enum: "0" "1" null Whether the pet is house-trained. |
| color required | string or null <= 100 characters Color, free text. |
| hasShots required | string or null^[0-9]+$ Whether the pet's vaccinations are current: |
| isNeutered required | string or null Enum: "0" "1" null Whether the pet is spayed or neutered. |
| isDeclawed required | string or null Enum: "0" "1" null Whether the pet is declawed. |
| isEmotionalSupportAnimal required | string or null Enum: "0" "1" null Whether the pet is an emotional support animal. |
| isServiceAnimal required | string or null Enum: "0" "1" null Whether the pet is a service animal. |
| gender required | string or null <= 100 characters Gender, free text. |
| dateTimeCreated required | string When the pet was added. UTC, formatted |
| petScreeningAnimalID required | string or null^-?[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; |
{- "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"
}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.
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.
400/Access Denied is returned otherwise.200 with both leaseResidentPackage and residentPackage set to null (not a 404).POST /leases/{leaseID}/resident-package — enroll the lease, or update its enrollmentGET /leases/{leaseID}/resident-services — the lease's service entitlements| leaseID required | integer Example: 995 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The enrollment row, or null when the lease isn't enrolled. |
required | object The catalog package the enrollment points to, or null when not enrolled. |
{- "leaseResidentPackage": {
- "leaseResidentPackageID": "2",
- "leaseID": "995",
- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "1",
- "leaseRecurringChargeID": "3020",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentPackage": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
leaseResidentPackageStatusID)The enrollment is never deleted — it's turned off and back on via its status:
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).leaseResidentPackageStatusID = 2) → stops the bundled recurring charge and cancels the
member services.leaseResidentPackageStatusID = 1 on a cancelled enrollment) → resumes the bundled
charge and reactivates the members.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.GET /leases/{leaseID}/resident-package and returns that shape.| leaseID required | integer Example: 995 |
| residentPackageID required | string or integer^-?[0-9]+$ The catalog package ( |
| leaseResidentPackageStatusID | string or integer Enum: "1" "2" 1 2 Enrollment status — |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object A lease's REP (Resident Experience Package) enrollment — a row in | |
object A REP (Resident Experience Package) package — a PM-built bundle in |
{- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "2"
}{- "leaseResidentPackage": {
- "leaseResidentPackageID": "2",
- "leaseID": "995",
- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "1",
- "leaseRecurringChargeID": "3020",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentPackage": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
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.
400/Access Denied is returned otherwise.POST /leases/{leaseID}/resident-services — add an à la carte service to the leaseGET /leases/{leaseID}/resident-services/{id} — a single entitlementGET /leases/{leaseID}/resident-package — the lease's package enrollment| leaseID required | integer Example: 995 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (lease_resident_service) A lease's REP service entitlement — a row in | |
object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
[- {
- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}
]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.
404 otherwise) and be within the user's accessible portfolios.residentServiceID must reference an active catalog service (resident_services).400
("provided by the lease's package… cannot be added separately"). Manage it through the package instead.GET /leases/{leaseID}/resident-services/{id} and returns that shape.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)| leaseID required | integer Example: 995 |
| residentServiceID required | string or integer^-?[0-9]+$ ID of the catalog service ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
{- "residentServiceID": "3"
}{- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
400/Access Denied is returned otherwise.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| leaseID required | integer Example: 995 |
| id required | integer Example: 7 The lease resident service (entitlement) id. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
{- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
leaseResidentServiceStatusID)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.1) → resumes the charge (or mints a fresh one if the prior charge was deleted).404 otherwise).residentPackageID) cannot be modified here —
returns 400 ("part of a package and cannot be modified directly"). Manage it through the package.GET /leases/{leaseID}/resident-services/{id} and returns that shape.| leaseID required | integer Example: 995 |
| id required | integer Example: 7 The lease resident service (entitlement) id. |
| leaseResidentServiceStatusID required | string or integer Enum: "1" "2" 1 2 New status — |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
{- "leaseResidentServiceStatusID": "2"
}{- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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}).
workOrderTemplateIDpropertyID is required; unitID and leaseID are optionaltechnicianContactIDs assigns one or more technician contacts to the work ordersendVendorNotification is true and a vendor is assigned, a notification email is dispatchedworkOrderTemplateID pre-populates fields from an existing template when suppliedMM/DD/YYYY or ISO 8601 YYYY-MM-DD formatGET /maintenance/work-orders/{workOrderID} - Get the created work orderGET /maintenance/work-orders - List all work ordersPOST /maintenance/work-orders/{workOrderID} - Update a work order| propertyID required | string or integer^-?[0-9]+$ Property the work order is attached to |
| workOrderStatusID required | string or integer^-?[0-9]+$ Initial status ID for the work order |
| priorityID required | string or integer^-?[0-9]+$
|
| isOwnerApproved required | string or integer Enum: "0" "1" 0 1 Whether the owner has approved the work order |
| isVacant required | string or integer Enum: "0" "1" 0 1 Whether the unit is vacant |
| description required | string Description of the maintenance issue (may contain HTML) |
| isSharedWithTenant required | string or integer Enum: "0" "1" 0 1
|
| isSharedWithOwner required | string or integer Enum: "0" "1" 0 1 Whether the work order is visible in the Owner Portal |
| unitID | string or integer or null^-?[0-9]+$ Unit the work order is attached to (null for property-level) |
| leaseID | string or integer or null^-?[0-9]+$ Lease associated with the work order |
| isInternal | string or integer Enum: "0" "1" 0 1
|
| vendorWorkOrderStatusID | string or integer or null^-?[0-9]+$ Vendor-specific status ID |
| vendorContactID | string or integer or null^-?[0-9]+$ Vendor contact ID to assign to the work order |
| vendorTradeID | string or integer or null^-?[0-9]+$ Vendor trade / maintenance category ID |
| assignedToUserID | string or integer or null^-?[0-9]+$ Internal user ID to assign to the work order |
| requestedByContactID | string or integer or null^-?[0-9]+$ Contact ID of the person who requested the work |
| technicianContactIDs | Array of strings One or more contact IDs to assign as technicians |
| estimatedAmount | string or number or null <decimal> Estimated cost as a decimal string (e.g. |
| scheduledStartDate | string or null Scheduled start date ( |
| scheduledEndDate | string or null Scheduled end date ( |
| actualStartDate | string or null <date> |
| actualEndDate | string or null <date> |
| dateDue | string or null Due date ( |
| dateClosed | string or null <date> |
| vendorInstructions | string or null HTML instructions for the assigned vendor |
| entryInstructions | string or null Entry instructions for the vendor |
| residentProvidedEntryInstructions | string or null |
| closingDescription | string or null |
| vendorAccessTypeID | string or integer or null^-?[0-9]+$
|
| appointmentWindowStartDateTime | string or null Date and time in UTC, formatted |
| appointmentWindowEndDateTime | string or null Date and time in UTC, formatted |
| inspectionID | string or integer or null^-?[0-9]+$ |
| incidentLocation | string or null |
| workOrderProjectID | string or integer or null^-?[0-9]+$ Project ID to attach this work order to |
| workOrderTemplateID | string or integer or null^-?[0-9]+$ Template ID to pre-populate work order fields |
| orderIndex | string or integer or null^-?[0-9]+$ |
| sourceTypeID | string or integer or null^-?[0-9]+$ |
| isTenantFinanciallyResponsible | string or integer or null Enum: "0" "1" 0 1 null
|
| sendVendorNotification | boolean Default: true Whether to send a notification email to the assigned vendor |
| sendEmail | boolean or null Whether to send an email notification (separate from vendor notification) |
object or null Custom email content for the vendor notification | |
| attachments | Array of integers File IDs to attach to the work order |
| issueImages | Array of integers File IDs to attach as issue images (shared with vendor) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (work_order) |
| schedulingStatusID required | integer or null |
{- "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": "<p>Call tenant before arriving.</p>",
- "technicianContactIDs": [
- "5150"
], - "sendVendorNotification": true,
- "vendorAccessTypeID": "1",
- "attachments": [ ],
- "issueImages": [ ]
}{- "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": "<p>Instructions</p>",
- "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
}Retrieve a paginated list of work orders with their assigned vendor contact. Supports filtering by property, unit, status, vendor, date range, and more.
GET /maintenance/work-orders/{workOrderID} - Get full work order details with includesPOST /maintenance/work-orders - Create a work orderGET /maintenance/work-order/statuses - Get available work order statuses| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 15 Number of items per page |
| search | string Example: search=leaky faucet Free-text search across work order fields (description, work order number, etc.) |
| propertyID | integer Example: propertyID=100 Filter by property ID |
| unitID | integer Example: unitID=250 Filter by unit ID |
| workOrderStatusID | integer Example: workOrderStatusID=1 Filter by work order status ID. See Work Order Statuses for available values. |
| isOwnerApproved | integer Enum: 0 1 Filter by owner approval state ( |
| vendorContactID | integer Example: vendorContactID=7001 Filter by assigned vendor contact ID |
| startDate | string <date> Example: startDate=2024-01-01 Filter work orders created on or after this date ( |
| endDate | string <date> Example: endDate=2024-12-31 Filter work orders created on or before this date ( |
| leaseID | integer Example: leaseID=1500 Filter by associated lease ID |
| isNew | integer Enum: 0 1 Example: isNew=1 Filter to only unacknowledged ( |
| pagination-page-size | string Example: "15" Number of items per page |
| pagination-total-items | integer Example: "42" Total number of matching items |
| pagination-total-pages | integer Example: "3" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number (null if on the last page) |
| pagination-before-page | integer or null Previous page number (null if on the first page) |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "3" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (work_order) |
required | contact (object) or null Vendor contact assigned to the work order. All fields are |
[- {
- "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": "<p>Water damage on ceiling in living room</p>",
- "diagnosticSummary": null,
- "aiSessionID": null,
- "isResolvedByRequestor": "0",
- "vendorInstructions": "<p>Call before arriving</p>",
- "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
}
}
]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.
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.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.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.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.1/0/true/false/yes/no in any letter case, an ID that isn't a number).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.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.orderBy (default workOrder.dateTimeCreated|desc, newest first), then workOrderID ascending.null.dateTimeModifiedMin[]=2026-01-01) fails with a 500.GET /maintenance/work-orders - the plain work order list, without the modified-date filtersGET /maintenance/work-orders/{workOrderID} - one work order, with includesGET /properties - property IDs for propertyIDGET /leases - lease IDs for leaseIDGET /vendors - vendor contact IDs for vendorContactID| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=100 Items per page (default 25). No cap today; a cap is planned, so don't rely on very large pages. |
| orderBy | string Example: orderBy=workOrder.dateTimeModified|desc Sort column, optionally followed by Columns: |
| dateTimeModifiedMin | string <date> Example: dateTimeModifiedMin=2026-01-01 Only work orders last modified on or after midnight UTC of this date ( |
| dateTimeModifiedMax | string <date> Example: dateTimeModifiedMax=2026-01-31 Only work orders last modified on or before midnight UTC of this date ( |
| search | string Example: search=leak 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 | integer Example: propertyID=30 Only this property's work orders (from |
| unitID | integer Example: unitID=15 Only this unit's work orders (unit IDs from |
| leaseID | integer Example: leaseID=9 Only the work orders linked to this lease (from |
| vendorContactID | integer Example: vendorContactID=18 Only the work orders assigned to this vendor (from |
| isOwnerApproved | string Example: isOwnerApproved=1
|
| isNew | string Example: isNew=1
|
| pagination-page-size | integer Example: "2" When some work orders match, the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The work order, with values the search computes. |
required | object The work order's status. |
required | object The work order's type. Every key is |
required | object The portfolio the work order belongs to. |
required | object The work order's property. |
required | object The work order's unit. Every key is |
required | object (work_order_search_contact) A contact on a work order search row, its vendor ( |
required | object (work_order_search_contact) A contact on a work order search row, its vendor ( |
required | object The work order's vendor trade (maintenance category). Every key is |
required | object The property groups the work order's property is in. |
[- {
- "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"
}
}
]Retrieve detailed information about a specific work order by ID, including computed overdue status and assigned technician data.
400 with "Work Order {id} not found" if the work order does not exist403 "Work Order Access Not Allowed"daysOverdue and isOverdue are calculated dynamically from dateDue and today's dateGET /maintenance/work-orders - List work ordersPOST /maintenance/work-orders/{workOrderID} - Update work orderDELETE /maintenance/work-orders/{workOrderID} - Delete work orderGET /maintenance/work-orders/{workOrderID}/print - Print work order PDF| workOrderID required | integer Example: 2314 The unique work order ID |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
| schedulingStatusID required | integer or null |
{- "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": "<p>leaky faucet</p>",
- "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
}Update an existing work order. Supports updating all work order fields including status, assignment, scheduling, and shared visibility settings.
GET /maintenance/work-orders/{workOrderID} - View work orderDELETE /maintenance/work-orders/{workOrderID} - Delete work order| workOrderID required | integer Example: 12345 The unique work order ID to update |
| isInternal | string or integer Enum: "0" "1" 0 1 Internal work order flag (0=no, 1=yes) |
| propertyID | string or integer^-?[0-9]+$ Property ID |
| unitID | string or integer or null^-?[0-9]+$ Unit ID (null for property-level) |
| leaseID | string or integer or null^-?[0-9]+$ Associated lease ID |
| vendorTradeID | string or integer or null^-?[0-9]+$ Vendor trade/specialty |
| vendorContactID | string or integer or null^-?[0-9]+$ Assigned vendor contact ID |
| workOrderStatusID | string or integer^-?[0-9]+$ Work order status |
| vendorWorkOrderStatusID | string or integer or null^-?[0-9]+$ Vendor-specific status |
| priorityID | string or integer^-?[0-9]+$ Priority (1=Low, 2=Normal, 3=High, 4=Emergency) |
| sourceTypeID | string or integer^-?[0-9]+$ Work order source/origin |
| isOwnerApproved | string or integer Enum: "0" "1" 0 1 Owner approval (0=pending, 1=approved) |
| isVacant | string or integer Enum: "0" "1" 0 1 Vacant unit flag |
| assignedToUserID | string or integer or null^-?[0-9]+$ Assigned internal user |
| requestedByContactID | string or integer or null^-?[0-9]+$ Contact who requested work |
| estimatedAmount | string or number or null <decimal> Estimated cost |
| scheduledStartDate | string or null <date> Scheduled start date |
| actualStartDate | string or null <date> Actual start date |
| scheduledEndDate | string or null <date> Scheduled end date |
| actualEndDate | string or null <date> Actual end date |
| dateDue | string or null <date> Due date |
| dateClosed | string or null <date> Closed date |
| description | string Work order description/issue |
| vendorInstructions | string or null Instructions for vendor |
| closingDescription | string or null Closing notes/resolution |
| isSharedWithOwner | string or integer Enum: "0" "1" 0 1 Share with owner portal (0=no, 1=yes) |
| isSharedWithTenant | string or integer Enum: "0" "1" 0 1 Share with resident portal (0=no, 1=yes) |
| inspectionID | string or integer or null^-?[0-9]+$ Related inspection ID |
| incidentLocation | string or null Location within property |
| workOrderProjectID | string or integer or null^-?[0-9]+$ Parent project ID |
| orderIndex | string or integer^-?[0-9]+$ Display order |
| vendorAccessTypeID | string or integer or null^-?[0-9]+$ Access type for vendor |
| residentProvidedEntryInstructions | string or null Entry instructions from tenant |
| entryInstructions | string or null Entry instructions for vendor |
| isTenantFinanciallyResponsible | string or integer Enum: "0" "1" 0 1 Tenant pays for work (0=no, 1=yes) |
| appointmentWindowStartDateTime | string or null Appointment window start. UTC, formatted |
| appointmentWindowEndDateTime | string or null Appointment window end. UTC, formatted |
| sendVendorNotification | boolean Default: true Send notification to vendor on changes |
| sendReview | boolean Default: false Send review request on completion |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| workOrder | object Updated work order details (same structure as GET response) |
{- "workOrderStatusID": 2,
- "sendVendorNotification": false
}{- "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"
}
}Delete a work order. This operation removes the work order and all associated data including attachments, messages, and timeline events.
GET /maintenance/work-orders/{workOrderID} - View work orderGET /maintenance/work-orders - View work orders| workOrderID required | string Example: 12345 The unique work order ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| workOrderID | string^-?[0-9]+$ |
| workOrderNumber | string^-?[0-9]+$ |
| description | string |
| dateTimeCreated | string Date and time in UTC, formatted |
| dateTimeModified | string Date and time in UTC, formatted |
{- "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"
}Generate and download a PDF version of the specified work order. The response is a binary PDF document suitable for printing or archiving.
400 with "Work Order not found" if the work order does not existGET /maintenance/work-orders/{workOrderID} - Get work order details as JSON| workOrderID required | integer Example: 2314 The unique work order ID to print |
| Cache-Control | string Example: "no-cache" Cache directive (always |
| Content-Type | string Example: "application/pdf" MIME type of the response body |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
{- "error": "Work Order not found"
}| primaryWorkOrderStatusID required | string or integer (primary_statuses_request) Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
|
| name required | string The name of the status |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| primaryWorkOrderStatusID required | string or integer (primary_statuses_request) Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
|
| name required | string The name of the status |
| workOrderStatusID required | string^-?[0-9]+$ |
| isSystemStatus required | string Enum: "0" "1" Indicates if the status is one of the 7 system statuses ( |
| orderIndex | string^-?[0-9]+$ |
{- "primaryWorkOrderStatusID": "1",
- "name": "string"
}{- "primaryWorkOrderStatusID": "1",
- "name": "string",
- "workOrderStatusID": "string",
- "isSystemStatus": "0",
- "orderIndex": "string"
}Retrieve all work order statuses available in the account, including both system statuses and any custom statuses created by the account.
isSystemStatus = 1) and custom account statuses (isSystemStatus = 0)Open, Completed, Cancelled, Requested, On Hold, Estimating, RejectedGET /maintenance/work-order/statuses/{workOrderStatusID} - Get a specific status by IDPOST /maintenance/work-order/statuses - Create or update a custom status| search | string Example: search=open Free-text search on status name |
| isSystemStatus | integer Enum: 0 1 Example: isSystemStatus=1 Filter to system statuses only ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (work_order_status) |
[- {
- "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"
}
}
]Retrieve a single work order status by its ID. Returns both system statuses and custom account statuses.
400 with "Work Order Status {id} not found" if the status does not existGET /maintenance/work-order/statuses - List all work order statusesPOST /maintenance/work-order/statuses/{workOrderStatusID} - Update a custom statusDELETE /maintenance/work-order/statuses/{workOrderStatusID} - Delete a custom status| workOrderStatusID required | integer Example: 5 The unique work order status ID |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (work_order_status) |
{- "workOrderStatus": {
- "workOrderStatusID": "5",
- "primaryWorkOrderStatusID": "4",
- "isSystemStatus": "1",
- "name": "On Hold",
- "orderIndex": "14"
}
}Delete a custom work order status. Only custom statuses (those with isSystemStatus = 0) can be deleted; system statuses are protected.
Manage Work Order Statuses permission400 with "Work Order Status {id} not found" if the status does not existisSystemStatus = 1) cannot be deleted via this endpointGET /maintenance/work-order/statuses - List all statusesGET /maintenance/work-order/statuses/{workOrderStatusID} - Get a status by ID| workOrderStatusID required | integer Example: 9 The unique work order status ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| workOrderStatusID required | string^-?[0-9]+$ |
| primaryWorkOrderStatusID required | string^-?[0-9]+$ |
| isSystemStatus required | string Enum: "0" "1" |
| name required | string |
| orderIndex required | string^-?[0-9]+$ |
{- "workOrderStatusID": "9",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "0",
- "name": "Tech Completed",
- "orderIndex": "1"
}Update an existing custom work order status by ID.
400 with "Work Order Status {id} not found" if the status does not existworkOrderStatusprimaryWorkOrderStatusID cannot be modifiedGET /maintenance/work-order/statuses/{workOrderStatusID} - Get status by IDDELETE /maintenance/work-order/statuses/{workOrderStatusID} - Delete a custom statusGET /maintenance/work-order/statuses - List all statuses| workOrderStatusID required | integer Example: 9 The unique work order status ID to update |
| name required | string Display name for the custom status |
| primaryWorkOrderStatusID required | string or integer Enum: "1" "2" "3" "4" "5" 1 2 3 4 5 The primary status group this custom status belongs to.
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (work_order_status) |
{- "name": "Tech Completed",
- "primaryWorkOrderStatusID": 2
}{- "workOrderStatus": {
- "workOrderStatusID": "9",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "0",
- "name": "Tech Completed",
- "orderIndex": "1"
}
}| name required | string Name of the vendor trade |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Indicates whether the trade is visible to the resident when they are creating work orders. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| vendorTradeID required | string^-?[0-9]+$ |
| name required | string Name of the vendor trade |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Indicates whether the trade is visible to the resident when they are creating work orders. |
{- "name": "string",
- "isVisibleTenantPortal": "0"
}{- "vendorTradeID": "string",
- "name": "string",
- "isVisibleTenantPortal": "0"
}List vendor trades
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| vendorTradeID required | string^-?[0-9]+$ |
| name required | string Name of the vendor trade |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Indicates whether the trade is visible to the resident when they are creating work orders. |
[- {
- "vendorTradeID": "string",
- "name": "string",
- "isVisibleTenantPortal": "0"
}
]Retrieve a single vendor trade (maintenance category) by ID.
vendors includecontact)GET /maintenance/vendor-trades - List all vendor tradesPOST /maintenance/vendor-trades/{vendorTradeID} - Update a vendor trade| vendorTradeID required | integer Example: 5 The unique vendor trade ID |
| includes | string Example: includes=vendors Comma-separated list of related objects. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (vendor_trade) |
| vendors | Array of objects Vendor contacts assigned to this trade (if |
{- "vendorTrade": {
- "vendorTradeID": "5",
- "name": "Plumbing",
- "isVisibleTenantPortal": "1"
}
}Update an existing vendor trade (maintenance category). Requires the ManageMaintenanceCategories permission.
400 with "Maintenance Category {id} not found" if the trade does not existvendorTradeGET /maintenance/vendor-trades/{vendorTradeID} - Get vendor trade detailsDELETE /maintenance/vendor-trades/{vendorTradeID} - Delete a vendor tradeGET /maintenance/vendor-trades - List all vendor trades| vendorTradeID required | integer Example: 5 The unique vendor trade ID to update |
| name required | string Name of the vendor trade / maintenance category |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Whether residents can select this trade when submitting work orders via the Resident Portal |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (vendor_trade) |
{- "name": "Plumbing",
- "isVisibleTenantPortal": "1"
}{- "vendorTrade": {
- "vendorTradeID": "5",
- "name": "Plumbing",
- "isVisibleTenantPortal": "1"
}
}| unitID required | string or integer (unit_id_required) ^-?[0-9]+$ The unique id of the Unit object. See the Unit API for more information. |
| inspectionTypeID required | string or integer (inspection_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| inspectionStatusID required | string or integer (inspection_statuses_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| description | string or null |
| scheduledDate | string or null <date> |
| inspectionDate | string or null <date> |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| inspectionID required | string^-?[0-9]+$ |
| propertyID required | string^-?[0-9]+$ |
| dateTimeCreated required | string <date> |
| unitID required | string or integer (unit_id_required) ^-?[0-9]+$ The unique id of the Unit object. See the Unit API for more information. |
| inspectionTypeID required | string or integer (inspection_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| inspectionStatusID required | string or integer (inspection_statuses_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| leaseID | string or null^-?[0-9]+$ |
| assignedToUserID | string or null (assigned_to_user_id) ^-?[0-9]+$ The Rentvine user id of the user assigned to object. |
| description | string or null |
| scheduledDate | string or null <date> |
| inspectionDate | string or null <date> |
{- "unitID": "string",
- "inspectionTypeID": "1",
- "inspectionStatusID": "1",
- "description": "string",
- "scheduledDate": "2019-08-24",
- "inspectionDate": "2019-08-24"
}{- "inspectionID": "string",
- "propertyID": "string",
- "leaseID": "string",
- "assignedToUserID": "string",
- "dateTimeCreated": "2019-08-24",
- "unitID": "string",
- "inspectionTypeID": "1",
- "inspectionStatusID": "1",
- "description": "string",
- "scheduledDate": "2019-08-24",
- "inspectionDate": "2019-08-24"
}List of inspections
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 15 Number of items per page |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| inspectionID required | string^-?[0-9]+$ |
| propertyID required | string^-?[0-9]+$ |
| dateTimeCreated required | string <date> |
| unitID required | string or integer (unit_id_required) ^-?[0-9]+$ The unique id of the Unit object. See the Unit API for more information. |
| inspectionTypeID required | string or integer (inspection_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| inspectionStatusID required | string or integer (inspection_statuses_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| leaseID | string or null^-?[0-9]+$ |
| assignedToUserID | string or null (assigned_to_user_id) ^-?[0-9]+$ The Rentvine user id of the user assigned to object. |
| description | string or null |
| scheduledDate | string or null <date> |
| inspectionDate | string or null <date> |
[- {
- "inspectionID": "string",
- "propertyID": "string",
- "leaseID": "string",
- "assignedToUserID": "string",
- "dateTimeCreated": "2019-08-24",
- "unitID": "string",
- "inspectionTypeID": "1",
- "inspectionStatusID": "1",
- "description": "string",
- "scheduledDate": "2019-08-24",
- "inspectionDate": "2019-08-24"
}
]View inspection
| inspectionID required | integer |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| inspectionID required | string^-?[0-9]+$ |
| propertyID required | string^-?[0-9]+$ |
| dateTimeCreated required | string <date> |
| unitID required | string or integer (unit_id_required) ^-?[0-9]+$ The unique id of the Unit object. See the Unit API for more information. |
| inspectionTypeID required | string or integer (inspection_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| inspectionStatusID required | string or integer (inspection_statuses_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| leaseID | string or null^-?[0-9]+$ |
| assignedToUserID | string or null (assigned_to_user_id) ^-?[0-9]+$ The Rentvine user id of the user assigned to object. |
| description | string or null |
| scheduledDate | string or null <date> |
| inspectionDate | string or null <date> |
{- "inspectionID": "string",
- "propertyID": "string",
- "leaseID": "string",
- "assignedToUserID": "string",
- "dateTimeCreated": "2019-08-24",
- "unitID": "string",
- "inspectionTypeID": "1",
- "inspectionStatusID": "1",
- "description": "string",
- "scheduledDate": "2019-08-24",
- "inspectionDate": "2019-08-24"
}Returns a paginated list of inventory materials available for use on work orders.
search matches against name, description, and upc fieldsisActive defaults to all active materials when omittedGET /maintenance/materials/{materialID} — retrieve a single material with file detailPOST /maintenance/materials — create a new materialPOST /maintenance/materials/{materialID} — update an existing materialDELETE /maintenance/materials/{materialID} — delete a material| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=100 Number of results per page. Defaults to 25. |
| search | string Example: search=Drywall Full-text search against material name, description, and UPC |
| isActive | integer Enum: 0 1 Example: isActive=1 Filter by active status. |
| purchasePriceMin | number Example: purchasePriceMin=5 Filter materials with a purchase price at or above this value |
| purchasePriceMax | number Example: purchasePriceMax=500 Filter materials with a purchase price at or below this value |
| sellPriceMin | number Example: sellPriceMin=10 Filter materials with a sell price at or above this value |
| sellPriceMax | number Example: sellPriceMax=1000 Filter materials with a sell price at or below this value |
| orderBy | string Example: orderBy=material.name Sort field in dot-notation. Prefix with |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "42" Total number of items across all pages |
| pagination-total-pages | integer Example: "2" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "2" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (material) Fields accepted when creating or updating a maintenance material (inventory item).
Only |
[- {
- "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
}
}
]Creates a new maintenance material in the inventory catalog. On success, returns the full material
detail (same shape as GET /maintenance/materials/{materialID}).
name and sellPrice are the only required fieldsisActive defaults to 1 (active) when not suppliedname must be unique among non-deleted materials (max 200 characters)purchasePrice and sellPrice must be valid decimal amountsGET /maintenance/materials — list all materialsGET /maintenance/materials/{materialID} — retrieve the created materialPOST /maintenance/materials/{materialID} — update an existing material| name required | string <= 200 characters Display name of the material |
| sellPrice required | string or number <decimal> Price charged when the material is used on a work order (decimal as string) |
| description | string or null <= 4000 characters Optional description or supplier note |
| isActive | string or integer Default: "1" Enum: "0" "1" 0 1 Active status. |
| upc | string or null Universal Product Code |
| purchasePrice | string or number or null <decimal> Cost to purchase the material (decimal as string) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (material) Fields accepted when creating or updating a maintenance material (inventory item).
Only |
{- "name": "New Item Name",
- "sellPrice": "12.00"
}{- "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"
}
}Retrieves a single maintenance material by ID
400 with "Material {id} not found" if the material does not exist or has been deletedGET /maintenance/materials — list all materialsPOST /maintenance/materials/{materialID} — update this materialDELETE /maintenance/materials/{materialID} — delete this material| materialID required | integer Example: 8 The unique material ID |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (material) Fields accepted when creating or updating a maintenance material (inventory item).
Only |
required | object Image file associated with the material, if any |
{- "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
}
}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.
400 with "Material {id} not found" if the material does not existname must remain unique among non-deleted materials if changedpurchasePrice and sellPrice must be valid decimal amounts when suppliedGET /maintenance/materials/{materialID} — retrieve current material stateGET /maintenance/materials — list all materialsDELETE /maintenance/materials/{materialID} — delete this material| materialID required | integer Example: 13 The unique material ID |
| name | string <= 200 characters Display name of the material |
| description | string or null <= 4000 characters Optional description or supplier note |
| isActive | string or integer Enum: "0" "1" 0 1 Active status. |
| upc | string or null Universal Product Code |
| purchasePrice | string or number or null <decimal> Cost to purchase the material (decimal as string) |
| sellPrice | string or number <decimal> Price charged when the material is used on a work order |
| imageFileID | string or integer or null^-?[0-9]+$ File ID of an associated image |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (material) Fields accepted when creating or updating a maintenance material (inventory item).
Only |
{- "sellPrice": "10.00"
}{- "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"
}
}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.
400 with "Material {id} not found" if the material does not exist\GET /maintenance/materials list resultsGET /maintenance/materials — list active materialsPOST /maintenance/materials — create a replacement material| materialID required | integer Example: 13 The unique material ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| materialID required | string^-?[0-9]+$ Unique identifier for the material |
| name required | string Display name of the material |
| isDeleted required | integer Value: 1 Soft-delete flag. Always |
| dateTimeCreated required | string Timestamp when the material was created. UTC, formatted |
| dateTimeModified required | string Timestamp of the delete operation. UTC, formatted |
| description | string or null Optional description or supplier note |
| isActive | string Enum: "0" "1" Active status |
| upc | string or null Universal Product Code |
| purchasePrice | string or null <decimal> Cost to purchase the material |
| sellPrice | string <decimal> Price charged when the material is used on a work order |
| imageFileID | string or null^-?[0-9]+$ File ID of the associated image |
{- "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
}Returns a paginated list of maintenance labor rates. Supports full-text search and rate-range filtering. Results exclude soft-deleted records by default.
search matches against the name fieldGET /maintenance/labor-rates/{laborRateID} — retrieve a single labor ratePOST /maintenance/labor-rates — create a new labor ratePOST /maintenance/labor-rates/{laborRateID} — update an existing labor rateDELETE /maintenance/labor-rates/{laborRateID} — delete a labor rate| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=15 Number of results per page. Defaults to 25. |
| search | string Example: search=Jake Full-text search against labor rate name |
| laborRateID | integer Example: laborRateID=7 Filter to a specific labor rate by ID |
| laborRateIDs | string Example: laborRateIDs=2,4,7 Filter to a set of labor rate IDs (comma-separated) |
| rateMin | number Example: rateMin=10 Filter labor rates with a rate at or above this value |
| rateMax | number Example: rateMax=100 Filter labor rates with a rate at or below this value |
| isDeleted | integer Default: 0 Enum: 0 1 Filter by deleted status. Defaults to |
| orderBy | string Example: orderBy=laborRate.name Sort field in dot-notation. Prefix with |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "7" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (labor_rate) Fields accepted when creating or updating a maintenance labor rate.
|
[- {
- "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"
}
}
]Creates a new maintenance labor rate. On success, returns the created labor rate as a flat object.
name, rate, and hourlyRate are required; description is optionalname must be unique among non-deleted labor ratesrate and hourlyRate must be non-negative decimal amounts; zero is allowedGET /maintenance/labor-rates — list all labor ratesGET /maintenance/labor-rates/{laborRateID} — retrieve the created labor ratePOST /maintenance/labor-rates/{laborRateID} — update an existing labor rate| name required | string Display name of the labor rate |
| rate required | string or number <decimal> Rate charged to Owner for this labor type (decimal as string). Zero is allowed. |
| hourlyRate required | string or number or null <decimal> The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. |
| description | string or null Optional description of the labor rate |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| name required | string Display name of the labor rate |
| rate required | string or number <decimal> Rate charged to Owner for this labor type (decimal as string). Zero is allowed. |
| hourlyRate required | string or number or null <decimal> The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. |
| laborRateID required | string^-?[0-9]+$ Unique identifier for the labor rate |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
| description | string or null Optional description of the labor rate |
| isDeleted | string Enum: "0" "1" Makes the labor rate Non-Billable |
{- "name": "New Labor Item",
- "rate": "5.00"
}{- "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"
}Retrieves a single maintenance labor rate by ID. Returns a flat object (no wrapper key).
400 with "Labor Rate {id} not found" if the labor rate does not existGET /maintenance/labor-rates — list all labor ratesPOST /maintenance/labor-rates/{laborRateID} — update this labor rateDELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate| laborRateID required | integer Example: 7 The unique labor rate ID |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| name required | string Display name of the labor rate |
| rate required | string or number <decimal> Rate charged to Owner for this labor type (decimal as string). Zero is allowed. |
| hourlyRate required | string or number or null <decimal> The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. |
| laborRateID required | string^-?[0-9]+$ Unique identifier for the labor rate |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
| description | string or null Optional description of the labor rate |
| isDeleted | string Enum: "0" "1" Makes the labor rate Non-Billable |
{- "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"
}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.
400 with "Labor Rate {id} not found" if the labor rate does not existname must remain unique among non-deleted labor rates if changedrate and hourlyRate must be non-negative decimal amounts when supplied; zero is allowedlaborRateID, dateTimeCreated, and dateTimeModified in the request body are accepted but ignoredGET /maintenance/labor-rates/{laborRateID} — retrieve current labor rate stateGET /maintenance/labor-rates — list all labor ratesDELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate| laborRateID required | integer Example: 7 The unique labor rate ID |
| name | string <= 200 characters Display name of the labor rate |
| description | string or null <= 4000 characters Optional description |
| rate | string or number <decimal> Flat rate charged (decimal as string). Zero is allowed. |
| hourlyRate | string or number or null <decimal> Hourly cost rate (decimal as string). Zero is allowed. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| name required | string Display name of the labor rate |
| rate required | string or number <decimal> Rate charged to Owner for this labor type (decimal as string). Zero is allowed. |
| hourlyRate required | string or number or null <decimal> The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. |
| laborRateID required | string^-?[0-9]+$ Unique identifier for the labor rate |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
| description | string or null Optional description of the labor rate |
| isDeleted | string Enum: "0" "1" Makes the labor rate Non-Billable |
{- "rate": "0.00"
}{- "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"
}Deletes a labor rate from the catalog. The record is removed from the database. Returns a success confirmation.
400 with "Labor Rate {id} not found" if the labor rate does not existGET /maintenance/labor-rates by defaultGET /maintenance/labor-rates — list active labor ratesPOST /maintenance/labor-rates — create a replacement labor rate| laborRateID required | integer Example: 7 The unique labor rate ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| success required | boolean Always |
| message required | string or null Confirmation message |
{- "success": true,
- "message": "Labor rate deleted successfully"
}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.
isActive defaults to 1 — only active portfolios are returned unless explicitly set to 0GET /portfolios/search - Advanced filtered search with denormalized columns and additional filtersGET /portfolios/{portfolioID} - Full portfolio detail with optional includes| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=Sunset Free-text search across portfolio name and owner contact names. |
| isActive | boolean |
| sendStatements | integer Enum: 0 1 Example: sendStatements=1 Filter to portfolios that have statement sending enabled ( |
| excludePortfolioID | integer Example: excludePortfolioID=150 Exclude a specific portfolio from results by its ID. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "84" Total number of items across all pages |
| pagination-total-pages | integer Example: "4" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "4" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
| token required | string Opaque pagination token for this row. |
[- {
- "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"
}
]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}.
attachments file IDsUpdatePortfolio permissionowners must be supplied as an array; each entry requires contactID, percentOwned, and percentDistributedisLiveLedgerEnabled accepts -1 to reset the value to null (account default); any other value is stored as-isportfolioGroupIDs assigns the new portfolio to one or more portfolio groupsattachments is an array of existing file IDs to attach to the portfolio on creationGET /portfolios/{portfolioID} - Retrieve the created portfolioPOST /portfolios/{portfolioID} - Update portfolio settingsPOST /portfolios/{portfolioID}/owners - Sync owner list after creation| name required | string Display name of the portfolio. |
| code | string or null Optional short reference code for the portfolio. |
| postingSettingID | string or integer or null^-?[0-9]+$ ID of the posting setting template to assign. |
| statementSettingID | string or integer or null^-?[0-9]+$ ID of the statement setting template to assign. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether to send owner statements. |
| payoutAmount | string or null Fixed payout amount (decimal string), if applicable. |
| fiscalYearEndMonth | string or integer^-?[0-9]+$ Month number (1–12) when the fiscal year ends. |
| minimumDistributionAmount | string or number <decimal> Minimum distribution amount (decimal string). |
| maximumDistributionAmount | string or number <decimal> Maximum distribution amount per cycle (decimal string). |
| overdraftOverrideAmount | string or number <decimal> Amount the balance can go negative before blocking transactions (decimal string). |
| additionalReserveAmount | string or number <decimal> Additional reserve on top of the base reserve (decimal string). |
| additionalReserveDescription | string or null Explanation of the additional reserve amount. |
| holdDistributions | string or integer Enum: "0" "1" 0 1 Whether to hold distributions. |
| isLiveLedgerEnabled | string or integer or null Enum: "0" "1" 0 1 null Real-time ledger updates. Pass |
| isBalanceNoticeDisabled | string or integer Enum: "0" "1" 0 1 Whether to suppress balance notice emails. |
Array of objects Initial owner assignments for the portfolio. | |
| portfolioGroupIDs | Array of integers IDs of portfolio groups to add this portfolio to. |
| attachments | Array of integers File IDs to attach to the new portfolio. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "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"
}
]
}{- "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
}
}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.
propertyCount is a derived column counting properties currently assigned to the portfoliocontactNames is a derived comma-separated string of owner contact namesGET /portfolios - Basic paginated list (fewer filters, lighter payload)GET /portfolios/{portfolioID} - Full portfolio detail with optional includes| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Number of results per page. |
| search | string Example: search=Sunset Free-text search across portfolio name, code, and owner contact names. |
| isActive | integer Enum: 0 1 Example: isActive=1 Filter by active status. Pass |
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=150 Filter to specific portfolios by ID. Pass multiple values as |
| postingSettingIDs[] | Array of integers Example: postingSettingIDs[]=3 Filter to portfolios using specific posting settings. |
| statementSettingIDs[] | Array of integers Example: statementSettingIDs[]=12 Filter to portfolios using specific statement settings. |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=5 Filter to portfolios belonging to specific portfolio groups. |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=8 Filter to portfolios that have at least one property in the specified property groups. |
| tagIDs[] | Array of integers Example: tagIDs[]=22 Filter to portfolios tagged with specific tag IDs. |
| reserveAmountMin | number Example: reserveAmountMin=500 Filter to portfolios with a reserve amount at or above this value. |
| reserveAmountMax | number Example: reserveAmountMax=5000 Filter to portfolios with a reserve amount at or below this value. |
| holdDistributions | integer Enum: 0 1 Filter by distribution hold status. |
| hasAdditionalReserve | integer Enum: 0 1 Example: hasAdditionalReserve=1 Filter to portfolios that have an additional reserve amount greater than zero. |
| sendStatements | integer Enum: 0 1 Example: sendStatements=1 Filter by statement sending preference. |
| dateTimeModifiedMin | string <date-time> Example: dateTimeModifiedMin=2024-01-01T00:00:00Z Filter to portfolios modified on or after this datetime (ISO 8601). |
| dateTimeModifiedMax | string <date-time> Example: dateTimeModifiedMax=2024-12-31T23:59:59Z Filter to portfolios modified on or before this datetime (ISO 8601). |
| dateClosedMin | string <date> Example: dateClosedMin=2024-01-01 Filter to portfolios closed on or after this date. |
| dateClosedMax | string <date> Example: dateClosedMax=2024-12-31 Filter to portfolios closed on or before this date. |
| portfolioAssignedToUserIDs[] | Array of integers Example: portfolioAssignedToUserIDs[]=42 Filter to portfolios assigned to specific users. |
| propertyAssignedToUserIDs[] | Array of integers Example: propertyAssignedToUserIDs[]=42 Filter to portfolios that have at least one property assigned to specific users. |
| payoutBatchID | integer Example: payoutBatchID=300 Filter to portfolios included in a specific payout batch. |
| orderBy | string Example: orderBy=name Field to sort results by. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "84" Total number of items across all pages |
| pagination-total-pages | integer Example: "4" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "4" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
required | object or null Most recent statement for this portfolio, or |
[- {
- "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"
}
}
]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.
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 booleanowners — List of portfolio owners, each with contact data includedledger — The portfolio's accounting ledger recordposting — The posting setting template assigned to the portfoliostatementSetting — The statement setting template assigned to the portfolioGET /portfolios - Paginated portfolio listGET /portfolios/{portfolioID}/owners - List owners for the portfolioGET /portfolios/{portfolioID}/statements - List statements for the portfolio| portfolioID required | integer Example: 150 The ID of the portfolio to retrieve. |
| includes | string Example: includes=owners,statementSetting Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
Array of objects Portfolio owners with contact data (if includes=owners). | |
object or null The portfolio's accounting ledger record (if includes=ledger). | |
object or null The posting setting template (if includes=posting). | |
object (statement_setting) A statement setting template that controls how owner statements are generated and which modules are included. |
{- "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
}
}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}.
assignedToUserID)dateClosedUpdatePortfolio permissionisLiveLedgerEnabled accepts -1 to reset the value to null (account default)dateClosed accepts an ISO date string (YYYY-MM-DD); set to null to reopenGET /portfolios/{portfolioID} - Retrieve current portfolio statePOST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolioPOST /portfolios/{portfolioID}/deactivate - Deactivate a portfolioPOST /portfolios/{portfolioID}/owners - Sync the owner list independently| portfolioID required | integer Example: 279 The ID of the portfolio to update. |
| name | string Display name of the portfolio. |
| code | string or null Optional short reference code. |
| postingSettingID | string or integer or null^-?[0-9]+$ ID of the posting setting template to assign. |
| statementSettingID | string or integer or null^-?[0-9]+$ ID of the statement setting template to assign. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether to send owner statements. |
| fiscalYearEndMonth | string or integer^-?[0-9]+$ Month number (1–12) when the fiscal year ends. |
| minimumDistributionAmount | string or number <decimal> Minimum distribution amount (decimal string). |
| maximumDistributionAmount | string or number <decimal> Maximum distribution amount per cycle (decimal string). |
| overdraftOverrideAmount | string or number <decimal> Amount the balance can go negative before blocking transactions (decimal string). |
| additionalReserveAmount | string or number <decimal> Additional reserve on top of the base reserve (decimal string). |
| additionalReserveDescription | string or null Explanation of the additional reserve amount. |
| holdDistributions | string or integer Enum: "0" "1" 0 1 Whether to hold distributions. |
| holdDistributionsDescription | string or null Reason distributions are being held. |
| isLiveLedgerEnabled | string or integer or null Enum: "0" "1" 0 1 null Real-time ledger updates. Pass |
| isBalanceNoticeDisabled | string or integer Enum: "0" "1" 0 1 Whether to suppress balance notice emails. |
| dateClosed | string or null <date> Date the portfolio was closed (YYYY-MM-DD). Set to |
| assignedToUserID | string or integer or null^-?[0-9]+$ ID of the user assigned to manage this portfolio. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "name": "456 Oak Ave - Johnson (Updated)",
- "reserveAmount": "750.00",
- "maximumDistributionAmount": "6000.00",
- "assignedToUserID": 491061,
- "holdDistributions": 0
}{- "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
}
}Reactivates a previously deactivated portfolio. On success the updated portfolio is returned in the
same shape as GET /portfolios/{portfolioID}.
UpdatePortfolio permissionisActive to "1" and clears dateTimeDeactivatedPOST /portfolios/{portfolioID}/deactivate - Deactivate a portfolioGET /portfolios/{portfolioID} - Retrieve current portfolio state| portfolioID required | integer Example: 279 The ID of the portfolio to activate. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "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
}
}Deactivates an active portfolio, optionally recording a closure date. On success the updated portfolio
is returned in the same shape as GET /portfolios/{portfolioID}.
UpdatePortfolio permissiondateClosed is optional; when supplied it must be a valid date string (YYYY-MM-DD)isActive to "0" and records dateTimeDeactivatedPOST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolioGET /portfolios/{portfolioID} - Retrieve current portfolio state| portfolioID required | integer Example: 279 The ID of the portfolio to deactivate. |
| dateClosed | string or null <date> Date the portfolio was officially closed (YYYY-MM-DD). |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
{- "dateClosed": "2026-04-30"
}{- "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"
}
}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.
contact — The full contact record for the owner (name, email, address, phone numbers)GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Single owner detail with includesGET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details - Decrypted ACH bank account infoGET /portfolios/{portfolioID} - Portfolio detail (also supports owners include)| portfolioID required | integer Example: 279 The ID of the portfolio whose owners to retrieve. |
| search | string Example: search=Smith Free-text search across owner contact names. |
| includes | string Example: includes=contact Comma-separated list of related data to include in the response.
Available values: |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "3" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (portfolio_owner) Represents an owner's stake in a portfolio, including ownership percentage, distribution settings, and payout configuration. |
| token required | string Cache token for the owner record. |
[- {
- "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"
}
]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.
UpdatePortfolio permissionowners is required and must be a non-empty array; each entry requires contactID,
percentOwned, and percentDistributedGET /portfolios/{portfolioID}/owners - List current ownersGET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Single owner detailPOST /portfolios/{portfolioID} - Update portfolio settings (owners can also be set on create)| portfolioID required | integer Example: 279 The ID of the portfolio whose owners to replace. |
required | Array of objects Full replacement owner list. Each entry must include contactID, percentOwned, and percentDistributed. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (portfolio_owner) Represents an owner's stake in a portfolio, including ownership percentage, distribution settings, and payout configuration. |
| token required | string Cache token for the owner record. |
{- "owners": [
- {
- "contactID": 4679,
- "percentOwned": "100.00",
- "percentDistributed": "100.00"
}
]
}[- {
- "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"
}
]Returns the detail for a single portfolio owner record. Use the includes parameter to attach the
full portfolio or contact record.
portfolioOwnerID does not belong to the specified portfolioIDportfolio — The portfolio this owner belongs tocontact — The full contact record for the owner (name, email, address, phone numbers)GET /portfolios/{portfolioID}/owners - List all owners for the portfolioGET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details - Decrypted ACH bank account info| portfolioID required | integer Example: 150 The ID of the portfolio. |
| portfolioOwnerID required | integer Example: 201 The ID of the portfolio owner record. |
| includes | string Example: includes=contact Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (portfolio_owner) Represents an owner's stake in a portfolio, including ownership percentage, distribution settings, and payout configuration. |
object (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. | |
object The owner's contact record (if includes=contact). |
{- "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"
}
}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.
portfolioOwnerID does not belong to the specified portfolioIDachDetails are returned as empty stringsGET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Owner detail (includes truncated account number)GET /portfolios/{portfolioID}/owners - List all portfolio owners| portfolioID required | integer Example: 150 The ID of the portfolio. |
| portfolioOwnerID required | integer Example: 201 The ID of the portfolio owner record. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "achDetails": {
- "nameOnAccount": "John Smith",
- "routingNumber": "021000021",
- "accountNumber": "123456784567"
}
}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.
statementBatchID)statementFileCount and statementAttachmentCount are derived counts, not arraysGET /portfolios/{portfolioID}/statements - Statements for a single portfolioGET /portfolios/statements/{statementID} - Single statement detail with includesGET /portfolios/statements/batches/search - Search statement batches| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Number of results per page. |
| search | string Example: search=Sunset Free-text search across portfolio name and owner contact names. |
| statementBatchID | integer Example: statementBatchID=88 Filter to statements belonging to a specific batch. |
| statementStatusID | integer Enum: 1 2 3 4 5 Example: statementStatusID=2 Filter by statement status.
|
| startDate | string <date> Example: startDate=2024-10-01 Filter to statements whose period starts on or after this date. |
| endDate | string <date> Example: endDate=2024-10-31 Filter to statements whose period ends on or before this date. |
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=150 Filter to statements for specific portfolios. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "42" Total number of items across all pages |
| pagination-total-pages | integer Example: "2" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "2" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object Denormalized statement row returned by the search query. |
required | object Abbreviated portfolio details for the statement's owner portfolio. |
required | object Statement setting template used when generating this statement. |
[- {
- "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"
}
}
]Returns a paginated list of owner statements for a specific portfolio. Use /portfolios/statements/search
for cross-portfolio queries with additional filters.
GET /portfolios/statements/search - Account-wide statement search with advanced filtersGET /portfolios/statements/{statementID} - Single statement detail with includesGET /portfolios/statements/{statementID}/download - Download statement as a ZIP archive| portfolioID required | integer Example: 150 The ID of the portfolio whose statements to list. |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=October Free-text search across statement names. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "12" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
required | object (statement_setting) A statement setting template that controls how owner statements are generated and which modules are included. |
[- {
- "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": "<p>YOYOYOYOYOYOYOYYOYOY</p>"
}, - "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
}
}
}
}
}
]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.
publicUUID and publicVerificationCode — these are unrelated to API authportfolio — The portfolio this statement belongs tostatementFiles — List of generated statement files (PDFs, HTML exports) attached to the statementfileAttachments — File attachments manually added to the statementGET /portfolios/statements/{statementID}/download - Download the statement as a ZIP archiveGET /portfolios/{portfolioID}/statements - All statements for the portfolioGET /portfolios/statements/search - Account-wide statement search| statementID required | integer Example: 4501 The ID of the statement to retrieve. |
| includes | string Example: includes=portfolio,statementFiles Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
object (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. | |
Array of objects Generated statement files (if includes=statementFiles). | |
Array of objects Manually attached files (if includes=fileAttachments). |
{- "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": "<p>test</p>"
}
}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.
GET /portfolios/statements/{statementID} - Statement detail and metadata (includes statementFiles)GET /portfolios/{portfolioID}/statements - All statements for the portfolio| statementID required | integer Example: 4501 The ID of the statement to download. |
| Content-Disposition | string Example: "attachment; filename=\"October 2024 - Sunset Apartments Portfolio.zip\"" Instructs the browser to download the file. |
| Rentvine-Filename | string Example: "October 2024 - Sunset Apartments Portfolio.zip" The suggested filename for the downloaded file. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
{- "error": "Statement 4501 not found"
}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.
statementCount is a derived count of statements in the batch (subquery)statementSetting fields are nullable — a batch may not have an associated setting templatestartFromLastStatement is 1, each portfolio's start date is calculated from its most recent statement end date, so startDate will be nullGET /portfolios/statements/batches/{statementBatchID} - Single batch detail with optional statement listGET /portfolios/statements/search - Search individual statements across all batches| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Number of results per page. |
| search | string Example: search=October Free-text search across batch name, portfolio names, and owner contact names. |
| statementStatusIDs[] | Array of integers Items Enum: 1 2 3 4 5 Example: statementStatusIDs[]=4 Filter to batches with one or more of these statuses.
|
| dateTimeCreatedMin | string <date-time> Example: dateTimeCreatedMin=2024-10-01T00:00:00Z Filter to batches created on or after this datetime (account timezone). |
| dateTimeCreatedMax | string <date-time> Example: dateTimeCreatedMax=2024-12-31T23:59:59Z Filter to batches created on or before this datetime (account timezone). |
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=150 Filter to batches that include statements for specific portfolios. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "18" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object Batch summary fields projected by the search query. |
required | object Statement setting template linked to this batch, if any. |
[- {
- "statementBatch": {
- "statementBatchID": "773",
- "statementStatusID": "2",
- "statementPeriodTypeID": "1",
- "isAutoPublished": "0",
- "startFromLastStatement": "1",
- "startDate": null,
- "endDate": "2026-05-13",
- "message": "<p>YOYOYOYOYOYOYOYYOYOY</p>",
- "dateTimeCreated": "2026-04-23 18:14:49",
- "name": "Last Statement through 05/13/2026",
- "statementCount": "1"
}, - "statementSetting": {
- "statementSettingID": null,
- "name": null
}
}
]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.
verifyAccessToPortfolioBatch; users with restricted portfolio access see
the batch but individual statements may be flagged restricted: 1includes=statements, each statement item includes a restricted flag (0 or 1) indicating
whether the authenticated user can access that statement's portfoliostatements — All statements in the batch, each with portfolio data and a restricted access flagrestrictions — Adds a fullAccess boolean indicating whether the user has unrestricted batch accessGET /portfolios/statements/batches/search - Paginated batch list with advanced filtersGET /portfolios/statements/{statementID} - Single statement detailGET /portfolios/statements/search - Account-wide statement search (filter by statementBatchID)| statementBatchID required | integer Example: 88 The ID of the statement batch to retrieve. |
| includes | string Example: includes=statements,restrictions Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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. |
| fullAccess | boolean Present when includes=restrictions. |
Array of objects All statements in the batch (if includes=statements). |
{- "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": "<p>This is February - March statement</p>",
- "statementBatchFileStatusID": "3",
- "fileID": "9157",
- "dateTimeCreated": "2026-02-18 20:22:38"
}
}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.
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.
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.pageSize of at least 1.pagination-current-page is at or past pagination-last-page.name, then propertyID.image and portfolio includes are inner joins: a property whose image or portfolio row is missing drops out of the page.image - the property's primary image recordportfolio - the portfolio record that owns the propertyGET /properties/search - filtered search with portfolio, lease and group data per rowGET /properties/{propertyID} - one property, with more includesPOST /properties - create a property| page | integer Default: 1 The page number for pagination |
| pageSize | integer >= 1 Default: 15 Example: pageSize=50 Items per page, at least 1 (default 15). Values above 5000 are served at 5000. |
| search | string Example: search=Example Street Substring match on |
| isActive | string Default: "1" Example: isActive=0
|
| managementFeeSettingID | integer Example: managementFeeSettingID=2 Only properties that use this management fee setting, from |
| includes | string Example: includes=image,portfolio Comma-separated related records to add to each item: |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
| token | string^[0-9]+$ The current Unix time. Sent only when neither |
object (property_image) The property's primary image. Requires the | |
object (included_portfolio) The portfolio that owns the property. Requires the |
[- {
- "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"
}
]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).
Properties › CreateProperty).invalid input. when it is empty or {}.property and unit schemas below are read; any other key is ignored.isMultiUnit is 1), the portfolio exists and is inside the API user's portfolio groups, then the property's validators (keyed property.<field>), then each unit's validators (keyed unitContract.unit.<field>).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.unitContract.unit.<field>, and checking stops at the first unit that fails, so the later units' errors aren't reported.1) and Mobile Home (8) allows isMultiUnit 1: Apartment, Condo, Townhouse, Duplex, Multiplex, Loft, Commercial, Garage and Lot (2-7, 9-11).unit with at least rent: without it the request is refused with {"unitContract.unit.rent": ["Rent is required"]}.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.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.addressValidationStatusID starts at 1 (Not Validated).property.<field> or unitContract.unit.<field> error has still sent that address to the geocoding service.assignedToUserID set, sends that user the Property Assigned To User notification.property::property::created webhook event, and unit::unit::created for each unit; a request with the Suppress-Webhooks: 1 header fires none.GET /properties/{propertyID} - read the property back with includesPOST /properties/{propertyID}/units - add units laterGET /portfolios - portfolio IDs for portfolioIDGET /properties - every row's property carries the portfolioID, managementFeeSettingID, countryID and stateID an existing property usesGET /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 propertyrequired | object The |
| attachments required | Array of strings or integers[ items^-?[0-9]+$ ] 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 |
object (unit_for_property_create) The one unit of a single-family property, needed with at least | |
Array of objects The units of a multi-unit property, each with at least |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "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
}
}{- "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
}
}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.
isActive, active and inactive properties are both returned.1/0/true/false/yes/no, a date it can't parse).propertyIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.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.pagination-current-page is at or past pagination-last-page.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.GET /properties - the plain property listGET /properties/{propertyID} - one property, with includesGET /portfolios - portfolio IDs for portfolioIDs[]| page | integer Default: 1 The page number for pagination |
| pageSize | integer <= 5000 Default: 25 Example: pageSize=100 Items per page, at most 5000 (default 25). |
| orderBy | string Example: orderBy=property.name|desc Sort column, optionally followed by |
| search | string Example: search=Example 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 ( |
| isActive | string Example: isActive=1
|
| isMultiUnit | string Example: isMultiUnit=0
|
| isVacant | string Example: isVacant=1
|
| isNonRevenue | string Example: isNonRevenue=0
|
| propertyIDs[] | Array of integers Example: propertyIDs[]=101&propertyIDs[]=102 Only these properties. One |
| propertyTypeIDs[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Example: propertyTypeIDs[]=1 Only these property types. One
|
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=12 Only properties owned by these portfolios (from |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=3 Only properties whose portfolio belongs to one of these portfolio groups. One |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=1 Only properties in one of these property groups. One |
| assignedToUserIDs[] | Array of integers Example: assignedToUserIDs[]=2 Only properties assigned to one of these users. One |
| propertyManagerIDs[] | Array of integers Deprecated Example: propertyManagerIDs[]=1 Deprecated: only single-family properties whose unit has one of these property manager records. Use |
| tagIDs[] | Array of integers Example: tagIDs[]=4 Only properties tagged with one of these tags. One |
| city | string Example: city=Fort Myers Substring match on the city. |
| stateID | string Example: stateID=FL State code, matched exactly. |
| postalCode | string Example: postalCode=339 Substring match on the postal code. |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-01-01 00:00:00 Only properties modified at or after this time, in UTC. Accepts |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-12-31 23:59:59 Only properties modified at or before this time. Same forms as |
| pagination-page-size | integer Example: "1" On a page that holds items, the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
required | object |
required | object |
required | object |
[- {
- "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"
}
}
]Returns one property under property, plus one top-level key per requested include.
Access Denied for a property outside those groups' portfolios.Property {propertyID} not found; a value that isn't a number answers the stock 404.units, and property-level workOrders and ledger;unit and everything that hangs off it (lease, leaseBalances, pastLeases, futureLeases, listing, appliances, filters, filterDeliveryConfiguration, filterDeliveryAddress, filterDeliverySchedule, propertyManager), and unit-level workOrders and ledger.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.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.includes list is split on commas without trimming: image, portfolio reads portfolio (with the space) and silently drops it.image - the property's primary imageunits - the units of a multi-unit propertyworkOrders - work orders with their vendor contact: the property's own (no unit) on a multi-unit property, the unit's on a single-family oneledger - the property's ledger (multi-unit) or the unit's ledger (single-family), or nullunit - the unit of a single-family propertylease - the unit's current lease (or null) and its status as leaseStatusleaseBalances - balances of the current leasepastLeases - the unit's closed leases, newest firstfutureLeases - the unit's pending leaseslisting - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFilesappliances - the unit's appliancesfilters - the unit's air filtersfilterDeliveryConfiguration - whether the unit's air-filter delivery is set upfilterDeliveryAddress - the unit's custom filter delivery address, or falsefilterDeliverySchedule - the unit's filter delivery schedule, or falsepropertyManager - the unit's property manager record, or falseportfolio - the owning portfolioportfolioBalances - balances of the owning portfolio's ledgerportfolios - the property's ownership historyowners - the owning portfolio's owners, with their contactsmanagementFeeSetting - the property's management fee settinginspections - the property's inspectionsassociations - the property's homeowners' associations, with their contactsapplicationTemplate - the property's application template, or nullpropertyShowingProvider - the property's showing provider, or nullGET /properties - list propertiesGET /properties/search - search propertiesPOST /properties/{propertyID} - update the propertyDELETE /properties/{propertyID} - delete the propertyGET /properties/{propertyID}/units/{unitID} - a unit, with its own includes| propertyID required | integer Example: 732 The property's ID. |
| includes | string Example: includes=unit,lease,portfolio,owners Comma-separated related records to add: |
| search | string Example: search=Example With |
| isCurrent | integer Enum: 0 1 Example: isCurrent=1 With |
| portfolioID | integer Example: portfolioID=6 With |
| orderBy | string Example: orderBy=propertyPortfolio.isCurrent|desc With |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
object (property_image) Requires the | |
Array of objects Multi-unit property only; requires the | |
Array of objects (work_order_row) Requires the | |
included_ledger (object) or null Requires the | |
object (unit) Single-family property only; requires the | |
included_lease (object) or null The unit's current lease, or null. Requires the | |
object or null The current lease's status, or null. Sent with | |
object (lease_balances) Requires the | |
Array of objects (included_lease) Closed leases, newest first. Requires the | |
Array of objects (included_lease) Pending leases. Requires the | |
object (listing) Requires the | |
Array of objects (listing_file) The listing's files plus the account-wide listing files (null | |
Array of objects (appliance) Requires the | |
Array of objects (filter) Requires the | |
object (filter_delivery_configuration) Requires the | |
filter_delivery_address (object) or false (any) The unit's custom delivery address, or | |
filter_delivery_schedule (object) or false (any) The unit's delivery schedule, or | |
property_manager (object) or false (any) The unit's property manager record, or | |
object (included_portfolio) Requires the | |
object (portfolio_balances) Requires the | |
Array of objects (property_portfolio_row) Ownership history. Requires the | |
Array of objects (owner_row) Requires the | |
object (included_management_fee_setting) Requires the | |
Array of objects (inspection_row) Requires the | |
Array of objects (association_row) Requires the | |
included_template (object) or null Null when the property has no application template. Requires the | |
showing_provider (object) or null Null when the property has no showing provider. Requires the |
{- "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
}
}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.
Properties › UpdateProperty).Access Denied for a property outside those groups' portfolios.invalid input. when it is empty or {}; then a well-formed ID with no property answers 400 Property {propertyID} not found.portfolioID, isActive and isMultiUnit can't be changed here.{"name": ["Name cannot exceed 100 characters"]}).unit.<field>: a city longer than 50 characters is refused with {"unit.city": ["Cannot exceed 50 characters"]}.DELETE /properties/{propertyID}/units/{unitID} allows it) can't be updated: every update answers 400 {"unit": ["No unit found for single family property: "]}.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.name, address, address2, city, stateID and postalCode are overwritten from the property.address, address2, city, stateID, postalCode) is geocoded again, resets addressValidationStatusID to 1 (Not Validated), clears addressValidationData and queues a new validation.reserveAmount recalculates the owning portfolio's reserve amount.propertyTypeID to Commercial (9) clears the unit's beds, fullBaths and halfBaths; switching away from Commercial clears its commercialSpaceTypeID.assignedToUserID sends the new user the Property Assigned To User notification and records a User Assigned activity.property::property::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID} - read the property with includesPOST /properties/{propertyID}/activate and POST /properties/{propertyID}/deactivate - change its status| propertyID required | integer Example: 728 The property's ID. |
| propertyTypeID | string or integer (property_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" 1 2 3 4 5 6 7 8 9 10 11 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.
|
| managementFeeSettingID | string or integer^-?[0-9]+$ The management fee setting, from |
| name | string or null <= 100 characters Display name. |
| countryID | string <= 2 characters Two-letter country code, from |
| address | string [ 1 .. 100 ] characters Street address. A changed address (or |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code of |
| city | string [ 1 .. 100 ] characters City. At most 50 characters on a single-family property, whose unit takes a copy capped at 50. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| county | string or null <= 100 characters County. |
| legalDescription | string or null <= 100 characters Legal description of the lot. |
| maintenanceLimitAmount | string or number or null <decimal> >= 0 Not negative. |
| yearBuilt | string or integer or null^-?[0-9]+$ A positive whole number; empty is stored as null. |
| dateInsuranceExpires | string or null
|
| dateWarrantyExpires | string or null
|
| maintenanceNotes | string or null <= 65535 characters Internal maintenance notes. |
| applicationTemplateID | string or integer or null^-?[0-9]+$ An application template ID; must exist. |
| reserveAmount | string or number or null <decimal> >= 0 Default: "0.00" Not negative; empty is stored as |
| markupPercent | string or number or null <decimal> Maintenance markup percent, 0.1 to 99. Can't be sent together with a non-empty |
| markupAmount | string or number or null <decimal> >= 0 Maintenance markup as a fixed amount. Can't be sent together with a non-empty |
| markupAmountMin | string or number or null <decimal> >= 0
|
| markupAmountMax | string or number or null <decimal> >= 0
|
| dateContractBegins | string or null
|
| dateContractEnds | string or null
|
| commercialClassTypeID | string or integer or null Enum: "1" "2" "3" "4" 1 2 3 4 null Stored only for a Commercial property (
|
| salesTaxSettingID | string or integer or null^-?[0-9]+$ A sales tax setting ID; must exist. |
| withholdingTaxAgencyID | string or integer or null^-?[0-9]+$ A withholding tax agency ID; must exist. |
| insuranceCompany | string or null <= 100 characters The property's insurance carrier. |
| insuranceAgent | string or null <= 100 characters The property's insurance agent. |
| insurancePolicyNumber | string or null <= 50 characters The property's insurance policy number. |
| insuranceContactDetails | string or null <= 500 characters How to reach the insurance carrier or agent. |
| requiredRentersInsuranceLiabilityAmount | string or number or null <decimal> >= 0 Renters insurance liability coverage required of tenants. Not negative. |
| leaseReturnChargeAmount | string or number or null <decimal> >= 0 Not negative; empty or |
| defaultMonthToMonthPremiumSettingID | string or integer or null^-?[0-9]+$ A month-to-month premium setting ID; must exist. |
| defaultResidentPackageID | string or integer or null^-?[0-9]+$ A resident package ID; must exist. |
| propertyShowingProviderID | string or integer or null^-?[0-9]+$ A configured showing provider ID; must exist. |
| deactivationReasonID | string or integer or null Enum: "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 or null <= 65535 characters Kept only while the property is inactive. |
| assignedToUserID | string or integer or null^-?[0-9]+$ The user to assign the property to; must exist. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "name": "APITEST Cedar House",
- "address": "123 Main St",
- "maintenanceLimitAmount": "400.00",
- "yearBuilt": 1998,
- "dateWarrantyExpires": "12/31/2029",
- "insuranceCompany": "Example Mutual"
}{- "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
}
}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.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.Property {propertyID} not found.transactions), transaction entries (transactionEntries), archived transaction entries (transactionEntryArchives), bills (bills), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases). Voided transactions still count.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"]}.DELETE /properties/{propertyID}/units/{unitID} removes (its ledger, work orders, recurring work orders, appliances, access points, features, images, listings and leads).property::property::deleted webhook event, and unit::unit::deleted for each unit; a request with the Suppress-Webhooks: 1 header fires none.POST /properties/{propertyID}/deactivate - deactivate the property insteadDELETE /properties/{propertyID}/units/{unitID} - delete one unit| propertyID required | integer Example: 728 The property's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| propertyID required | string^-?[0-9]+$ Unique identifier. |
| propertyImageID required | string^-?[0-9]+$ The property's primary image ( |
| propertyTypeID required | string (property_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11"
|
| isMultiUnit required | string Enum: "0" "1"
|
| isActive required | string Enum: "0" "1"
|
| portfolioID required | string^-?[0-9]+$ The portfolio that currently owns the property. |
| managementFeeSettingID required | string^-?[0-9]+$ The management fee setting the property uses. |
| name required | string or null <= 100 characters |
| countryID required | string <= 2 characters Two-letter country code. |
| address required | string <= 100 characters Full formatted street address. |
| streetNumber required | string or null^-?[0-9]+$ Leading street number parsed from |
| streetName required | string or null <= 100 characters
|
| address2 required | string or null <= 100 characters |
| stateID required | string <= 3 characters Two-letter state or province code. |
| city required | string <= 100 characters |
| postalCode required | string or null <= 20 characters |
| latitude required | string <decimal> Geocoded on create and when the address changes; |
| longitude required | string <decimal> Geocoded on create and when the address changes; |
| addressValidationStatusID required | string (address_validation_statuses) Enum: "1" "2" "3" "4" Result of the last address validation. Reset to
|
required | address_validation_data (object) or null The last address-validation verdict, or null before the first run and after a reset. |
| county required | string or null <= 100 characters |
| assignedToUserID required | string or null^-?[0-9]+$ The user the property is assigned to (its property manager), or null. |
| legalDescription required | string or null <= 200 characters Legal description of the lot. The column holds 200 characters, but create and update take at most 100. |
| maintenanceLimitAmount required | string or null <decimal> Spend limit before maintenance needs approval. |
| yearBuilt required | string or null^-?[0-9]+$ |
| dateInsuranceExpires required | string or null <date> |
| dateWarrantyExpires required | string or null <date> |
| maintenanceNotes required | string or null |
| applicationTemplateID required | string or null^-?[0-9]+$ ID of the template this record points to. |
| reserveAmount required | string <decimal> Owner reserve held for the property. |
| markupPercent required | string or null <decimal> Maintenance markup as a percent. Never set together with |
| markupAmount required | string or null <decimal> Maintenance markup as a fixed amount. Never set together with |
| markupAmountMin required | string or null <decimal> |
| markupAmountMax required | string or null <decimal> |
| dateContractBegins required | string or null <date> |
| dateContractEnds required | string or null <date> |
required | commercial_class_types (string) or null Commercial building class; always null unless the property type is Commercial ( |
| salesTaxSettingID required | string or null^-?[0-9]+$ ID of the sales tax setting this record points to. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ ID of the withholding tax agency this record points to. |
| insuranceCompany required | string or null <= 100 characters |
| insuranceAgent required | string or null <= 100 characters |
| insurancePolicyNumber required | string or null <= 50 characters |
| requiredRentersInsuranceLiabilityAmount required | string <decimal> Renters insurance liability coverage required of tenants. Defaults on create to the account's insurance setting, or 100000.00. |
| insuranceContactDetails required | string or null <= 500 characters |
| leaseReturnChargeAmount required | string or null <decimal> Default NSF/returned-payment charge for the property's leases. |
| defaultMonthToMonthPremiumSettingID required | string or null^-?[0-9]+$ ID of the month to month premium setting this record points to. |
| defaultResidentPackageID required | string or null^-?[0-9]+$ ID of the package this record points to. |
| propertyShowingProviderID required | string or null^-?[0-9]+$ The showing provider configured for the property, or null for the account default. |
| dateTimeCreated required | string UTC, formatted |
| dateTimeModified required | string UTC, formatted |
| dateTimeDeactivated required | string or null UTC, formatted |
required | deactivation_reasons (string) or null Why the property was deactivated. Null while active. |
| deactivationNotes required | string or null |
| isFromImport required | string Enum: "0" "1"
|
| importSourceKey required | string or null <= 100 characters The import's key for the row, or null. |
{- "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
}Sets the property inactive, with a reason, and returns it in the GET /properties/{propertyID} shape (without includes). Its units are deactivated with it.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.{} 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.deactivationReasonID, the reason is stored as 99 (Unknown).{"unit": ["No unit found for single family property: "]}.{"unit.leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}. Close the lease first.dateTimeDeactivated and recalculates the owning portfolio's reserve amount.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.POST /properties/{propertyID}/activate - reactivate the propertyDELETE /properties/{propertyID} - delete a property that has no history| propertyID required | integer Example: 707 The property's ID. |
| deactivationReasonID | string or integer or null Enum: "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
|
| deactivationNotes | string or null <= 65535 characters Free-text notes about the deactivation. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "deactivationReasonID": 1,
- "deactivationNotes": "Example note."
}{- "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
}
}Sets the property active and returns it in the GET /properties/{propertyID} shape (without includes). Takes no body.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.Property {propertyID} not found.{"unit": ["No unit found for single family property: "]}.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.activateUnit says, but only when the property was inactive.dateTimeDeactivated, deactivationReasonID and deactivationNotes.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.POST /properties/{propertyID}/deactivate - deactivate the propertyPOST /properties/units/{unitID}/activate - activate one unit| propertyID required | integer Example: 707 The property's ID. |
| activateUnit | integer Default: 0 Enum: 0 1 Example: activateUnit=1
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "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
}
}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.
Returns a page of the property's units. Each item is keyed by entity: unit, plus property, image, propertyImage and propertyManager when included.
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.unitID, a stable order for paging; no other order can be asked for.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.property - the unit's propertyimage - the unit's primary imagepropertyImage - 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)GET /properties/{propertyID}/units/{unitID} - one unit, with more includesPOST /properties/{propertyID}/units - add a unitGET /properties/{propertyID} - the property| propertyID required | integer Example: 707 The property's ID. |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 20 Example: pageSize=50 Items per page (default 20). Values above 5000 are served at 5000. |
| search | string Example: search=Unit 1 Substring match on the unit's |
| isActive | string Default: "1" Example: isActive=0
|
| includes | string Example: includes=property,image Comma-separated related records to add to each item: |
| pagination-page-size | integer Example: "20" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
| token | string^[0-9]+$ The current Unix time. Sent only when no include is requested; carries no meaning for clients. |
object (property) Requires the | |
object (property_image) The unit's primary image. Requires the | |
object (property_image) The property's primary image. Requires the | |
object The unit's property manager record; every field is null when the unit has none. Requires the |
[- {
- "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"
}
]Adds a unit to the property and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes).
Properties › UpdateProperty).invalid input. when it is empty or {}.propertyID in the body is ignored, as is any key not in the schema below.address, city, stateID and rent are required.size is stored as null.{"propertyID": ["Unit already exists on property"]}.[] as the body.addressValidationStatusID starts at 1).unit::unit::created webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID}/units - list the property's unitsGET /properties/{propertyID}/units/{unitID} - read the unit with includesDELETE /properties/{propertyID}/units/{unitID} - delete a unit| propertyID required | integer Example: 548 The property to add the unit to. |
| address required | string <= 100 characters Street address; the leading number is split into |
| stateID required | string <= 3 characters State or province code, from |
| city required | string <= 50 characters City. |
| rent required | string or number <decimal> >= 0 Market rent. Not negative. |
| name | string or null <= 100 characters Display name. |
| streetNumber | string or integer or null^-?[0-9]+$ Overwritten from |
| streetName | string or null Overwritten from |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "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 or integer or null Enum: "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 or integer or null Enum: "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 or integer or null Enum: "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 or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| attachments | Array of strings or integers[ items^-?[0-9]+$ ] IDs of already uploaded files to link to the new unit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "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"
}{- "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
}
}Returns one unit under unit, plus one top-level key per requested include.
Access Denied for a unit of a property outside those groups' portfolios.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.property - the unit's propertypropertyImage - the property's primary imageportfolio - the property's owning portfolioportfolioBalances - balances of the portfolio's ledgerowners - the portfolio's owners, with their contactsassociations - the property's homeowners' associations, with their contactsimage - the unit's primary imagelease - the unit's current lease, or nullleaseBalances - balances of the current leasepastLeases - the unit's closed leasesfutureLeases - the unit's pending leaseslisting - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFilesappliances - the unit's appliancesfilters - the unit's air filtersfilterDeliveryConfiguration - whether the unit's air-filter delivery is set upfilterDeliveryAddress - the unit's custom filter delivery address, or falsefilterDeliverySchedule - the unit's filter delivery schedule, or falsemanagementFeeSetting - the property's management fee setting (false without property)workOrders - the unit's work orders, with their vendor contactinspections - the unit's inspectionspropertyManager - the unit's property manager record, or falseledger - the unit's ledger, or nullGET /properties/{propertyID}/units - list the property's unitsPOST /properties/{propertyID}/units/{unitID} - update the unitDELETE /properties/{propertyID}/units/{unitID} - delete the unitGET /properties/{propertyID} - the property| propertyID required | integer Example: 707 The unit's property. |
| unitID required | integer Example: 585 The unit's ID. |
| includes | string Example: includes=property,lease,listing Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
object (property) Requires the | |
object (property_image) Requires the | |
object (included_portfolio) Requires the | |
object (portfolio_balances) Requires the | |
Array of objects (owner_row) Requires the | |
Array of objects (association_row) Requires the | |
object (property_image) The unit's primary image. Requires the | |
included_lease (object) or null The unit's current lease, or null. Requires the | |
object (lease_balances) Requires the | |
object (filter_delivery_configuration) Requires the | |
Array of objects (included_lease) Closed leases. Requires the | |
Array of objects (included_lease) Pending leases. Requires the | |
object (listing) Requires the | |
Array of objects (listing_file) The listing's files plus the account-wide listing files (null | |
Array of objects (appliance) Requires the | |
Array of objects (filter) Requires the | |
filter_delivery_address (object) or false (any) The unit's custom delivery address, or | |
filter_delivery_schedule (object) or false (any) The unit's delivery schedule, or | |
included_management_fee_setting (object) or false (any) The property's management fee setting; | |
Array of objects (work_order_row) Requires the | |
Array of objects (inspection_row) Requires the | |
property_manager (object) or false (any) The unit's property manager record, or | |
included_ledger (object) or null The unit's ledger, or null. Requires the |
{- "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."
}
}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).
Properties › UpdateProperty).invalid input. when it is empty or {}; then a well-formed unitID with no unit answers 400 Unit {unitID} not found.unitID alone: the propertyID in the path isn't checked against it.Access Denied for a unit of a property outside those groups' portfolios.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.size ("" or 0) is stored as null.YYYY-MM-DD or MM/DD/YYYY and are returned as YYYY-MM-DD.name, address, address2, city, stateID and postalCode are written to the property too.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.unit::unit::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID}/units/{unitID} - read the unit with includesPOST /properties/units/{unitID}/activate and POST /properties/units/{unitID}/deactivate - change its status| propertyID required | integer Example: 548 The unit's property (not checked against the unit). |
| unitID required | integer Example: 716 The unit's ID. |
| name | string or null <= 100 characters Display name. |
| address | string <= 100 characters Street address. A change resets address validation; on a single-family property the new address is also written to the property. |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code, from |
| city | string <= 50 characters City. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| rent | string or number <decimal> >= 0 Market rent. Not negative. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "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 or integer or null Enum: "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 or integer or null Enum: "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 or integer or null^-?[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 |
| commercialSpaceTypeID | string or integer or null Enum: "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 or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| isUtilityBillingEnabled | string or integer Enum: "0" "1" 0 1
|
| filterDeliveryScheduleID | string or integer or null^-?[0-9]+$ An air-filter delivery schedule ID; must exist. |
| filterDeliveryAddressTypeID | string or integer or null Enum: "1" "2" 1 2 null
|
| filterDeliveryAddressID | string or integer or null^-?[0-9]+$ Required when |
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "name": "Unit 1B",
- "rent": "1650.00",
- "size": "",
- "isNonRevenue": 1,
- "nonRevenueTypeID": 1,
- "nonRevenueStartDate": "04/23/2026",
- "isUtilityBillingEnabled": 0
}{- "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."
}
}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.
Properties › UpdateProperty).POST /properties/{propertyID}/units/{unitID} applies.POST /properties/{propertyID}/units/{unitID} - the same update with POST| propertyID required | integer Example: 548 The unit's property (not checked against the unit). |
| unitID required | integer Example: 716 The unit's ID. |
| name | string or null <= 100 characters Display name. |
| address | string <= 100 characters Street address. A change resets address validation; on a single-family property the new address is also written to the property. |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code, from |
| city | string <= 50 characters City. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| rent | string or number <decimal> >= 0 Market rent. Not negative. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "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 or integer or null Enum: "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 or integer or null Enum: "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 or integer or null^-?[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 |
| commercialSpaceTypeID | string or integer or null Enum: "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 or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| isUtilityBillingEnabled | string or integer Enum: "0" "1" 0 1
|
| filterDeliveryScheduleID | string or integer or null^-?[0-9]+$ An air-filter delivery schedule ID; must exist. |
| filterDeliveryAddressTypeID | string or integer or null Enum: "1" "2" 1 2 null
|
| filterDeliveryAddressID | string or integer or null^-?[0-9]+$ Required when |
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "name": "Unit 1B",
- "rent": "1650.00",
- "size": "",
- "isNonRevenue": 1,
- "nonRevenueTypeID": 1,
- "nonRevenueStartDate": "04/23/2026",
- "isUtilityBillingEnabled": 0
}{- "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."
}
}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.
Properties › ChangeStatusProperty).unitID with no unit, or a unit of another property, answers 400 Unit {unitID} not found.Access Denied for a unit of a property outside those groups' portfolios.transactions), transaction entries (transactionEntries), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases), applications (applications), applicants (applicants). Voided and closed records still count.unit::unit::deleted webhook event; a request with the Suppress-Webhooks: 1 header doesn't.POST /properties/units/{unitID}/deactivate - deactivate the unit insteadDELETE /properties/{propertyID} - delete the whole property| propertyID required | integer Example: 548 The unit's property; must match the unit. |
| unitID required | integer Example: 716 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| unitID required | string^-?[0-9]+$ Unique identifier. |
| propertyID required | string^-?[0-9]+$ The property the unit belongs to. |
| propertyImageID required | string^-?[0-9]+$ The unit's primary image ( |
| isActive required | string Enum: "0" "1"
|
| name required | string or null <= 100 characters Unit name/number. |
| address required | string <= 100 characters |
| streetNumber required | string or null^-?[0-9]+$ Leading street number parsed from |
| streetName required | string or null <= 100 characters
|
| address2 required | string or null <= 100 characters |
| stateID required | string <= 3 characters Two-letter state or province code. |
| city required | string <= 100 characters |
| postalCode required | string or null <= 20 characters |
| latitude required | string <decimal> Geocoded on create (multi-unit property) or copied from the property; |
| longitude required | string <decimal> Geocoded on create (multi-unit property) or copied from the property; |
| addressValidationStatusID required | string (address_validation_statuses) Enum: "1" "2" "3" "4" Result of the last address validation. Reset to
|
required | address_validation_data (object) or null The last address-validation verdict, or null before the first run and after a reset. |
| rent required | string <decimal> Market rent. |
| deposit required | string or null <decimal> Market security deposit. |
| size required | string or null^-?[0-9]+$ Size in square feet. |
required | property_beds (string) or null Bedrooms ( |
required | property_baths (string) or null Full bathrooms. Null on a Commercial property. |
required | property_baths (string) or null Half bathrooms. Null on a Commercial property. |
| leaseID required | string or null^-?[0-9]+$ The unit's current lease, or null when vacant. |
| propertyManagerID required | string or null^-?[0-9]+$ Deprecated: the unit's property manager record; no longer editable (use the property's |
required | commercial_space_types (string) or null Commercial space type; always null unless the property type is Commercial (
|
| isNonRevenue required | string Enum: "0" "1"
|
required | non_revenue_types (string) or null Why the unit is non-revenue; null unless
|
| nonRevenueStartDate required | string or null <date> When the unit became non-revenue; null unless |
| isUtilityBillingEnabled required | string Enum: "0" "1"
|
| filterDeliveryScheduleID required | string or null^-?[0-9]+$ The air-filter delivery schedule, or null. |
required | filter_delivery_address_types (string) or null Where air filters are delivered, or null when not configured.
|
| filterDeliveryAddressID required | string or null^-?[0-9]+$ The custom filter delivery address; null unless |
| dateTimeCreated required | string UTC, formatted |
| dateTimeModified required | string UTC, formatted |
| dateTimeDeactivated required | string or null UTC, formatted |
| isFromImport required | string Enum: "0" "1"
|
| importSourceKey required | string or null <= 100 characters The import's key for the row, or null. |
| leaseNotes required | string or null |
| entryInstructions required | string or null Resident-facing entry instructions. |
| vendorEntryInstructions required | string or null Vendor-facing entry instructions. |
| maintenanceNotes required | string or null |
{- "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."
}Sets the unit active and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes). Takes no body.
Properties › ChangeStatusProperty).Access Denied for a unit of a property outside those groups' portfolios.Unit {unitID} not found.{"property": ["Property is not active"]}.dateTimeDeactivated.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.POST /properties/units/{unitID}/deactivate - deactivate the unitPOST /properties/{propertyID}/activate - activate the property (and optionally all its units)GET /properties/{propertyID}/units/{unitID} - read the unit| unitID required | integer Example: 528 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "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."
}
}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.
Properties › ChangeStatusProperty).Access Denied for a unit of a property outside those groups' portfolios.Unit {unitID} not found.{"leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}.99, Unknown), and so are the property's own active recurring work orders.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.POST /properties/units/{unitID}/activate - reactivate the unitPOST /properties/{propertyID}/deactivate - deactivate the whole propertyDELETE /properties/{propertyID}/units/{unitID} - delete a unit that has no history| unitID required | integer Example: 528 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (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, |
{- "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."
}
}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.
Returns the account's REP service catalog (resident_services).
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.POST /resident/services — create a serviceGET /resident/services/{residentServiceID} — retrieve a single serviceGET /resident/packages — the packages these services can be bundled into| search | string Example: search=Pest Full-text search against the service name. |
| isActive | integer Enum: 0 1 Example: isActive=1 Filter by active status. Pass |
| serviceTypeID | integer Example: serviceTypeID=3 Filter by service type (e.g. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
[- {
- "service": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}
]Creates a REP service in the account catalog.
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.| serviceTypeID required | string or integer^-?[0-9]+$ Service type: |
| 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 or integer^-?[0-9]+$ GL account the recurring charge posts to. |
| defaultRecurringChargeAmount | string or number <decimal> Default monthly retail amount (greater than 0). |
| isActive | string or integer Enum: "0" "1" 0 1 Whether the service is offered. Defaults to |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string^-?[0-9]+$ Service type. System types are seeded; |
| name | string or 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 or null Optional resident-facing description of the service. |
| recurringChargeDescription | string or null Ledger-line text for the resident's recurring charge. |
| recurringChargeAccountID | string or null^-?[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 Enum: "0" "1" Whether the PM offers this service ( |
| dateTimeCreated | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified | string or null Timestamp when the service was last modified. UTC, formatted |
{- "serviceTypeID": "1",
- "name": "Premium Lawn Care",
- "description": "Weekly lawn service.",
- "recurringChargeDescription": "Lawn Care",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "30.00",
- "isActive": "1"
}{- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}Retrieves a single REP service from the account catalog.
| residentServiceID required | integer Example: 3 ID of the resident service. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string^-?[0-9]+$ Service type. System types are seeded; |
| name | string or 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 or null Optional resident-facing description of the service. |
| recurringChargeDescription | string or null Ledger-line text for the resident's recurring charge. |
| recurringChargeAccountID | string or null^-?[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 Enum: "0" "1" Whether the PM offers this service ( |
| dateTimeCreated | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified | string or null Timestamp when the service was last modified. UTC, formatted |
{- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}Updates a REP service.
serviceTypeID is immutable — it cannot be changed once the service exists.name remains required for a Custom service.| residentServiceID required | integer Example: 3 ID of the resident service. |
| name | string |
| description | string |
| recurringChargeDescription | string |
| recurringChargeAccountID | string or integer^-?[0-9]+$ |
| defaultRecurringChargeAmount | string or number <decimal> |
| isActive | string or integer Enum: "0" "1" 0 1 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string^-?[0-9]+$ Service type. System types are seeded; |
| name | string or 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 or null Optional resident-facing description of the service. |
| recurringChargeDescription | string or null Ledger-line text for the resident's recurring charge. |
| recurringChargeAccountID | string or null^-?[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 Enum: "0" "1" Whether the PM offers this service ( |
| dateTimeCreated | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified | string or null Timestamp when the service was last modified. UTC, formatted |
{- "name": "Premium Lawn Care",
- "description": "Weekly lawn service.",
- "recurringChargeDescription": "Lawn Care",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "30.00",
- "isActive": "1"
}{- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}Deletes a REP service from the catalog.
isActive = 0).400) when any lease references it or it belongs to a package. Remove it from those first.| residentServiceID required | integer Example: 3 ID of the resident service. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string^-?[0-9]+$ Service type. System types are seeded; |
| name | string or 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 or null Optional resident-facing description of the service. |
| recurringChargeDescription | string or null Ledger-line text for the resident's recurring charge. |
| recurringChargeAccountID | string or null^-?[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 Enum: "0" "1" Whether the PM offers this service ( |
| dateTimeCreated | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified | string or null Timestamp when the service was last modified. UTC, formatted |
{- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}The account's REP package catalog. A package bundles services and bills the resident a single recurring charge. Per-account config — no portfolio scoping.
Returns the account's REP package catalog (resident_packages).
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.?includes=packageServices for those.POST /resident/packages — create a packageGET /resident/packages/{residentPackageID} — retrieve a single package (with packageServices)GET /resident/services — the services a package bundles| search | string Example: search=Essentials Full-text search against the package name. |
| isActive | integer Enum: 0 1 Example: isActive=1 Filter by active status. Pass |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
[- {
- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}
]Creates a REP package and its service membership in one call.
services is the bundle's membership — an array of { residentServiceID }. At least one service is required.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.| name required | string Display name of the package. |
required | Array of objects The services bundled into this package. At least one is required. |
| recurringChargeDescription | string Ledger-line text for the bundled recurring charge. |
| recurringChargeAccountID | string or integer^-?[0-9]+$ GL account the bundled charge posts to. |
| defaultRecurringChargeAmount | string or number <decimal> Monthly retail amount for the bundle (greater than 0). |
| isActive | string or integer Enum: "0" "1" 0 1 Whether the package is offered. Defaults to |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
{- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "services": [
- {
- "residentServiceID": "3"
}
]
}{- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}Retrieves a single REP package from the account catalog.
Pass includes=packageServices to embed the bundle's membership rows alongside their joined
service definitions.
| residentPackageID required | integer Example: 1 ID of the resident package. |
| includes | string Example: includes=packageServices Comma-separated related data to embed. Supported — |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in | |
Array of objects Present only when requested via |
{- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}, - "packageServices": [
- {
- "packageService": {
- "residentPackageServiceID": "5",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}, - "service": {
- "residentServiceID": "3",
- "serviceTypeID": "3",
- "name": "Pest Control",
- "description": "Monthly pest control treatment.",
- "recurringChargeDescription": "Pest Control",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "8.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}
]
}Updates a REP package, including its service membership.
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.residentServiceID must reference an existing, active service in the account catalog.| residentPackageID required | integer Example: 1 ID of the resident package. |
| name | string |
| recurringChargeDescription | string |
| recurringChargeAccountID | string or integer^-?[0-9]+$ |
| defaultRecurringChargeAmount | string or number <decimal> |
| isActive | string or integer Enum: "0" "1" 0 1 |
Array of objects Replaces the package membership when supplied. At least one service is required. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
{- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "services": [
- {
- "residentServiceID": "3"
}
]
}{- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}Deletes a REP package from the catalog.
400) when any lease is enrolled in it. The membership rows (resident_package_services) are removed with the package.| residentPackageID required | integer Example: 1 ID of the resident package. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| residentPackageID required | string^-?[0-9]+$ Unique identifier for the package. |
| name required | string Display name of the package. |
| recurringChargeDescription | string or null Ledger-line text for the resident's bundled recurring charge. |
| recurringChargeAccountID | string or null^-?[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 Enum: "0" "1" Whether the PM offers this package ( |
| dateTimeCreated | string Timestamp when the package was created. UTC, formatted |
| dateTimeModified | string or null Timestamp when the package was last modified. UTC, formatted |
{- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}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.
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.
isZillowActive, isZumperActive, …)isActive, active and inactive listings are both returned.1/0/true/false/yes/no, a date it can't parse, an unknown orderBy).latitudeMin, latitudeMax, longitudeMin and longitudeMax are sent.notPropertyTypeID[] (singular); notPropertyTypeIDs[] is not read and excludes nothing.propertyTypeIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.pagination-page-size reports the page size or the number of matching items, whichever is smaller, and 15 when nothing matches.orderBy (default unit.address), then propertyListingID.isWebsiteActive, isZillowActive, …) can be filtered on but are not part of the row.GET /properties/listings (undocumented) - the plain listing listGET /properties/{propertyID}/units/{unitID}/listing (undocumented) - one listing, with its syndication flagsGET /listings/{propertyListingID}/files (undocumented) - the photos and documents of a listingGET /properties/{propertyID}/units/{unitID} - the unit, with the listing include| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). No cap. |
| orderBy | string Example: orderBy=amount|desc Sort column, optionally followed by |
| search | string Example: search=Example Street Substring match on the listing's headline and description and the unit's address, address 2, city and postal code. |
| isActive | string Example: isActive=1
|
| isWebsiteActive | string Example: isWebsiteActive=1
|
| isZillowActive | string Example: isZillowActive=1
|
| isRentalSourceActive | string Example: isRentalSourceActive=1
|
| isRentalscomActive | string Example: isRentalscomActive=1
|
| isZumperActive | string Example: isZumperActive=1
|
| isApartmentsActive | string Example: isApartmentsActive=1
|
| isVacant | string Example: isVacant=1
|
| rentMin | number Example: rentMin=1000 Minimum unit rent, inclusive. |
| rentMax | number Example: rentMax=3500 Maximum unit rent, inclusive. |
| bedsMin | integer Example: bedsMin=2 Minimum bedrooms, inclusive. |
| bedsMax | integer Example: bedsMax=4 Maximum bedrooms, inclusive. |
| bathsMin | integer Example: bathsMin=1 Minimum bathrooms, inclusive, counting full and half baths alike ( |
| bathsMax | integer Example: bathsMax=3 Maximum bathrooms, inclusive, counted the same way. |
| petFilterOptionID | integer Enum: 1 2 3 4 Example: petFilterOptionID=3
|
| city | string Example: city=Fort Myers Substring match on the unit's city. |
| stateID | string Example: stateID=FL The unit's state code, matched exactly. |
| postalCode | string Example: postalCode=339 Substring match on the unit's postal code. |
| latitudeMin | number Example: latitudeMin=26.3 South edge of the map box; used only with the other three box parameters. |
| latitudeMax | number Example: latitudeMax=26.7 North edge of the map box. |
| longitudeMin | number Example: longitudeMin=-82.1 West edge of the map box. |
| longitudeMax | number Example: longitudeMax=-81.7 East edge of the map box. |
| propertyTypeIDs[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Example: propertyTypeIDs[]=1&propertyTypeIDs[]=4 Only these property types. One
|
| notPropertyTypeID[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Example: notPropertyTypeID[]=9 Leave out these property types (same values as |
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=12 Only listings of properties owned by these portfolios (from |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=3 Only listings of properties whose portfolio belongs to one of these portfolio groups. |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=1 Only listings of properties in one of these property groups. |
| propertyManagerIDs[] | Array of integers Example: propertyManagerIDs[]=1 Only listings of units with one of these property manager records. |
| assignedToUserIDs[] | Array of integers Example: assignedToUserIDs[]=2 Only listings of properties assigned to one of these users. |
| showingProviderID | integer Enum: 2 3 4 5 Example: showingProviderID=3 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.
|
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-01-01 00:00:00 Only listings modified at or after this time. Accepts |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-12-31 23:59:59 Only listings modified at or before this time. Same forms as |
| pagination-page-size | integer Example: "1" The requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The listing columns, plus the unit size and the two application links. |
required | object The listed unit (always active). |
required | object The unit's property (always active). |
required | object |
required | object |
required | object The unit's property manager record; both fields null when it has none. |
required | object The unit's primary image. |
[- {
- "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",
}
}
]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.
The image object in each listing search result contains pre-built absolute URLs:
{
"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} |
Dimensions | Use Case |
|---|---|---|
small |
Thumbnail | List views, vacancy boards, map pins |
large |
Full size | Detail pages, syndication feeds, lightboxes |
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 listingGET /listings/files/{id}/preview (undocumented) — returns a file inline (for browser display)GET /listings/files/{id}/download (undocumented) — downloads a file as an attachmentGET /properties/listings/search - Returns image.small and image.large for each resultGET /listings/{propertyListingID}/files (undocumented) - All uploaded listing photos and media| propertyID required | integer Example: 707 The |
| imageHash required | string Example: e66a65f69d53ff3a19265b69efe9 The image hash component from the |
| size required | string Enum: "small" "large" Example: small
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
{- "error": "Not found"
}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.
objectTypeID and objectID are required. The request will return 400 if either is missing.verifyAccessToObjectType — the authenticated account must have access to the given object.dateTimeUpdated descending (most recently active conversations first).GET /contacts/conversations/{id} — retrieve a single conversation with its messagesPOST /contacts/conversations — send a new email message (creates or extends a conversation)| objectTypeID required | integer Example: objectTypeID=4 The object type the conversations belong to. See the Object Types reference for valid values. Common values:
|
| objectID required | integer Example: objectID=1050 The primary key of the object identified by |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "12" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| emailConversationID required | string^-?[0-9]+$ Unique identifier for the email conversation. |
| objectTypeID required | string^-?[0-9]+$ Object type the conversation is associated with. |
| objectID required | string^-?[0-9]+$ Primary key of the associated object. |
| subject required | string or null Subject line of the email conversation thread. |
| dateTimeCreated required | string When the conversation was first created. UTC, formatted |
| dateTimeUpdated required | string When the conversation was last updated (e.g. a new message was sent or received). UTC, formatted |
| emailMessageCount required | integer Number of email messages within the conversation thread. |
[- {
- "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
}
]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.
Contacts: Send Messages permission.recipients is required. Addresses matching the system mail domain or noreply are silently filtered out.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.attachments must already exist in the system.GET /contacts/conversations — list conversations for an objectGET /contacts/conversations/{id} — retrieve a conversation with its message history| recipients required | Array of strings <email> [ items <email > ] Primary To recipients — array of email address strings. |
| message required | string HTML body of the email. |
| subject required | string <= 300 characters Email subject line. Required when creating a new conversation. |
| objectTypeID required | string or integer^-?[0-9]+$ Object type the conversation belongs to. Required when creating a new conversation. Common values:
|
| objectID required | string or integer^-?[0-9]+$ Primary key of the object identified by |
| additionalRecipients | Array of strings <email> [ items <email > ] Additional To recipients to include alongside |
| bcc | Array of strings <email> [ items <email > ] BCC recipients — array of email address strings. |
object Email template options. | |
| attachments | Array of integers Array of |
| copySender | string or integer Enum: "0" "1" 0 1 Pass |
| inputs | object Optional key/value pairs passed to template rendering. |
| templateObjectTypeID | string or integer^-?[0-9]+$ Template object type used when rendering template variables in the email body. |
| emailConversationID | string or integer^-?[0-9]+$ Supply to reply within an existing conversation thread. If omitted, a new conversation is created. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "additionalRecipients": [
- "test@gmail.com"
], - "bcc": [
- "test@gmail.com"
], - "message": "<p>Hi Tenants,</p><p>Mackenzie Walker</p><p>We are excited to welcome you as new tenants!</p>",
- "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"
}{- "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"
}
}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.
400 if the conversation is not found.verifyAccessToObjectType using the conversation's objectTypeID and objectID — the authenticated account must have access to the associated object.messages include, only the base conversation record is returned.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).messages — full message history with sender recipient details and file attachments per message. Also adds recipients (all conversation participants) to the response.GET /contacts/conversations — list all conversations for an objectPOST /contacts/conversations — send a new email message / create a conversation| id required | integer Example: 301 The unique identifier of the email conversation ( |
| includes | string Example: includes=messages Comma-separated list of related data to include in the response. Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
Array of objects All participants in this conversation (if includes=messages). | |
Array of objects Full message history (if includes=messages), ordered most recent first. |
{- "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"
}
}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).
chatObjectTypeID and objectID are required. Restricted accounts that omit these will receive a 400 error.chatObjectTypeID and objectID to retrieve messages across all objects.search performs a full-text match against the message body.message.*, user.*, and contact.* keys.1 - Work Order2 - Lease3 - Portfolio4 - Vendor5 - ApplicantGET /chat/messages/{id} — retrieve a single message with file attachmentsPOST /chat/messages — create a new chat messageGET /chat/messages/stats — get unread message count for a specific object| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 20 Example: pageSize=20 Number of results per page. Defaults to 20. |
| chatObjectTypeID | integer Enum: 1 2 3 4 5 Example: chatObjectTypeID=2 The chat object type identifying what kind of object the chat thread belongs to. Required for restricted accounts.
|
| objectID | integer Example: objectID=1050 Primary key of the object identified by |
| search | string Example: search=maintenance request Full-text search against the message body. |
| isSharedWithTenant | integer Enum: 0 1 Example: isSharedWithTenant=1 Filter by whether messages are shared with the tenant. Pass |
| isSharedWithCosigner | integer Enum: 0 1 Filter by whether messages are shared with the cosigner. |
| isSharedWithVendor | integer Enum: 0 1 Filter by whether messages are shared with the vendor. |
| isSharedWithOwner | integer Enum: 0 1 Filter by whether messages are shared with the owner. |
| pagination-page-size | integer Example: "20" Number of items per page |
| pagination-total-items | integer Example: "34" Total number of items across all pages |
| pagination-total-pages | integer Example: "2" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "2" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| message.messageID required | integer Unique identifier of the chat message. |
| message.chatObjectTypeID required | integer Chat object type identifier (1=Work Order, 2=Lease, 3=Portfolio, 4=Vendor, 5=Applicant). |
| message.objectID required | integer Primary key of the associated object. |
| message.roleTypeID required | integer Role type of the message sender (1=Manager, 2=Tenant, etc.). |
| message.message required | string Text body of the chat message. |
| message.dateTimeCreated required | string <date-time> When the message was created. |
| message.userID | integer or null ID of the user who sent the message (manager-originated messages). |
| message.contactID | integer or null ID of the contact who sent the message (tenant/vendor/owner-originated messages). |
| message.messageLinkPreviewMeta | object or 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 |
Array of objects File attachments on the message. | |
| user.userID | integer or null User ID of the sender (populated for manager-originated messages). |
| user.firstName | string or null First name of the sending user. |
| user.lastName | string or null Last name of the sending user. |
| user.email | string or null <email> Email address of the sending user. |
| contact.contactID | integer or null Contact ID of the sender (populated for tenant/vendor/owner-originated messages). |
| contact.contactTypeID | integer or null Type of the sending contact. |
| contact.name | string or null Display name of the sending contact. |
[- {
- "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"
}
]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.
roleTypeID is always set to Manager (1) server-side and cannot be overridden by the client.chatObjectTypeID and objectID.attachments is an array of fileID integers referencing files that already exist in the system.isSharedWithTenant, isSharedWithVendor, isSharedWithOwner, isSharedWithCosigner) default to 0 if omitted.GET /chat/messages — list messages for an objectGET /chat/messages/{id} — retrieve a single message| chatObjectTypeID required | string or integer Enum: "1" "2" "3" "4" "5" 1 2 3 4 5 The chat object type identifying what kind of object the message belongs to.
|
| objectID required | string or integer^-?[0-9]+$ Primary key of the object identified by |
| message required | string HTML body of the chat message. |
| isSharedWithTenant | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the tenant (0 or 1). |
| isSharedWithVendor | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the vendor (0 or 1). |
| isSharedWithOwner | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the owner (0 or 1). |
| isSharedWithCosigner | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the cosigner (0 or 1). |
| attachments | Array of integers Array of |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | Array of objects File attachments on the created message (empty if none were supplied). |
{- "attachments": [ ],
- "message": "<p>test</p>",
- "chatObjectTypeID": 2,
- "objectID": 2982,
- "isSharedWithTenant": "1",
- "isSharedWithCosigner": "1"
}{- "message": {
- "messageID": "1026",
- "chatObjectTypeID": "2",
- "objectID": "2982",
- "roleTypeID": "1",
- "userID": "501195",
- "contactID": null,
- "shortUrlID": "808166",
- "message": "<p>test</p>",
- "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": [ ]
}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}).
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.GET /messages/texts/phone/{phoneNumber} — list the full thread for a phone numberGET /messages/texts/{id} — retrieve a single text message| to required | string Recipient phone number in E.164 format. |
| message required | string Text body of the SMS message. |
| attachments | Array of integers Optional array of |
| contactID | string or integer^-?[0-9]+$ Optional contact ID for UI context. Not stored on the text message record. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "contactID": "3816",
- "to": "+14436420607",
- "message": "test"
}{- "textMessage": {
- "textMessageID": "914",
- "isInbound": "0",
- "from": "+12393606531",
- "to": "+14436420607",
- "message": "\"test\"",
- "fileAttachments": null,
- "sentByUserID": "501195",
- "dateTimeSent": "2026-04-27 12:54:12"
}
}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.
load endpoint instead)phoneNumber must be provided as digits only (no +, dashes, or spaces).POST /messages/texts/send — send a new text messageGET /messages/texts/{id} — retrieve a single text message| phoneNumber required | integer Example: 14436420607 Phone number digits including country code, without |
| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 15 Example: pageSize=15 Number of results per page. Defaults to 15. |
| search | string Example: search=maintenance Filter results to messages whose body contains this string. |
| pagination-page-size | integer Example: "15" Number of items per page |
| pagination-total-items | integer Example: "42" Total number of items across all pages |
| pagination-total-pages | integer Example: "3" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "3" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| textMessageID required | string^-?[0-9]+$ Unique identifier of the text message. |
| isInbound required | string Enum: "0" "1" Whether the message was received (1) or sent (0) by the manager. |
| from required | string Sender phone number in E.164 format. |
| to required | string Recipient phone number in E.164 format. |
| message required | string or null Text body of the message. |
| dateTimeSent required | string When the message was sent or received. UTC, formatted |
| fileAttachments | string or null JSON-encoded array of file attachment metadata stored with the message, if any. |
| sentByUserID | string or null^-?[0-9]+$ ID of the manager user who sent the message (null for inbound messages). |
[- {
- "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"
}
]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.
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.GET /screening/applications — list submitted applicationsGET /screening/applications/{applicationID} — retrieve a single application| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| screeningSettingID required | string^-?[0-9]+$ Unique identifier for the screening settings record. |
| applicationProviderID required | string^-?[0-9]+$ ID of the third-party screening provider integrated with this account. |
| isApplicationEnabled required | string Enum: "0" "1" Whether the resident-facing application portal is enabled. |
| isGenericApplicationEnabled required | string Enum: "0" "1" Whether a generic (non-property-specific) application link is active. |
| isAvailableUnitsOnly required | string Enum: "0" "1" Restricts the application portal to units marked as available. |
| autoAssignApplicationFromProperty required | string Enum: "0" "1" Automatically assigns the property's manager to incoming applications. |
| autoSendProspectConfirmationEmail required | string Enum: "0" "1" Sends a confirmation email to applicants upon submission. |
| applicationUrl | string or null Custom application URL override. Empty string if not set. |
| genericApplicationTemplateID | string or null^-?[0-9]+$ ID of the application template used for generic (non-property-specific) applications. |
| genericApplicationTemplateName | string or null Display name of the generic application template. |
{- "screeningSettingID": "1",
- "applicationProviderID": "1",
- "isApplicationEnabled": "1",
- "applicationUrl": "",
- "isGenericApplicationEnabled": "1",
- "genericApplicationTemplateID": "2",
- "isAvailableUnitsOnly": "1",
- "autoAssignApplicationFromProperty": "1",
- "autoSendProspectConfirmationEmail": "1",
- "genericApplicationTemplateName": "Commercial Application"
}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.
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.isActive tells them apart.templateID, oldest first.POST /screening/applications - create an application from a template| search | string Example: search=Contract check Part of the template's name, matched anywhere in it and in any case. |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object (included_template) An application (screening) template. |
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the template. |
[- {
- "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"
}
]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.
page and pageSize to paginate through results.applicationID (most recent first).lease object will have null values when no lease has been created from the application yet.GET /screening/applications/{applicationID} — retrieve a single application's detailsGET /screening/applications/{applicationID}/summary — retrieve a full summary with applicant dataPOST /screening/applications/{applicationID}/status — update an application's status| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Number of items per page |
| search | string Example: search=Walter Search against applicant names, address, or application number. |
| applicationStatusID | integer Example: applicationStatusID=2 Filter by application status ID. |
| unitID | integer Example: unitID=709 Filter applications by a specific unit ID. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "1608" Total number of items across all pages |
| pagination-total-pages | integer Example: "65" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Example: "2" Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "65" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
required | object |
required | object |
required | object |
[- {
- "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": [ ]
}
}
]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.
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.{} (invalid input.);templateID (TemplateID is required), then a templateID with no template (Application Template not found);application at once, the messages nested by section and field as the body is (a list
section's under items, by position);unitID with no unit (Failed to find unit with unitID {unitID});applicant.<field>, application.<field>, contact.<field> or
animalPhotos.fileID.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.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.unitID, the application is for the address sent under application.applyingFor.unitID from a property in those portfolios.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.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.photos ({"fileID": …} entries) to the applicant as an animal photo.GET /screening/templates - the templates, for templateIDGET /screening/applications/{applicationID} - the application createdGET /properties/{propertyID}/units - the units of a property, for unitID| templateID required | string or integer^[0-9]+$ The application template, from |
required | 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 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.
|
| unitID | string or integer or null^[0-9]+$ The unit applied for, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| applicantID required | string^-?[0-9]+$ The primary key of the applicant. |
| applicationID required | string^-?[0-9]+$ The application the applicant belongs to, readable at |
| number required | integer The applicant's number on the account, assigned when it is created. A JSON number, unlike the IDs. |
| templateID required | string^-?[0-9]+$ The template the application was created from. |
| userID required | string or null^-?[0-9]+$ The applicant portal user who submitted it; null for an application a manager created. |
| applicantContactID required | string^-?[0-9]+$ The applicant's contact record, created with the application from its name, email and phones. |
| unitID required | string or integer or null^[0-9]+$ The unit applied for, as sent (a JSON number when sent as one); null when none was sent. |
| countryID required | string or null <= 2 characters Country of the address applied for: the unit's (always |
| address required | string or null <= 100 characters The address applied for: the unit's when |
| address2 required | string or null <= 100 characters Second line of the address applied for; the unit's, or as sent. |
| city required | string or null <= 50 characters City of the address applied for; the unit's, or as sent. |
| stateID required | string or null <= 3 characters State of the address applied for; the unit's, or as sent. |
| postalCode required | string or null <= 20 characters Postal code of the address applied for; the unit's, or as sent. |
| rent required | string or number or null Rent amount, as sent under |
| deposit required | string or number or null Security deposit, as sent (a JSON number when sent as one); null when not sent. |
| moveInDate required | string or null <date> Move In Date, as sent under |
| leaseMonths required | string or integer or null Length of the lease in months, as sent (a JSON number when sent as one); null when not sent. |
| agentName required | string or null <= 100 characters Agent, as sent under |
| agentContactInformation required | string or null <= 100 characters Contact Info, as sent under |
| firstName required | string or null <= 50 characters First Name, as sent under |
| middleName required | string or null <= 50 characters Middle Name, as sent under |
| lastName required | string or null <= 50 characters Last Name, as sent under |
| email required | string or null <= 75 characters Email, as sent under |
| homePhone required | string or null <= 20 characters Home Phone, as sent under |
| cellPhone required | string or null <= 20 characters Cell Phone, as sent under |
| workPhone required | string or null <= 20 characters Work Phone, as sent under |
| birthDate required | string or null <date> Date of Birth, as sent under |
| birthPlace required | string or null <= 50 characters Birth Place, as sent under |
| ssnCiphertextID required | string or null^-?[0-9]+$ The stored, encrypted Social Security or taxpayer number. The number itself isn't returned. |
| ssnTruncated required | string or null <= 20 characters The last four digits of the Social Security or taxpayer number sent. |
| licenseNumber required | string or null <= 50 characters Drivers License #, as sent under |
| licenseState required | string or null <= 50 characters License State, as sent under |
| passportID required | string or null <= 50 characters Passport #, as sent under |
| studentID required | string or null <= 50 characters Student #, as sent under |
| maidenName required | string or null <= 50 characters Maiden Name, as sent under |
| height required | string or null <= 25 characters Height, as sent under |
| weight required | string or null <= 25 characters Weight, as sent under |
| eyeColor required | string or null <= 25 characters Eye Color, as sent under |
| hairColor required | string or null <= 25 characters Hair Color, as sent under |
| maritalStatus required | string or null <= 200 characters Marital Status, as sent under |
| citizenship required | string or null <= 100 characters Citizenship, as sent under |
| referredBy required | string or null <= 1000 characters How were you referred to us?, as sent under |
| assistanceAgency required | string or null <= 45 characters Agency, as sent under |
| assistanceCounty required | string or null <= 100 characters County, as sent under |
| assistanceTechnician required | string or null <= 100 characters Technician, as sent under |
| assistancePhone required | string or null <= 20 characters Phone, as sent under |
| assistanceAmount required | string or number or null Assistance amount, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. |
| assistanceUtility required | string or null <= 200 characters Utilities Included, as sent under |
| assistanceBeds required | string or integer or null Bedrooms the assistance covers, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. |
| applicantType required | string or null <= 200 characters I Am The, as sent under |
| primaryAddress required | string or null <= 100 characters Address, as sent under |
| primaryAddress2 required | string or null <= 100 characters Unit/Apt #, as sent under |
| primaryCity required | string or null <= 100 characters City, as sent under |
| primaryStateID required | string or null <= 3 characters State, as sent under |
| primaryPostalCode required | string or null <= 20 characters Postal Code, as sent under |
| primaryCountryID required | string or null <= 2 characters ID of the country this record points to. |
| primaryRentOwn required | string or null <= 200 characters Rent / Own, as sent under |
| primaryMonthlyPayment required | string or number or null Monthly payment at the current address, as sent (a JSON number when sent as one); null when not sent. |
| primaryMoveInDate required | string or null <date> Move In Date, as sent under |
| primaryManagerName required | string or null <= 100 characters Manager Name, as sent under |
| primaryManagerPhone required | string or null <= 20 characters Manager Phone, as sent under |
| primaryManagerEmail required | string or null <= 75 characters Manager Email, as sent under |
| primaryReasonForLeaving required | string or null Reason for Leaving, as sent under |
| signature required | string or null <= 100 characters The applicant's signature; null for an application a manager created. |
required | null or object The address history as sent under |
required | null or object The bank accounts as sent under |
required | null or object The credit cards as sent under |
required | null or object The emergency contacts as sent under |
required | null or object The employment history as sent under |
required | null or object The other sources of income as sent under |
required | null or object The occupants as sent under |
required | null or object The animals as sent under |
required | null or object The references as sent under |
required | null or object The vehicles as sent under |
required | Array of objects or null The answers to the template's questions, as sent under |
required | Array of objects or null The acceptances of the template's terms, as sent under |
| addendumSignature required | string or null <= 100 characters The applicant's signature on the addenda; null for an application a manager created. |
| addendumInitials required | string or null <= 100 characters The applicant's initials on the addenda; null for an application a manager created. |
| incomeVerificationReportToken required | string or null <= 200 characters Income verification's report token; null for an application a manager created. |
required | verification_report_statuses (string) or null Income verification status; null for an application a manager created. |
| incomeVerificationReportData required | null The income verification report. Always null for an application a manager created: verification runs only on applications applicants submit. |
| incomeVerificationReportError required | null The income verification error. Always null for an application a manager created: verification runs only on applications applicants submit. |
required | verification_report_statuses (string) or null Identity verification status; null for an application a manager created. |
| identityVerificationReportData required | null The identity verification report. Always null for an application a manager created: verification runs only on applications applicants submit. |
| identityVerificationReportToken required | string or null <= 200 characters Identity verification's report token; null for an application a manager created. |
| identityVerificationPlaidTemplate required | string or null <= 200 characters The identity verification template used; null for an application a manager created. |
| dateTimeCreated required | string When the applicant was created. UTC, formatted |
| dateTimeModified required | string When the applicant was last changed. UTC, formatted |
| startedApplicationID required | string or null^-?[0-9]+$ ID of the started application this record points to. |
| creditReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
| criminalReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
| evictionReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
{- "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"
}
]
}
}
}{- "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
}Returns the core details of a single rental application by its ID, including the application record and its current status.
404 if the application does not exist or is not accessible to the authenticated account.status object reflects both the custom sub-status (applicationStatusID) and the underlying system-level status (primaryApplicationStatusID).GET /screening/applications — list all applicationsGET /screening/applications/{applicationID}/summary — full summary with applicant details and screening dataPOST /screening/applications/{applicationID}/status — update the application status| applicationID required | integer Example: 1702 The unique identifier of the application. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
required | object |
{- "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"
}
}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.
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.GET /screening/applications/{applicationID} — lightweight application record without summary dataGET /screening/applicants/{applicantID}/tab/application — full applicant form data for a specific applicantPOST /screening/reports — order screening reports for applicantsPOST /screening/applications/{applicationID}/status — update the application status| applicationID required | integer Example: 1702 The unique identifier of the application. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "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": [ ],
- "screeningReportModeID": "2"
}
}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).
applicationStatusID must reference a valid system or custom status ID.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.400 if applicationStatusID is missing or invalid.404 if the application does not exist or is not accessible.GET /screening/applications/{applicationID} — retrieve current application statusGET /screening/applications/{applicationID}/summary — full application review data| applicationID required | integer Example: 1702 The unique identifier of the application. |
| applicationStatusID required | string or integer^-?[0-9]+$ ID of the status to set on the application. Common system status IDs:
|
| sendEmail | boolean Default: false Whether to send a notification email to the applicant on status change. |
object Email configuration. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object The updated application record. |
required | object The application status record set by this action. |
{- "applicationStatusID": "6",
- "sendEmail": true,
- "email": {
- "emailTemplateID": "22",
- "copySender": "0",
- "bcc": [
- "manager@example.com"
], - "additionalRecipients": [
- "owner@example.com"
], - "subject": "Your application is approved!",
- "message": "<p>Hello {{ application.applicantNames | list }},</p><p>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.</p><p>Thanks!</p>",
- "attachments": [ ],
- "recipients": [
- "applicant@example.com"
]
}
}{- "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"
}
}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.
builder field structure to display custom application sections and fields404 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.GET /screening/applications/{applicationID}/summary — application-level summary with all applicantsGET /screening/applications/{applicationID} — application core recordPOST /screening/reports — order screening reports for this applicant| applicantID required | integer Example: 1664 The unique identifier of the applicant. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| applicantID required | string^-?[0-9]+$ |
| applicationID required | string^-?[0-9]+$ |
| number required | string or null^-?[0-9]+$ Application reference number. |
| unitID required | string or null^-?[0-9]+$ |
| countryID required | string or null |
| address required | string or null |
| city required | string or null |
| stateID required | string or null |
| postalCode required | string or null |
| firstName required | string or null |
| lastName required | string or null |
| email required | string or null <email> |
| userID | string or null^-?[0-9]+$ Linked Rentvine user account ID, if the applicant has a portal account. |
| applicantContactID | string or null^-?[0-9]+$ ID of the contact record created for this applicant. |
| address2 | string or null |
| moveInDate | string or null <date> Requested move-in date. |
| leaseMonths | string or null Requested lease duration as a human-readable string. |
| middleName | string or null |
| homePhone | string or null |
| cellPhone | string or null |
| workPhone | string or null |
| birthDate | string or null <date> |
| licenseNumber | string or null |
| licenseState | string or null |
| applicantType | string or null Type of applicant (e.g. primary, co-applicant). Null when not specified. |
| ssn | string or null Last 4 digits of the applicant's Social Security Number. |
| addressHistory | object or null Prior address history entries in |
object or null Employment history entries. | |
| occupants | object or null Additional occupants in |
object or null Vehicle information entries. | |
object Dynamic form builder structure defining the application sections and fields. |
{- "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
}
}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.
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 — Credit2 — Criminal3 — EvictionapplicationProviderID in screening settings).400 if any applicant ID does not belong to the specified application or if reportTypeIDs is empty.GET /screening/applications/{applicationID}/summary to check report status.GET /screening/settings — verify screening provider is configuredGET /screening/applications/{applicationID}/summary — check report status after orderingGET /screening/applicants/{applicantID}/tab/application — view applicant details before ordering| applicationID required | string or integer^-?[0-9]+$ ID of the application to order reports for. |
| applicantIDs required | Array of integers non-empty List of applicant IDs to run reports for. All must belong to the specified application. |
| reportTypeIDs required | Array of integers non-empty Items Enum: 1 2 3 List of report type IDs to order.
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
Confirmation that screening report requests were submitted.
{- "applicationID": "1702",
- "applicantIDs": [
- 1664
], - "reportTypeIDs": [
- 1,
- 2,
- 3
]
}{- "success": true,
- "message": "Screening reports have been ordered"
}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.
customFieldCategoryObjectTypeID values for use in POST /custom-field-categories and GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}categoryCount reflects the total number of custom field categories assigned to this object typefieldCount reflects the total number of individual custom fields across all categories for this object typeGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list all categories and fields for a specific object typePOST /custom-field-categories — create a new custom field category under one of these object typesGET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for an object| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldCategoryObjectTypeID required | string^-?[0-9]+$ Unique identifier for the object type. Use this value as |
| categoryCount required | string Total number of custom field categories configured for this object type. |
| fieldCount required | string Total number of individual custom fields across all categories for this object type. |
[- {
- "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"
}
]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.
customFieldID keys when constructing a payload for POST /custom-fields/values/{objectTypeID}/{objectID}customFieldCategoryObjectTypeID must be a valid ID from GET /custom-field-category-object-typesorderIndexcustomFields array listing all fields in that category, ordered by their own orderIndexsettings property is a JSON-encoded string that may contain a description and an options array for dropdown (fieldTypeID: 3) fieldsGET /custom-fields/values/{objectTypeID}/{objectID} for thatGET /custom-field-category-object-types — list all available object typesGET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for a specific objectPOST /custom-fields/values/{objectTypeID}/{objectID} — save field values for a specific objectPOST /custom-field-categories — create a new category under this object type| customFieldCategoryObjectTypeID required | integer Example: 1 The ID of the object type whose categories and fields should be returned. Obtain valid IDs from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldCategoryID required | string^-?[0-9]+$ Unique identifier for the custom field category. |
| customFieldCategoryObjectTypeID required | string^-?[0-9]+$ The object type this category belongs to. |
| name required | string Display name of the category. |
| orderIndex required | string^-?[0-9]+$ Sort position of the category relative to others for this object type. |
required | Array of objects Ordered list of custom field definitions in this category. Empty array if no fields have been added yet. |
[- {
- "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": [ ]
}
]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.
name and customFieldCategoryObjectTypeID together must be unique — a category with the same name cannot be created more than once for the same object typecustomFieldCategoryObjectTypeID must reference a valid object type from GET /custom-field-category-object-typesGET /custom-field-category-object-types — list available object types to find a valid customFieldCategoryObjectTypeIDGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — verify the new category appears in the list after creationGET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for objects in this category's object type| name required | string Display name for the new custom field. Must be unique within the given category. |
| customFieldCategoryObjectTypeID required | string or integer^-?[0-9]+$ ID of the object type this category belongs to. Obtain valid values from |
| customFieldCategoryID required | string or integer^-?[0-9]+$ ID of the category this field will be added to. |
| fieldTypeID required | string or integer Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8 Controls the input type rendered for this field.
|
| options | string JSON-encoded array of options for Dropdown fields. Use |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
required | object |
{- "name": "test-docs",
- "fieldTypeID": 1,
- "options": "[]",
- "customFieldCategoryID": "43",
- "customFieldCategoryObjectTypeID": "1"
}{- "customField": {
- "customFieldID": "610",
- "customFieldCategoryID": "43",
- "name": "test-docs",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "1",
- "settings": "{\"description\":null}",
- "orderIndex": "7",
- "valueColumn": "text_12"
}
}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.
Administration › ManageCustomFields), checked
before anything else: a key without it gets the 403 whatever the body or ID.customFieldCategoryID with no category answers 400 Custom Field Category {customFieldCategoryID} not found; one that isn't all digits (abc, -1) answers the stock 404.GET /custom-field-categories (undocumented) - the account's categoriesDELETE /custom-fields/{customFieldID} - delete one field| customFieldCategoryID required | integer Example: 7 The category, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldCategoryID required | string^-?[0-9]+$ The primary key of the category. |
| customFieldCategoryObjectTypeID required | string (custom_field_category_object_types) Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13" The record type the category's fields belong to.
|
| name required | string <= 200 characters The category's name. |
| orderIndex required | string^-?[0-9]+$ The category's position among the record type's categories, from |
{- "customFieldCategoryID": "7",
- "customFieldCategoryObjectTypeID": "5",
- "name": "Access details",
- "orderIndex": "0"
}Deletes a custom field and clears its value on every record of its record type. Returns the deleted field.
Administration › ManageCustomFields), checked
before anything else: a key without it gets the 403 whatever the body or ID.customFieldID with no field answers 400 Custom Field {customFieldID} not found; one that isn't
all digits (abc, -1) answers the stock 404.GET /custom-fields/values/{objectTypeID}/{objectID} - a record's custom field valuesDELETE /custom-field-categories/{customFieldCategoryID} - delete a whole category and its fields| customFieldID required | integer Example: 21 The custom field, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldID required | string^-?[0-9]+$ The primary key of the custom field. |
| customFieldCategoryID required | string^-?[0-9]+$ The category the field is grouped under. |
| name required | string <= 200 characters The field's name, shown as its label. |
| fieldTypeID required | string (custom_field_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" The kind of value the field holds.
|
| customFieldCategoryObjectTypeID required | string (custom_field_category_object_types) Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13" The record type the field belongs to, from its category.
|
| settings required | string or null The field's settings (its description, and a dropdown's options) as a JSON-encoded string, such as |
| orderIndex required | string^-?[0-9]+$ The field's position within its category, from |
| valueColumn required | string or null <= 20 characters The internal column the field's values are stored in ( |
{- "customFieldID": "21",
- "customFieldCategoryID": "27",
- "name": "Gate code",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":\"Side gate code\"}",
- "orderIndex": "0",
- "valueColumn": "text_1"
}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.
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 typenull for the value propertycustomFieldCategoryID and ordered by orderIndexsettings property is a JSON-encoded string containing field metadata such as dropdown options and descriptionPOST /custom-fields/values/{objectTypeID}/{objectID} — save or update field values for the objectGET /custom-field-category-object-types — list all object types and their category countsGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list categories and fields for an object type| objectTypeID required | integer Example: 5 The ID of the object type (e.g., |
| objectID required | integer Example: 577 The unique ID of the specific object whose custom field values are being retrieved. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldCategoryID required | string^-?[0-9]+$ Unique identifier for the custom field category. |
| customFieldCategoryObjectTypeID required | string^-?[0-9]+$ The object type this category belongs to. |
| name required | string Display name of the custom field category. |
| orderIndex required | string^-?[0-9]+$ Sort order of the category relative to other categories for this object type. |
required | Array of objects Ordered list of custom fields within this category, each including the current value for the object. |
[- {
- "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
}
]
}
]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.
nullobjectTypeID and objectID in the path must match a valid objectcustomFieldID values cast to stringscustomFieldCategoryID is required in the payload to scope the write to the correct categorynull clears any previously stored valueGET /custom-fields/values/{objectTypeID}/{objectID})GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve current field values for the objectGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list categories and fields to know which customFieldID keys are valid| objectTypeID required | integer Example: 5 The ID of the object type (e.g., |
| objectID required | integer Example: 577 The unique ID of the specific object whose custom field values are being saved. |
| customFieldCategoryID required | string or integer^-?[0-9]+$ The ID of the category being updated. All field IDs in the payload must belong to this category. |
| property name* additional property | string or null A custom field value keyed by its |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| customFieldCategoryID required | string^-?[0-9]+$ Unique identifier for the custom field category. |
| customFieldCategoryObjectTypeID required | string^-?[0-9]+$ The object type this category belongs to. |
| name required | string Display name of the custom field category. |
| orderIndex required | string^-?[0-9]+$ Sort order of the category. |
required | Array of objects Updated list of custom fields with their latest values. |
{- "364": null,
- "469": "test",
- "customFieldCategoryID": "96"
}[- {
- "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
}
]
}
]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 |
|---|---|
| 1 | Account |
| 2 | User |
| 3 | Contact |
| 4 | Lease |
| 5 | Bill |
| 6 | Property |
| 7 | Unit |
| 8 | Deposit |
| 9 | Accounting Transaction |
| 10 | Accounting Transaction Entry |
| 11 | Portfolio |
| 12 | Payout |
| 13 | Bank Adjustment |
| 14 | Company |
| 15 | Statement |
| 16 | Work Order |
| 17 | Inspection |
| 18 | Inspection Area |
| 19 | Inspection Item |
| 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 | Vendor Bill |
| 34 | Document Transaction |
| 35 | Document Envelope |
| 36 | Application Template |
| 37 | Recurring Bill |
| 38 | Chat Message |
| 39 | Reconciliation |
| 40 | Path |
| 41 | Payout Return |
| 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 |