Rentvine API Docs (2026.11.16)

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.

Authentication

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

Obtaining API Keys

  1. In your Rentvine dashboard navigate to Settings > Users, Roles and API > API
  2. Select New API Key
  3. Enter a reference name in the Name field and select a predefined role in the Role dropdown

    ℹ️ Roles need to be setup before creating an API key. Create Roles via the Roles tab.

  4. Copy the generated Access Key and Secret. You will not be able to view the Secret again after closing this form.

Rate Limits

Every request counts against several limits at once. A request that would go over any of them is refused with 429 Too Many Requests and isn't run.

Limit What it counts Allowance
Per API key (api-key) Every request made with one API key 120 requests per 60 seconds. You can send all 120 at once; they come back at 2 per second.
Per user (user) Every request one user makes 1,200 requests per minute. Each API key is a user of its own, so for API traffic the per-key limit is reached first.
Per account (account) Every signed-in request on your Rentvine account: every API key, everyone using the Rentvine app, and residents, owners and applicants in their portals 10,000 requests per minute
Per partner app (client) Every request from one registered partner app, on every account it serves: requests that identify the app (Rentvine-App-* headers) 6,000 requests per minute
Per IP address (ip) Every request from one IP address, counted before sign-in, so it includes requests that fail to sign in and requests another limit refuses 6,000 requests per minute
Exports (endpoint) GET /leases/export, GET /properties/export, GET /properties/units/export, GET /screening/applications/export and GET /accounting/positive-pay/export (undocumented), each separately, per API key 60 per hour: 10 at once, then one a minute
Reports (endpoint) Running or sending a report through the report endpoints under /reports (not documented here yet), all together, per API key; the manager-ledger reports (/reports/ledger…) aren't counted 20 per hour: 5 at once, then one every 3 minutes

The per-user, per-account, per-partner-app and per-IP limits count in clock minutes: the whole allowance is back at the start of each minute. The per-key, export and report limits refill continuously instead.

Rate-limit headers

Responses carry two headers, as the IETF rate-limit headers draft 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.

When you get a 429

The 429 carries Retry-After, the seconds to wait before sending the request again, plus the two headers above. Recognise a 429 by its status.

A refused request isn't counted against the limit that refused it or any other limit counted after sign-in, but every request is counted against the per-IP limit before anything else, refused ones included, unless the per-IP limit itself refused it.

Backing off

  1. Watch RateLimit on every response. The item with the lowest r is the limit that refuses your next request to that operation first; slow down before it reaches 0 instead of waiting for the 429. Keep an eye on account too: everyone on your account draws on it.
  2. On a 429, wait Retry-After seconds, then retry the same request. It wasn't run, so retrying is safe, even for a write. For a per-minute limit Retry-After can be longer than the time left in the minute; waiting for it is always enough.
  3. Back off further if 429s keep coming: double the wait after each one in a row, up to a few minutes, with some random jitter so parallel workers don't retry in step. Go back to your normal pace after the first success.
  4. Spread work out rather than sending it in bursts, and keep parallel requests on one key few: they all draw on the same 120 a minute. More keys don't add capacity past your account's limit, and requests from one machine share its IP address's limit, which the headers on signed-in responses don't show.

Changelog

Changes to the Manager API and to this reference since November 12, 2026, newest first. Each entry is dated the day the change merged; it appears on docs.rentvine.com with the next Rentvine release, usually within a week.

Entries that correct the reference to match what the API already does are marked Reference only: the API's behavior did not change, but code or types generated from the earlier spec may need updating.

2026-11-16

  • Rate limits are enforced. A request over any limit is now refused with 429 Too Many Requests and isn't run. Until now the limits only counted requests: responses already carried the RateLimit-Policy and RateLimit headers, and a response over a limit showed r=0 and a Retry-After, but the request still ran. Every limit is enforced: per API key (120 requests per 60 seconds), per user, per account, per partner app, per IP address, and the export and report limits. On a 429, wait the Retry-After seconds, then send the request again. Rentvine can relax every limit except the per-IP one for a single account, user or API key. Rate Limits lists each limit and how to back off.

Reference only.

  • Rate limits. A new Rate Limits section in the Overview describes each limit and its allowance, the RateLimit-Policy and RateLimit headers, the 429 and its Retry-After, and how to back off. Every operation now documents the 429 response, and every response the two headers.
  • Newly documented operations. 37 operations the API already served are now in the reference:
    • Chart of accounts: POST /accounting/accounts; GET, POST and PUT /accounting/accounts/{accountID}; and GET /accounting/bank-accounts.
    • Bank reconciliations: GET and POST /accounting/reconciliations; GET and DELETE /accounting/reconciliations/{reconciliationID}, where DELETE voids the reconciliation; GET /accounting/transactions/{transactionID}; and POST /accounting/transactions/{transactionID}/reconcile and /unreconcile.
    • Lease transactions: DELETE on /accounting/leases/charges/{transactionID}, /payments/{transactionID}, /credits/{transactionID}, /refunded-returns/{transactionID} and /deposit-release-credits/{transactionID}, each of which voids the transaction (it keeps its history; nothing is deleted); POST /accounting/leases/payments/{transactionID}/return; and POST /accounting/leases/{leaseID}/refunded-returns, /deposit-release-credits and /payouts.
    • Lease pets: GET and POST /leases/{leaseID}/pets, and GET, POST and DELETE /leases/{leaseID}/pets/{leasePetID}.
    • Files: GET /files, GET /files/search, and GET, POST and DELETE /files/{fileID}.
    • Custom fields: DELETE /custom-fields/{customFieldID} and DELETE /custom-field-categories/{customFieldCategoryID}. Deleting a field clears its value on every record; deleting a category deletes every field in it.
    • Applications: POST /screening/applications creates an application from one of the account's templates, which GET /screening/templates lists.
    • PUT /accounting/deposits/{depositID} and PUT /properties/{propertyID}/units/{unitID}, which do the same as the POST on the same path.
  • Properties and units. The property and unit operations were checked against the API and corrected. The changes most likely to affect a client:
    • GET /properties/{propertyID}/units returns each unit under unit, and documents page, pageSize, search, isActive and includes. GET /properties/{propertyID}/units/{unitID} returns the unit under unit, beside the related records includes asks for. The reference had shown bare unit objects.
    • The leaseBalances and portfolioBalances includes are objects, not arrays.
    • GET /properties pages 15 items by default, not 25.
    • When DELETE /properties/{propertyID} or DELETE /properties/{propertyID}/units/{unitID} is refused because of the property's or unit's history, the 400 has one key per kind of record that blocks it, for example {"leases": ["..."]}, or unit.applications for a unit of the property; the reference had listed only transactions. An ID with no property or unit returns 400 {"error": "Property {propertyID} not found"} (or Unit), and an ID that isn't a number returns 404.
    • POST /properties/{propertyID} doesn't change portfolioID or isMultiUnit; the reference had listed them in the request body.
    • activateUnit on POST /properties/{propertyID}/activate is 0 or 1.
    • POST /properties/{propertyID}/units requires address, city and stateID.
    • GET /properties/listings/search excludes property types with notPropertyTypeID[]; the reference had named it notPropertyTypeIDs.
    • GET /properties/search now also documents propertyIDs[], propertyManagerIDs[], city, stateID, postalCode, dateTimeModifiedMin, dateTimeModifiedMax and orderBy.
  • Contacts. The association, maintenance technician, owner, tenant and vendor read operations were checked against the API and corrected:
    • Each item of GET /owners, /tenants, /vendors, /associations and /maintenance-technicians is {"contact": {...}, "token": "..."}. The reference had shown GET /owners items as bare contacts, and no list included token.
    • Each result of their /search operations carries search.rank when search is sent.
    • The contact returned by GET /owners/{contactID}, /tenants/{contactID}, /vendors/{contactID}, /associations/{contactID} and /maintenance-technicians/{contactID} also includes isTaxIdentifierValid, taxIdentifierTypeID and taxIdentifierCountryID. An ID with no contact of that type returns 400, for example {"error": "Owner {contactID} not found"}; an ID that isn't a number returns 404. A vendor's reviewStats is an array.
    • Yes/no filters take 0 or 1, and array filters are named with brackets, for example contactIDs[]. The search operations document the tax identifier filters (hasTaxIdentifier, isTaxIdentifierValid, taxIdentifierTypeIDs[] and hasDuplicateTaxIdentifier).
    • GET /vendors/search takes no includes, and GET /owners/search has no insurance expiry filters; the reference had listed both.
  • Other corrections.
    • GET /accounting/ledgers needs search or ledgerIDs[]; without either it returns a 400 whose body is the JSON string "Search Failed".
    • depositNumber in the body of POST /accounting/deposits/{depositID} is a string, not null, and the operation documents its 404.

2026-11-13

Reference only.

  • Response types match what the API sends. Response fields are now documented with the JSON types the API returns:

    • IDs, counts and other whole numbers are strings of digits, for example "117".
    • Yes/no flags are the strings "0" and "1".
    • Money and other decimal amounts are strings, for example "1600.00".
    • Timestamps are UTC strings in the form YYYY-MM-DD HH:MM:SS, and dates are YYYY-MM-DD.
    • Fields that can be empty are marked nullable.

    These rules cover values read from the database. A value the API computes keeps the type its field documents: for example, a lease's rentAmount and a predicted invoice line item's amount are numbers. Request bodies accept either the string or the number form. Path parameters such as {propertyID} are unchanged.

  • Fields that changed shape.

    • addressValidationData on a property or unit, and diagnosticSummary on a bill's work order, are objects (or null), not strings.
    • The lineItems of GET /accounting/invoices/{invoiceID} take one of two shapes. An invoice created in Rentvine returns rows with invoiceLineItemID and a string amount; any other invoice returns predicted items with no invoiceLineItemID, and amount, unitPrice and quantity as numbers or null. Check for invoiceLineItemID before reading amount.
  • Enumerated fields list every value. Most status and type fields that reference a shared list of values now document those values as the strings the API sends, with their current labels. Values added to the lists include property type 11 (Lot), work order primary status 5 (Cancelled), contact types 7 (Screening Prospect), 8 (Internal Technician) and 9 (Owner Lead), source type 7 (Ai) and transaction type 25 (Lease Refunded Return). payoutTypeID 1 is Other (paid outside Rentvine); the reference had called it Cash.

  • Error responses. A 400 is documented as either a single message, {"error": "..."}, or a map of validation messages keyed by field. A 403 documents each body the API sends, including the ELEVATION_REQUIRED error and the empty body some checks return. A 401 is {"code": 401, "error": "..."}, with code a number; the 29 operations that documented no error response now document it. A 404 from the resident services and packages operations is {"code": "404", "error": "Not Found", "message": "..."}, with code a string.

  • Modified-date filters. dateTimeModifiedMin and dateTimeModifiedMax are inclusive and read the time as UTC; a time zone offset in the value is ignored. A date alone means midnight. Encode + as %2B: an unencoded + is read as a space and the time is lost. A value the API can't read is ignored, and the list comes back unfiltered.

  • Operation IDs. Every operation now has an operationId; 28 operations that had none were named.

  • Corrections to individual operations.

    • GET /leases/{leaseID}/recurring-charges declares its leaseID path parameter.
    • Transaction entries no longer list transactionID and ledgerID as required; the API doesn't send them.
    • The request body of POST /properties no longer marks propertyImageID as required. The API doesn't read it from the request; the created property in the response still includes it.
    • screeningReportModeID in GET /screening/applications/{applicationID}/summary is documented as 0 (Disabled), 1 (Package) or 2 (Dynamic); the earlier description gave 1 and 2 other meanings. It is a string, except for an account with no screening settings, which gets the integer 0.
    • GET /properties/{propertyID}/images/{imageHash}/{size}.jpeg no longer lists account as a path parameter; the account is the server's subdomain.
    • Related Endpoints links point at real paths. The bill links carry the /accounting prefix, a lease is updated with POST /leases/{leaseID} (there is no PUT), and a unit's listing is at GET /properties/{propertyID}/units/{unitID}/listing.

2026-11-12

  • Export limits. GET /leases/export, GET /properties/export, GET /properties/units/export and GET /screening/applications/export each count against a limit of their own for each API key: 60 an hour, 10 of them at once. Responses list it as endpoint in the RateLimit-Policy and RateLimit headers. Like every other limit at the time, it counted requests without refusing any.

Reference only.

  • Bill paths. The bill operations are documented at their real path, /accounting/bills/{billID} (GET, POST and DELETE). The reference listed them under /accounting/{billID}, which doesn't exist.
  • Contact payment fields. On the association, maintenance technician, owner, tenant and vendor operations, payoutTypeID and achAccountTypeID now list their values; the reference had pointed them at a file that doesn't exist.
  • Valid OpenAPI 3.1. The spec now validates as OpenAPI 3.1, so code generators and validators can read every schema:
    • Nullable fields use type: [..., 'null'] instead of the OpenAPI 3.0 keyword nullable.
    • datePostedMin and datePostedMax are strings in date format.
    • The accounting search parameter is a string.
    • The accounting *IDs[] array parameters declare integer items.
    • primaryWorkOrderStatusID values are strings, as the API sends them.

Leases

Export Leases

List Leases for Export

The Last Modified Timestamp on Leases is updated by multiple actions including, but not limited to, the following.

  • Updating lease detaila in the manager portal
  • Taking actions such as activate, renewal, move out, rent increase etc.
  • Residents initiating move out process
  • Disabling or enabling portal or portal payment access actions.
  • Lease Transactions such as charges, credit, and payment are created, updated, or voided.
  • When tenant, occupant, pet, or vehicle information is added, updated or deleted.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (lease_export)
object (balances)
object (unpaid_charges)
object (property_export)
object (unit_export)
object (portfolio_export)

Response samples

Content type
application/json
[
  • {
    }
]

Properties

Export Properties

List Properties for Export

The Last Modified Timestamp on Properties is updated by multiple actions including, but not limited to, the following.

  • Updating property details in the manager portal
  • Updating groups and associations
  • Activating or deactivating property or portfolio
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object
object (portfolio_export)

Response samples

Content type
application/json
[
  • {
    }
]

Units

Export Units

List Units for Export

The Last Modified Timestamp on Units is updated by multiple actions including, but not limited to, the following.

  • Updating unit details in the manager portal
  • Creating or updating listings
  • Updating Appliance information
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (property_export)
object

Response samples

Content type
application/json
[
  • {
    }
]

Applications

Export Applications

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.

Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (application_export)
object (unit_export)
object

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

List Accounts

Returns a paginated list of chart-of-accounts records. Each item contains a full account object.

Use Cases

  • Filter accounts by type (e.g. Bank, Expense, Income) using accountTypeID or accountTypeIDs.
  • Narrow the list to active-only or escrow-only accounts using isActive and isEscrow.

Business Rules

  • Results are scoped to the authenticated user's portfolio.
  • GET /accounting/accounts/search - Search with additional filters (accountID, dateTimeModified range).
  • GET /accounting/accounts/{accountID} - Retrieve a single account with optional includes.
Authorizations:
basicAuth
query Parameters
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.

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
accountTypeIDs
Array of integers
Example: accountTypeIDs=3&accountTypeIDs=7

Array form of the account type filter. Takes precedence over accountTypeID. Use when the client sends array-style query parameters (e.g. accountTypeIDs[]=3&accountTypeIDs[]=7).

isActive
boolean
Example: isActive=true

Filter by active status. true returns active accounts, false returns inactive accounts.

isEscrow
boolean

Filter to accounts flagged as escrow accounts.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (account)
token
required
string

Session token associated with this response.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Create Account

Creates a chart-of-accounts account and answers with it as GET /accounting/accounts/{accountID} reads it. A bank account (accountTypeID 3) also takes its routing and account numbers, which are stored encrypted and never returned.

Use Cases

  • Add an income or expense account to the chart of accounts before posting charges or bills to it.
  • Set up a bank account with its routing and account numbers, and optionally check printing and NACHA payout files.
  • Add a sub-account under an existing account of the same type.

Business Rules

  • Requires the Manage Chart Of Accounts permission (Administration › ManageChartOfAccounts). A bank account also requires Manage Bank Accounts (Administration › ManageBankAccounts). Either missing answers 403 {"error": "Permission Denied"}.

  • accountTypeID, number and name are required, and a bank account also needs bankAccount.routingNumber and bankAccount.accountNumber. With no accountTypeID, or one that isn't an account type, the API answers 400 with an error (Account type is required to create the account state, State class not defined for this account type) before it checks any other field.

  • A bank account's numbers are checked first: when they fail, the 400 lists only the bankAccount.* messages. Then the account's own fields are checked, and every failure is listed, keyed account.<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.

Side Effects

  • A bank account's routing and account numbers are encrypted into a stored record (its ID is the account's bankAccountCiphertextID), and bankAccountNumberTruncated is set to the account number's last 4 digits.
  • The first bank account created when the accounting settings have no default bank account becomes the default (defaultBankAccountID in GET /accounting/settings (undocumented)).
  • An "Account Created" entry is added to the account's activity log, which GET /logs/{objectTypeID}/{objectID} (undocumented) lists for object type 54.
  • 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.
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=accountCategory,currentReconciliation

Comma-separated list of related records to add to the response, each under its own key: accountCategory, checkTemplate, currentReconciliation, unprintedCheckCount, positivePayGateway. Unknown names are ignored.

Request Body schema: application/json
required
non-empty
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.

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
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 GET /accounting/accounts.

accountCategoryID
string or integer or null^-?[0-9]+$

Account category, one of the same account type, from GET /accounting/account-categories (undocumented).

isSubjectToManagementFees
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether charges posted to the account are subject to management fees. Default 0.

isSubjectToLateFees
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether charges posted to the account are subject to late fees. Default 0.

isDeposit
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account tracks security deposits. Can't be combined with isPrepayment. Default 0.

(deposit_types_request (string or integer)) or null

Deposit type, for a deposit account. When isDeposit is 1 and no type is set, 1 (General). Turning isDeposit off doesn't clear it.

  • 1 - General
  • 2 - Pet
  • 3 - Cleaning
  • 4 - Key
  • 200 - Other
isEscrow
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account holds escrow funds. Default 0.

isRent
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account is classified as rent. Default 0.

isSubsidized
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account is subsidized. Default 0.

isTaxable
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether charges to the account are taxable. Default 0.

isSubjectToSalesTax
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether charges to the account are subject to sales tax. Default 0.

isSubjectToMarkup
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether charges to the account can be marked up. Default 1.

isPrepayment
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account holds prepayments. Can't be combined with isDeposit. Default 0.

isManagementFee
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account represents a management fee. Default 0.

isBudgetEnabled
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether budget tracking is on for the account. Default 0.

isHeld
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether funds in the account are held. Default 1 where the account's type keeps it.

bankName
string or null <= 100 characters

Bank name (bank accounts). Required when isCheckingEnabled is 1.

(bank_account_types_request (string or integer)) or null

Savings or checking (bank accounts). Required when isCheckingEnabled is 1.

  • 1 - Savings
  • 2 - Checking
bankAccountAddress
string or null <= 100 characters

Bank's address, line 1 (bank accounts). Required when isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

bankAccountStateID
string or null

Bank's state or province code (bank accounts), as GET /states (undocumented) lists it for the country. Required when isCheckingEnabled is 1.

bankAccountPostalCode
string or null <= 20 characters

Bank's postal code (bank accounts). Required when isCheckingEnabled is 1.

bankAccountCountryID
string or null

Bank's country code, from GET /countries (undocumented). US when a state is sent without a country, and cleared when no state is sent.

bankAccountNextDepositNumber
string 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 0.

checkCompanyName
string or null <= 100 characters

Name printed on checks. Required when isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

checkAddress2
string or null <= 100 characters

Address printed on checks, line 2.

checkCity
string or null <= 100 characters

City printed on checks. Required when isCheckingEnabled is 1.

checkStateID
string or null

State printed on checks, as GET /states (undocumented) lists it. Required when isCheckingEnabled is 1.

checkPostalCode
string or null <= 20 characters

Postal code printed on checks. Required when isCheckingEnabled is 1.

checkCountryID
string or null

Country printed on checks; US when a state is sent without a country, cleared when no state is sent.

checkTemplateID
string or integer or null^-?[0-9]+$

Check template, from GET /checks/templates (undocumented). Required when isCheckingEnabled is 1.

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 0.

isNachaFileBalanced
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether the account's NACHA files are balanced. Default 1; set to 0 when NACHA is off.

nachaOriginName
string or null <= 100 characters

NACHA immediate origin name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginNumber
string or null <= 20 characters

NACHA immediate origin number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationName
string or null <= 100 characters

NACHA immediate destination name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationNumber
string or null <= 20 characters

NACHA immediate destination number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyIdentification
string or null <= 20 characters

NACHA company identification. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyName
string or null <= 100 characters

NACHA company name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginatingFinancialInstitutionID
string or null <= 20 characters

NACHA originating financial institution. Required when isNachaEnabled is 1; cleared when it is 0.

nachaAdapterID
string or integer or null^-?[0-9]+$

NACHA file format: 1 Standard, 2 Chase, 3 Owner Funds. Not validated: any other value is stored and read as 1.

isBillApprovalExempt
string or integer (account_flag_request)
Enum: "0" "1" 0 1

Whether bills posted to the account skip bill approval. Default 0.

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 0. Send importSourceKey with it; the API doesn't require it.

importSourceKey
string or null

The import's key for the account, unique among imported accounts. Kept only when isFromImport is 1; with isFromImport 1 and no key, the account is created with a null key.

creditCardGatewayID
string 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 accountTypeID is 3 (Bank), and ignored for every other type. They are stored encrypted; responses carry only bankAccountNumberTruncated (the account number's last 4 digits).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 accountCategory include.

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 checkTemplate include.

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: bankAccountID and a statementEndingBalance of 0 (a JSON number), every other key null. Requires the currentReconciliation include.

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 unprintedCheckCount include.

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 positivePayGateway include.

Request samples

Content type
application/json
Example
{
  • "accountTypeID": 7,
  • "number": "4150",
  • "name": "Pet Rent Income",
  • "isRent": 1,
  • "isSubjectToManagementFees": 1,
  • "isSubjectToLateFees": 1,
  • "isTaxable": 0
}

Response samples

Content type
application/json
Example
{
  • "account": {
    }
}

Search Accounts

Returns a paginated, searchable list of chart-of-accounts records joined with their account category. Each result item contains a full account object and an accountCategory object (all fields null when no category is assigned).

This endpoint is the preferred way to search accounts with advanced filters such as accountID lookup.

Use Cases

  • Look up a single account by accountID.

Business Rules

  • The accountCategory object is always present; its fields are null when the account has no category assigned.
  • isActive and isEscrow accept boolean values (true/false or 1/0).
  • dateTimeModifiedMin and dateTimeModifiedMax accept ISO 8601 datetime strings.
  • GET /accounting/accounts - Simpler list endpoint with a 5000 default page size.
  • GET /accounting/accounts/{accountID} - Retrieve a single account with optional includes.
Authorizations:
basicAuth
query Parameters
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. true returns active accounts, false returns inactive.

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).

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
accountID
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (account)
required
object or null

Account category associated with this account, or null fields when uncategorized.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Get Account

Returns one chart-of-accounts account, with the related records the includes parameter asks for. A bank account's routing and account numbers aren't part of it: the response carries only the account number's last 4 digits (bankAccountNumberTruncated).

Use Cases

  • Read an account's settings before changing it with POST /accounting/accounts/{accountID}.
  • Check a bank account's current reconciliation and how many checks wait to be printed.

Business Rules

  • No permission is checked beyond a valid API key, and portfolio restrictions don't apply: the chart of accounts is account-wide.
  • An ID with no account answers 400 {"error": "Account <id> not found"}; so does 0.

Available Includes (5)

  • accountCategory - The account's category, or null.
  • checkTemplate - The check template the account prints with, or null.
  • currentReconciliation - The current reconciliation, or an unsaved placeholder when there is none.
  • unprintedCheckCount - How many of the account's check payouts wait to be printed (a JSON number).
  • positivePayGateway - The account's positive pay gateway, or null.
  • GET /accounting/accounts - List accounts.
  • GET /accounting/bank-accounts - List the bank accounts.
  • POST /accounting/accounts/{accountID} - Change the account.
Authorizations:
basicAuth
path Parameters
accountID
required
integer
Example: 31

The account's ID, from GET /accounting/accounts or GET /accounting/bank-accounts.

query Parameters
includes
string
Example: includes=accountCategory,currentReconciliation

Comma-separated list of related records to add to the response, each under its own key: accountCategory, checkTemplate, currentReconciliation, unprintedCheckCount, positivePayGateway. Unknown names are ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 accountCategory include.

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 checkTemplate include.

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: bankAccountID and a statementEndingBalance of 0 (a JSON number), every other key null. Requires the currentReconciliation include.

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 unprintedCheckCount include.

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 positivePayGateway include.

Response samples

Content type
application/json
Example
{
  • "account": {
    }
}

Update Account

Changes a chart-of-accounts account and answers with it as GET /accounting/accounts/{accountID} reads it. Send only the fields to change. The account type can't change, and this operation doesn't activate or deactivate an account or change a bank account's routing and account numbers.

Use Cases

  • Rename or renumber an account, or move it under another parent.
  • Turn management fees, late fees or tax on or off for the charges an account takes.
  • Change a bank account's check printing or NACHA settings.

Business Rules

  • Requires the Manage Chart Of Accounts permission (Administration › ManageChartOfAccounts). Changing a bank account also requires Manage Bank Accounts (Administration › ManageBankAccounts). Either missing answers 403 {"error": "Permission Denied"}.
  • An ID with no account answers 400 {"error": "Account <id> not found"}, after the empty-body check.
  • Only the fields of the request schema are read; any other key is ignored. A different accountTypeID is refused (Cannot change the account type).
  • A new parent can't be the account itself (Cannot select parent as self) or one of its sub-accounts (Cannot select this parent - circular reference). The other field rules are the create's: number at most 10 characters and unique under the parent, name at most 100, a category of the same type, not both isDeposit and isPrepayment, and on a bank account the check and NACHA fields required when those are on.
  • The account type decides which fields the account keeps, as on POST /accounting/accounts: fields its type doesn't keep go back to 0 or null whatever the request sends.
  • Send includes to get the account's includes in the response. Without it the response has only account.

Side Effects

  • An "Updated Account" entry listing the changed fields is added to the account's activity log (GET /logs/{objectTypeID}/{objectID} (undocumented), object type 54) when anything changed.
  • On a bank account with a remote check printing gateway, a new checkSignatory deletes that gateway and emails Rentvine support that remote check printing was turned off for the bank account.
  • GET /accounting/accounts/{accountID} - Read the account.
  • PUT /accounting/accounts/{accountID} - The same operation as a PUT.
  • POST /accounting/accounts - Create an account.
Authorizations:
basicAuth
path Parameters
accountID
required
integer
Example: 31

The account's ID, from GET /accounting/accounts or GET /accounting/bank-accounts.

query Parameters
includes
string
Example: includes=accountCategory,currentReconciliation

Comma-separated list of related records to add to the response, each under its own key: accountCategory, checkTemplate, currentReconciliation, unprintedCheckCount, positivePayGateway. Unknown names are ignored.

Request Body schema: application/json
required
non-empty
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 (Cannot change the account type); a value that isn't an account type answers 400 with an error (State class not defined for this account type), and null with Account type is required to create the account state.

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
parentAccountID
string or integer or null^-?[0-9]+$

Parent account, for a sub-account, from GET /accounting/accounts: not the account itself, and not one of its own sub-accounts. Use one of the same type: the create checks it, the update doesn't.

accountCategoryID
string or integer or null^-?[0-9]+$

Account category, one of the same account type, from GET /accounting/account-categories (undocumented).

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 isPrepayment.

(deposit_types_request (string or integer)) or null

Deposit type, for a deposit account. When isDeposit is 1 and no type is set, 1 (General). Turning isDeposit off doesn't clear it.

  • 1 - General
  • 2 - Pet
  • 3 - Cleaning
  • 4 - Key
  • 200 - Other
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 isDeposit.

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 isCheckingEnabled is 1.

(bank_account_types_request (string or integer)) or null

Savings or checking (bank accounts). Required when isCheckingEnabled is 1.

  • 1 - Savings
  • 2 - Checking
bankAccountAddress
string or null <= 100 characters

Bank's address, line 1 (bank accounts). Required when isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

bankAccountStateID
string or null

Bank's state or province code (bank accounts), as GET /states (undocumented) lists it for the country. Required when isCheckingEnabled is 1.

bankAccountPostalCode
string or null <= 20 characters

Bank's postal code (bank accounts). Required when isCheckingEnabled is 1.

bankAccountCountryID
string or null

Bank's country code, from GET /countries (undocumented). US when a state is sent without a country.

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 isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

checkAddress2
string or null <= 100 characters

Address printed on checks, line 2.

checkCity
string or null <= 100 characters

City printed on checks. Required when isCheckingEnabled is 1.

checkStateID
string or null

State printed on checks, as GET /states (undocumented) lists it. Required when isCheckingEnabled is 1.

checkPostalCode
string or null <= 20 characters

Postal code printed on checks. Required when isCheckingEnabled is 1.

checkCountryID
string or null

Country printed on checks; US when a state is sent without a country.

checkTemplateID
string or integer or null^-?[0-9]+$

Check template, from GET /checks/templates (undocumented). Required when isCheckingEnabled is 1.

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 0 when NACHA is off.

nachaOriginName
string or null <= 100 characters

NACHA immediate origin name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginNumber
string or null <= 20 characters

NACHA immediate origin number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationName
string or null <= 100 characters

NACHA immediate destination name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationNumber
string or null <= 20 characters

NACHA immediate destination number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyIdentification
string or null <= 20 characters

NACHA company identification. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyName
string or null <= 100 characters

NACHA company name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginatingFinancialInstitutionID
string or null <= 20 characters

NACHA originating financial institution. Required when isNachaEnabled is 1; cleared when it is 0.

nachaAdapterID
string or integer or null^-?[0-9]+$

NACHA file format: 1 Standard, 2 Chase, 3 Owner Funds. Not validated: any other value is stored and read as 1.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 accountCategory include.

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 checkTemplate include.

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: bankAccountID and a statementEndingBalance of 0 (a JSON number), every other key null. Requires the currentReconciliation include.

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 unprintedCheckCount include.

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 positivePayGateway include.

Request samples

Content type
application/json
{
  • "name": "Application Fees",
  • "isSubjectToManagementFees": 1,
  • "isTaxable": 1
}

Response samples

Content type
application/json
{
  • "account": {
    }
}

Update Account (PUT)

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.
Authorizations:
basicAuth
path Parameters
accountID
required
integer
Example: 31

The account's ID, from GET /accounting/accounts or GET /accounting/bank-accounts.

query Parameters
includes
string
Example: includes=accountCategory,currentReconciliation

Comma-separated list of related records to add to the response, each under its own key: accountCategory, checkTemplate, currentReconciliation, unprintedCheckCount, positivePayGateway. Unknown names are ignored.

Request Body schema: application/json
required
non-empty
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 (Cannot change the account type); a value that isn't an account type answers 400 with an error (State class not defined for this account type), and null with Account type is required to create the account state.

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
parentAccountID
string or integer or null^-?[0-9]+$

Parent account, for a sub-account, from GET /accounting/accounts: not the account itself, and not one of its own sub-accounts. Use one of the same type: the create checks it, the update doesn't.

accountCategoryID
string or integer or null^-?[0-9]+$

Account category, one of the same account type, from GET /accounting/account-categories (undocumented).

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 isPrepayment.

(deposit_types_request (string or integer)) or null

Deposit type, for a deposit account. When isDeposit is 1 and no type is set, 1 (General). Turning isDeposit off doesn't clear it.

  • 1 - General
  • 2 - Pet
  • 3 - Cleaning
  • 4 - Key
  • 200 - Other
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 isDeposit.

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 isCheckingEnabled is 1.

(bank_account_types_request (string or integer)) or null

Savings or checking (bank accounts). Required when isCheckingEnabled is 1.

  • 1 - Savings
  • 2 - Checking
bankAccountAddress
string or null <= 100 characters

Bank's address, line 1 (bank accounts). Required when isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

bankAccountStateID
string or null

Bank's state or province code (bank accounts), as GET /states (undocumented) lists it for the country. Required when isCheckingEnabled is 1.

bankAccountPostalCode
string or null <= 20 characters

Bank's postal code (bank accounts). Required when isCheckingEnabled is 1.

bankAccountCountryID
string or null

Bank's country code, from GET /countries (undocumented). US when a state is sent without a country.

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 isCheckingEnabled is 1.

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 isCheckingEnabled is 1.

checkAddress2
string or null <= 100 characters

Address printed on checks, line 2.

checkCity
string or null <= 100 characters

City printed on checks. Required when isCheckingEnabled is 1.

checkStateID
string or null

State printed on checks, as GET /states (undocumented) lists it. Required when isCheckingEnabled is 1.

checkPostalCode
string or null <= 20 characters

Postal code printed on checks. Required when isCheckingEnabled is 1.

checkCountryID
string or null

Country printed on checks; US when a state is sent without a country.

checkTemplateID
string or integer or null^-?[0-9]+$

Check template, from GET /checks/templates (undocumented). Required when isCheckingEnabled is 1.

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 0 when NACHA is off.

nachaOriginName
string or null <= 100 characters

NACHA immediate origin name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginNumber
string or null <= 20 characters

NACHA immediate origin number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationName
string or null <= 100 characters

NACHA immediate destination name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaDestinationNumber
string or null <= 20 characters

NACHA immediate destination number. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyIdentification
string or null <= 20 characters

NACHA company identification. Required when isNachaEnabled is 1; cleared when it is 0.

nachaCompanyName
string or null <= 100 characters

NACHA company name. Required when isNachaEnabled is 1; cleared when it is 0.

nachaOriginatingFinancialInstitutionID
string or null <= 20 characters

NACHA originating financial institution. Required when isNachaEnabled is 1; cleared when it is 0.

nachaAdapterID
string or integer or null^-?[0-9]+$

NACHA file format: 1 Standard, 2 Chase, 3 Owner Funds. Not validated: any other value is stored and read as 1.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 accountCategory include.

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 checkTemplate include.

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: bankAccountID and a statementEndingBalance of 0 (a JSON number), every other key null. Requires the currentReconciliation include.

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 unprintedCheckCount include.

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 positivePayGateway include.

Request samples

Content type
application/json
{
  • "name": "Application Fees",
  • "isSubjectToManagementFees": 1,
  • "isTaxable": 1
}

Response samples

Content type
application/json
{
  • "account": {
    }
}

List Bank Accounts

Returns every bank account in the chart of accounts (accounts of type 3, Bank) in one page, with a few of each account's fields and how many of its checks wait to be printed. It doesn't return routing or account numbers.

Use Cases

  • Pick the bank account a payment, deposit or payout should use.
  • Find the bank accounts with checks waiting to be printed.

Business Rules

  • No permission is checked beyond a valid API key, and portfolio restrictions don't apply.
  • Sorted by number (as text), then name, then accountID.
  • There is no paging: every match comes back in one response, up to 9999 accounts. The pagination headers describe that single page.
  • The filters combine with AND. isActive and isEscrow take true/false or 1/0 (also yes/no, in any case); any other value is ignored and the list isn't filtered by it.
  • 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.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Operating

Keeps the bank accounts whose name or number contains this text (case-insensitive).

isActive
string
Example: isActive=true

true (or 1) keeps only active bank accounts, false (or 0) only inactive ones.

isEscrow
string
Example: isEscrow=false

true (or 1) keeps only escrow (trust) bank accounts, false (or 0) only the others.

bankAccountIDs[]
Array of integers
Example: bankAccountIDs[]=31&bankAccountIDs[]=32

Keeps only these accounts. Send each ID as a separate bankAccountIDs[]= (bankAccountIDs[]=31&bankAccountIDs[]=32).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

A bank account's summary fields.

Response samples

Content type
application/json
[
  • {
    }
]

Bills

List Bills

Returns a paginated list of bills. Each item in the response includes the bill record and its associated payee contact.

Use Cases

  • Retrieve all bills for display in a bills list view.
  • Filter bills by date range, approval status, or payee for reporting.

Business Rules

  • The contact object is always returned alongside each bill — it is not opt-in.
  • Results are paginated; use the page and pageSize query parameters to navigate pages.
  • GET /accounting/bills/{billID} - Retrieve a single bill with full includes support.
  • POST /accounting/bills - Create a bill.
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (bill)
required
object

The payee contact associated with this bill.

Response samples

Content type
application/json
[
  • {
    }
]

Create Bill

Creates a new bill in the system.

Use Cases

  • Record vendor invoices and distribute costs across property ledgers.
  • Attach tenant-responsible amounts via leaseCharges.
  • Link a bill to an existing work order for maintenance cost tracking.
  • Override the default bank account used to pay the bill.

Business Rules

  • payeeContactID, billDate, and dateDue are required.
  • Linking to a work order: First create the work order, then pass its workOrderID on this request. Optionally set workOrderStatusID to update the work order's status at the same time the bill is created.
  • Bank account selection: Set overrideBankAccount: true and supply bankAccountID to pay the bill from a specific bank account. When overrideBankAccount is false (or omitted), the system uses the bank account defined in the payer's posting settings.
  • Each entry in charges must include ledgerID, chargeAccountID, and amount.
  • Each entry in leaseCharges must include leaseID, chargeAccountID, and amount.
  • 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.
Authorizations:
basicAuth
Request Body schema: application/json
required
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 workOrderID here.

bankAccountID
string or integer or null^-?[0-9]+$

The bank account to use for this bill. Only applicable when overrideBankAccount is true.

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 true, the bill will be paid from the bankAccountID specified on this request. When false (or omitted), the bank account is determined by the payer's posting settings.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (bill)

Request samples

Content type
application/json
Example
{
  • "payeeContactID": "67",
  • "billDate": "2026-04-22",
  • "dateDue": "2026-04-22",
  • "reference": "12345",
  • "paymentMemo": "Plumbing invoice April",
  • "description": "Bathroom plumbing repair",
  • "charges": [
    ],
  • "leaseCharges": [ ],
  • "overrideBankAccount": false
}

Response samples

Content type
application/json
{
  • "bill": {
    }
}

Get Bill

Retrieves a single bill by ID, with optional related data via includes.

Available Includes (12+)

Pass a comma-separated list of include names in the includes query parameter.

Include name What it adds
contact Full payee contact record (vendor/owner details, ACH info, insurance).
charges Line-item charges posted to ledgers for this bill.
bankAccount The bank account used to pay this bill.
leaseCharges Tenant-responsible charge transactions, each with property/unit/ledger.
payouts Payouts that have been applied toward this bill.
workOrder The linked work order, if any.
parentBill The parent bill when this is a discount or markup child bill.
discountBill The associated discount bill, if one was generated.
markupBill The associated markup bill, if one was generated.
markupDiscount Computed markup and discount dollar amounts for the bill.
utility The utility associated with this bill, if any.
property The property associated with this bill, if any.
  • 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.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15054
query Parameters
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: contact, charges, bankAccount, leaseCharges, payouts, workOrder, parentBill, discountBill, markupBill, markupDiscount, utility, property.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
{
  • "bill": {
    },
  • "contact": {
    },
  • "charges": [
    ],
  • "bankAccount": {
    },
  • "leaseCharges": [
    ],
  • "payouts": [ ],
  • "workOrder": {
    },
  • "parentBill": null,
  • "discountBill": {
    },
  • "markupBill": {
    },
  • "markupDiscount": {
    },
  • "utility": null,
  • "property": null,
  • "restrictions": {
    },
  • "approvalRequirementType": null
}

Update Bill

Updates an existing bill. All fields are optional — only the fields provided in the request body are changed. Charges are matched by transactionID.

Use Cases

  • Correct bill details such as the payee, dates, reference number, or memo.
  • Adjust charge line amounts, discounts, or markup values.
  • Link or change the associated work order.
  • Update utility billing period dates or service account number.

Business Rules

  • The bill must not be voided. Voided bills cannot be updated.
  • Each entry in charges must include transactionID to identify the charge being updated.

Available Includes (4+)

Pass a comma-separated list of include names in the includes query parameter.

Include name What it adds
charges Updated charge lines with full transaction details.
contact Full payee contact record.
payouts Payouts applied toward this bill.
workOrder The linked work order, if any.
  • GET /accounting/bills/{billID} - Retrieve the updated bill.
  • POST /accounting/bills - Create a new bill.
  • DELETE /accounting/bills/{billID} - Void a bill.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15026
query Parameters
includes
string
Example: includes=charges,contact,payouts,workOrder

Comma-separated list of related data to include in the response. Available values: charges, contact, payouts, workOrder.

Request Body schema: application/json
required
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 transactionID to identify the charge being updated.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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).

Request samples

Content type
application/json
{
  • "payeeContactID": 21,
  • "billDate": "2026-04-22",
  • "dateDue": "2026-04-22",
  • "amount": 0,
  • "discountPercent": 0,
  • "markupPercent": 0,
  • "bankAccountID": 216,
  • "reference": "123456",
  • "paymentMemo": "test memo",
  • "description": "test description",
  • "workOrderID": 5954,
  • "charges": [
    ],
  • "serviceAccountNumber": "0001",
  • "utilityPeriodStartDate": "2026-04-22",
  • "utilityPeriodEndDate": "2027-04-22"
}

Response samples

Content type
application/json
{
  • "bill": {
    },
  • "contact": {
    },
  • "charges": [
    ],
  • "payouts": [ ],
  • "workOrder": {
    }
}

Void Bill

Voids a bill, reversing its accounting impact. The bill remains in the system with isVoided: "1" and cannot be deleted.

Use Cases

  • Cancel a bill entered in error before any payments are applied.
  • Void a bill and simultaneously void its linked discount or markup child bills.

Business Rules

  • A bill cannot be voided if any payments have been applied to it. If transactions exist against the bill, the void will be rejected. Unapply or reverse any payments before attempting to void.
  • Linked discount/markup bills: When a bill is created with a discount or markup, companion child bills (discountBill, markupBill) are generated automatically. To void those companion bills at the same time, set voidLinkedBills: true in the request body. If omitted or false, only the parent bill is voided.

Available Includes (12+)

The void response supports the same includes as GET /accounting/bills/{billID}. Pass a comma-separated list in the includes query parameter.

Include name What it adds
contact Full payee contact record (vendor/owner details, ACH info, insurance).
charges Line-item charges posted to ledgers for this bill.
bankAccount The bank account used to pay this bill.
leaseCharges Tenant-responsible charge transactions, each with property/unit/ledger.
payouts Payouts that have been applied toward this bill.
workOrder The linked work order, if any.
parentBill The parent bill when this is a discount or markup child bill.
discountBill The associated discount bill (voided when voidLinkedBills: true).
markupBill The associated markup bill (voided when voidLinkedBills: true).
markupDiscount Computed markup and discount dollar amounts for the bill.
utility The utility associated with this bill, if any.
property The property associated with this bill, if any.
  • GET /accounting/bills/{billID} - Retrieve a bill and its current state.
  • POST /accounting/bills - Create a new bill.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15051
query Parameters
includes
string
Example: includes=contact,charges,workOrder,discountBill,markupBill,leaseCharges

Comma-separated list of related data to include in the response. Available values: contact, charges, bankAccount, leaseCharges, payouts, workOrder, parentBill, discountBill, markupBill, markupDiscount, utility, property.

Request Body schema: application/json
optional
voidLinkedBills
boolean

When true, any discount and/or markup child bills linked to this bill are also voided in the same operation. When false or omitted, only the parent bill is voided.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 voidLinkedBills: true.

bill (object) or null

The companion markup bill linked to this bill, if any. Voided alongside the parent when voidLinkedBills: true.

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).

Request samples

Content type
application/json
{
  • "voidLinkedBills": true
}

Response samples

Content type
application/json
{
  • "bill": {
    },
  • "contact": {
    },
  • "charges": [ ],
  • "bankAccount": {
    },
  • "leaseCharges": [
    ],
  • "payouts": [ ],
  • "workOrder": {
    },
  • "parentBill": null,
  • "discountBill": {
    },
  • "markupBill": {
    },
  • "markupDiscount": {
    },
  • "utility": null,
  • "property": null
}

Approve Bill

Approves a bill, marking it as authorized for payment. Once approved, the bill's isApproved flag is set to 1 and approvedByUserID is recorded.

Use Cases

  • Authorize a vendor bill before it can be included in a payment batch.
  • Complete a two-step approval workflow where bills are created and reviewed before payment.
  • Fulfill a master-level approval when a bill's total exceeds a configured threshold.

Business Rules

  • Requires the ApproveBill permission (Accounting component).
  • If the bill total meets or exceeds the account's master-approval threshold, the ApproveBillMaster permission is also required.
  • The bill must exist. A 400 is returned if the billID is not found.
  • The caller must have full access to the bill under the account's restrictions policy.
  • On success the response is identical to GET /accounting/bills/{billID} — the same includes query parameter is supported.
  • 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.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 14973
query Parameters
includes
string
Example: includes=contact,charges,workOrder

Comma-separated list of related data to include in the response. Available values: contact, charges, bankAccount, leaseCharges, payouts, workOrder, parentBill, discountBill, markupBill, markupDiscount, utility, property.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (bill)

Response samples

Content type
application/json
{
  • "bill": {
    }
}

Print Bill PDF

Renders a bill as a PDF document and streams the binary content directly in the response body. The PDF is generated from the bill's data and rendered using the portfolio's branding/letterhead when a portfolioID is provided.

Use Cases

  • Download a printable copy of a bill to send to a vendor or attach to a work order.
  • Generate a PDF receipt for a paid bill for record-keeping or audit purposes.
  • Produce a branded bill PDF using a specific portfolio's letterhead.

Business Rules

  • The bill must exist; if {billID} does not match any bill, a 400 error is returned.
  • The portfolioID query parameter is optional. When omitted, the PDF is rendered without portfolio-specific branding.
  • The response content type is application/pdf. Clients should treat the body as a binary stream, not JSON.
  • GET /accounting/bills/{billID} - Retrieve bill data as JSON.
  • GET /accounting/bills - List all bills.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15054

Unique identifier of the bill to print.

query Parameters
portfolioID
integer
Example: portfolioID=42

Portfolio ID used to apply branded letterhead/styling to the rendered PDF.

Responses

Response Headers
Cache-Control
string
Example: "no-cache"

Cache directive set to no-cache by the server.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/pdf
string <binary>

Raw PDF binary data of the bill.

Response samples

Content type
application/json
{
  • "error": "Bill 15054 not found"
}

Search Payables

Returns a paginated list of payable transactions (bill charges) with joined bill, ledger, portfolio, property, unit, and payee contact data. Each result row represents one transaction line from a bill, so a multi-line bill produces multiple rows.

Use Cases

  • Build a payables queue filtered by approval status, due date, or payee vendor.
  • Find all open (unpaid) charges across a set of properties or portfolios.
  • Identify bills that require master approval because their total meets or exceeds the configured approval threshold.
  • Export payables data for reconciliation against an external AP system.

Business Rules

  • Results are restricted to the authenticated user's accessible portfolios. Charges on portfolios outside the user's access are automatically excluded.
  • The isPaid filter compares amountPaid to amount. A transaction where amountPaid < amount is unpaid (isPaid=false); a transaction where amountPaid = amount is fully paid (isPaid=true). Partially-paid charges always appear when isPaid=false.
  • requiresMasterApproval=true only has effect when a Bill Approval Maximum Threshold is configured in Accounting Settings. It matches unapproved parent bills whose total charge amount meets or exceeds that threshold. Child bills are excluded from this filter (they defer to their parent's approval state).
  • Both singular and plural variants of ID array parameters are accepted (payeeContactID / payeeContactIDs, portfolioID / portfolioIDs, propertyID / propertyIDs, unitID / unitIDs). Pass multiple values as a comma-separated string: propertyIDs=101,102,103.
  • Default sort is transaction.datePosted descending. Append |asc or |desc to any orderBy value to control direction (e.g. orderBy=transaction.amount|asc).
  • 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.
Authorizations:
basicAuth
query Parameters
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:

  • transaction.description
  • ledger.name
  • portfolio.name
  • property.address
  • bill.reference
  • contact.name (payee)

Also matches rows where transaction.amount equals the search string exactly (useful for looking up a specific dollar amount).

isVoided
boolean

Filter by voided status of the transaction.

  • false — return only active (non-voided) transactions.
  • true — return only voided transactions.

Omit to return both.

isApproved
boolean

Filter by the bill's approval status.

  • false — unapproved bills only.
  • true — approved bills only.

Omit to return both.

isPaid
boolean

Filter by payment status of the transaction.

  • false — open charges where amountPaid < amount.
  • true — fully paid charges where amountPaid = amount.

Omit to return both paid and unpaid.

amountMin
number <double>
Example: amountMin=100

Return only transactions where amount is greater than or equal to this value.

amountMax
number <double>
Example: amountMax=5000

Return only transactions where amount is less than or equal to this value.

datePostedMin
string <date>
Example: datePostedMin=2026-01-01

Return only transactions posted on or after this date (transaction.datePosted). Format: YYYY-MM-DD.

datePostedMax
string <date>
Example: datePostedMax=2026-04-30

Return only transactions posted on or before this date (transaction.datePosted). Format: YYYY-MM-DD.

billDateMin
string <date>
Example: billDateMin=2026-01-01

Return only transactions whose bill date (bill.billDate) is on or after this date. Format: YYYY-MM-DD.

billDateMax
string <date>
Example: billDateMax=2026-04-30

Return only transactions whose bill date (bill.billDate) is on or before this date. Format: YYYY-MM-DD.

dateDueMin
string <date>
Example: dateDueMin=2026-04-01

Return only transactions whose bill due date (bill.dateDue) is on or after this date. Format: YYYY-MM-DD.

dateDueMax
string <date>
Example: dateDueMax=2026-04-30

Return only transactions whose bill due date (bill.dateDue) is on or before this date. Format: YYYY-MM-DD.

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 payeeContactID for a single value.

Example: payeeContactIDs=200,201,215

portfolioIDs
string
Example: portfolioIDs=50,51

Comma-separated list of portfolio IDs to filter by. Also accepted as singular portfolioID for a single value.

Example: portfolioIDs=50,51

propertyIDs
string
Example: propertyIDs=101,102

Comma-separated list of property IDs to filter by. Also accepted as singular propertyID for a single value.

Example: propertyIDs=101,102,103

unitIDs
string
Example: unitIDs=310,311

Comma-separated list of unit IDs to filter by. Also accepted as singular unitID for a single value.

Example: unitIDs=310,311

requiresMasterApproval
boolean
Example: requiresMasterApproval=true

When true, return only unapproved parent bills whose total charge amount meets or exceeds the Bill Approval Maximum Threshold configured in Accounting Settings. Child bills are excluded. Has no effect if no threshold is configured.

orderBy
string
Example: orderBy=transaction.amount|asc

Sort the results by a specific column. Append |asc or |desc to control direction. Default: transaction.datePosted|desc.

Sortable columns:

  • bill.billDate
  • bill.dateDue
  • bill.reference
  • contact.name
  • ledger.name
  • property.name
  • transaction.datePosted
  • transaction.amount
  • transaction.amountPaid

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Deposits

List Deposits

Returns a paginated list of bank deposits. Each item in the response includes the deposit record and its associated bank account.

Use Cases

  • Display a list of deposits for a specific bank account.
  • Filter deposits by reconciliation ID to see what was deposited in a given reconciliation cycle.

Business Rules

  • Results are scoped to the authenticated user's portfolio restrictions.
  • The account object is always included in each list item.
  • Use GET /accounting/deposits/search for richer filtering with min/max amounts and date ranges.
  • 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.
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

token
required
string

Session token associated with this response.

Response samples

Content type
application/json
{
  • "deposit": {
    },
  • "token": "1777036078"
}

Create Deposit

Creates a new bank deposit, optionally adding transactions, bulk payments, and file attachments in the same request. On success, returns the newly created deposit (same shape as GET /accounting/deposits/{depositID}).

Use Cases

  • Create a deposit and attach existing undeposited transactions to it.
  • Create a deposit with bulk payments from a bulk payment batch.

Business Rules

  • Requires the Accounting > ModifyDeposit permission.
  • Each transactionID in transactions must exist and pass portfolio restrictions.
  • Each bulkPaymentID in bulkPayments must exist.
  • The attachments array contains fileID values for pre-uploaded files.
  • After creation the endpoint forwards to GET /accounting/deposits/{depositID} and returns the full deposit detail.
  • GET /accounting/deposits/transactions/undeposited - Retrieve undeposited transactions to include.
  • GET /accounting/deposits/{depositID} - View the created deposit.
Authorizations:
basicAuth
Request Body schema: application/json
required
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

transactions
Array of objects

Deposited transactions (if includes=transactions).

Request samples

Content type
application/json
Example
{
  • "bankAccountID": 146,
  • "depositNumber": "27",
  • "description": null,
  • "dateDeposited": "2026-04-24",
  • "attachments": [ ],
  • "transactions": [
    ],
  • "bulkPayments": [ ],
  • "amount": "1400.00"
}

Response samples

Content type
application/json
{
  • "deposit": {
    }
}

Search Deposits

Returns a paginated, searchable list of deposits with advanced filtering options including amount ranges, date ranges, reconciliation state, and bank account. Each result item contains a deposit object, the associated bank account object, and a reconciliation object (populated when the deposit is linked to a reconciliation, otherwise all fields are null).

Use Cases

  • Search deposits by amount range for audit or reconciliation workflows.
  • Filter by isReconciled=false to find deposits pending reconciliation.
  • Filter by bankAccountIDs to scope results to specific bank accounts.
  • Search deposit number, description, amount, or account name/number via search.

Business Rules

  • Both bankAccountIDs (comma-separated) and bankAccountID (single integer) are accepted; bankAccountIDs takes precedence.
  • Similarly, reconciliationIDs takes precedence over reconciliationID.
  • Results are restricted to the authenticated user's portfolio.
  • Results are ordered by dateDeposited DESC, then depositID DESC.
  • GET /accounting/deposits - Simple list with basic filters.
  • GET /accounting/deposits/{depositID} - Retrieve a single deposit with includes support.
Authorizations:
basicAuth
query Parameters
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 bankAccountIDs for multiple).

isVoided
boolean

Filter by voided state. true returns only voided, false returns only non-voided.

showVoided
boolean

When false, returns only voided deposits. Distinct from isVoided — use isVoided=false to exclude voided deposits, showVoided=false to show only voided.

isReconciled
boolean

Filter by reconciliation state. true returns only deposits linked to a reconciliation. false returns only unreconciled deposits.

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 reconciliationIDs for multiple).

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

required
object

The bank account associated with this deposit.

required
object

The reconciliation this deposit is linked to. All fields are null when the deposit has not been reconciled.

Response samples

Content type
application/json
[
  • {
    }
]

List Undeposited Transactions

Returns all transactions not yet assigned to a deposit, scoped to a specific bank account. This endpoint populates the transaction picker when creating or editing a deposit.

The result is a union of two item types returned in the same array:

  • Regular transactions (depositTransactionTypeID: 1, objectTypeID: 9) — lease payments, owner payments, and other payments that have not been deposited and are not routed through a bank gateway.
  • Bulk payments (depositTransactionTypeID: 2, objectTypeID: 84) — undeposited bulk payment batches. For bulk payments the ledger, property, and unit objects will be null.

Use Cases

  • Retrieve all undeposited transactions for a bank account before creating a new deposit.
  • Filter by transactionTypeID to show only specific payment types (e.g. lease payments only).
  • Filter by createdByUserID to show transactions entered by a specific user.

Business Rules

  • bankAccountID is required and must refer to an account of type Bank.
  • Voided transactions are excluded.
  • Transactions already assigned to a deposit (depositID IS NOT NULL) are excluded.
  • Transactions routed through a bank gateway (bankAccountGatewayID IS NOT NULL) are excluded.
  • Results are restricted to the authenticated user's portfolio.
  • Results are not paginated — the full matching list is returned in a single array, ordered by datePosted DESC.
  • POST /accounting/deposits - Create a deposit using transactions from this list.
  • POST /accounting/deposits/{depositID}/transactions - Add transactions to an existing deposit.
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 receivedFrom; for all others it is the contact name.

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.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Get Deposit

Retrieves a single deposit by ID. The base response always includes the deposit record. Additional data can be requested via the includes query parameter.

Use Cases

  • Load a deposit detail page including its transactions and reconciliation info.
  • Check reconciliation status before allowing an edit or void action.

Business Rules

  • Returns a 400 error if the deposit does not exist.
  • Access is verified via the authenticated user's license for the deposit's portfolio.
  • The restrictions include adds access-control metadata (read/write/void permissions) derived from the user's license for this deposit.

Available Includes (4+)

Use ?includes=transactions,reconciliation to request additional data.

  • transactions — Array of transactions associated with this deposit, including ledger and property context for each entry.
  • reconciliation — The reconciliation record this deposit is linked to (or null if unreconciled).
  • previousReconciliation — The previous reconciliation record if the deposit was moved during a re-reconciliation (or null).
  • restrictions — Access-control metadata indicating what actions the current user can perform on this deposit.
  • 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.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to retrieve.

query Parameters
includes
string
Example: includes=transactions,reconciliation

Comma-separated list of additional data to include. Available values: transactions, reconciliation, previousReconciliation, restrictions.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

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).

Response samples

Content type
application/json
Example
{
  • "deposit": {
    }
}

Update Deposit

Updates editable fields on an existing deposit. Only depositNumber, description, and dateDeposited may be changed after creation, and only the keys sent change: keys left out keep their values. On success, returns the updated deposit (same shape as GET /accounting/deposits/{depositID}).

Business Rules

  • Requires the Modify Deposit permission (Accounting › ModifyDeposit), checked first: a key without it gets the 403 even for a deposit that doesn't exist.
  • A key restricted to some portfolios gets 403 Access Denied for a deposit outside them.
  • Refused with a 400: a voided deposit ({"isVoided": ["Cannot modify voided deposit"]}), a reconciled one, a missing or empty body, and a field that breaks its limit (see the request body).
  • bankAccountID and amount cannot be changed after creation: sent in the body, they are ignored.
  • A value that isn't a number as depositID answers the stock 404.
  • The update answers like GET /accounting/deposits/{depositID} and honours its includes (transactions, reconciliation, previousReconciliation, restrictions), whose objects aren't documented on this operation yet.

Side Effects

  • Adds a Deposit Updated entry to the deposit's history log when a field changes. No transaction or ledger entry is written.
  • PUT /accounting/deposits/{depositID} - the same update with PUT
  • POST /accounting/deposits/{depositID}/transactions - Add/remove transactions.
  • DELETE /accounting/deposits/{depositID} - Void the deposit.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to update, from GET /accounting/deposits/search.

Request Body schema: application/json
required
non-empty
depositNumber
string [ 1 .. 100 ] characters

Updated reference number, up to 100 characters. The deposit must always have one: null, "" or only spaces is refused ({"depositNumber": ["Deposit Number is required for this type of deposit"]}), and so is an update that leaves it out when the stored deposit has none.

description
string or null <= 1000 characters

Updated description, up to 1000 characters.

dateDeposited
string <date>

Updated deposit date. null is refused (Date Deposited is invalid).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
{
  • "depositNumber": "29",
  • "description": "October rent deposits (revised)",
  • "dateDeposited": "2024-10-23"
}

Response samples

Content type
application/json
{
  • "deposit": {
    }
}

Update Deposit (PUT)

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
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to update, from GET /accounting/deposits/search.

Request Body schema: application/json
required
non-empty
depositNumber
string [ 1 .. 100 ] characters

Updated reference number, up to 100 characters. The deposit must always have one: null, "" or only spaces is refused ({"depositNumber": ["Deposit Number is required for this type of deposit"]}), and so is an update that leaves it out when the stored deposit has none.

description
string or null <= 1000 characters

Updated description, up to 1000 characters.

dateDeposited
string <date>

Updated deposit date. null is refused (Date Deposited is invalid).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
{
  • "depositNumber": "29",
  • "description": "October rent deposits (revised)",
  • "dateDeposited": "2024-10-23"
}

Response samples

Content type
application/json
{
  • "deposit": {
    }
}

Void Deposit

Voids a deposit, reversing its effect on the bank account balance. The deposit record is marked isVoided = 1 and the associated transactions are undeposited. Returns the deposit record after voiding.

Business Rules

  • Requires the Accounting > VoidDeposit permission.
  • Requires full portfolio access to the deposit (not just read access).
  • A voided deposit cannot be un-voided via API.
  • POST /accounting/deposits/{depositID}/reconcile - Reconcile a deposit instead of voiding.
  • GET /accounting/deposits/{depositID} - Check deposit state before voiding.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to void.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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"

0 = active, 1 = voided.

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 YYYY-MM-DD HH:MM:SS.

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.

Response samples

Content type
application/json
{
  • "depositID": "33",
  • "bankAccountID": "31",
  • "reconciliationID": null,
  • "previousReconciliationID": "22",
  • "depositNumber": "54",
  • "description": "December rent deposits",
  • "amount": "11781.00",
  • "isVoided": "1",
  • "dateDeposited": "2021-12-14",
  • "dateTimeCreated": "2021-12-14 20:35:15"
}

Add Transactions to Deposit

Adds one or more transactions (and/or bulk payments) to an existing deposit. This endpoint is used to incrementally build up a deposit rather than specifying all transactions at creation time.

Use Cases

  • Add a forgotten transaction to an existing deposit before reconciliation.
  • Attach bulk payments (ACH batches) to a deposit.

Business Rules

  • Requires the Accounting > ModifyDeposit permission.
  • Each transactionID in transactions must exist and pass portfolio access checks.
  • Each bulkPaymentID in bulkPayments must exist.
  • Returns { "success": true } on success, not the updated deposit. Fetch the deposit separately via GET /accounting/deposits/{depositID}?includes=transactions to see the updated state.
  • GET /accounting/deposits/transactions/undeposited - Get available undeposited transactions.
  • GET /accounting/deposits/{depositID} - View the deposit with transactions included.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to add transactions to.

Request Body schema: application/json
required
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
success
required
boolean

Request samples

Content type
application/json
Example
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Print Deposit

Renders a printable PDF for the given deposit and streams it as the response body. The response Content-Type is application/pdf.

Use Cases

  • Download a PDF receipt for a bank deposit to attach to physical bank records.
  • Generate a deposit slip for accounting audit purposes.

Business Rules

  • Returns a 400 error if the deposit does not exist.
  • Access is verified via the authenticated user's license for the deposit's portfolio.
  • The response is streamed directly — there is no JSON envelope.
  • GET /accounting/deposits/{depositID} - Retrieve deposit data in JSON format.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to print.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "error": "Deposit 9999 not found"
}

Reconcile Deposit

Marks a deposit as reconciled, optionally linking it to an existing reconciliation record. This performs a single-item reconciliation (as opposed to a full bank statement reconciliation). On success, returns the updated deposit detail.

Use Cases

  • Reconcile a single deposit against a bank statement line item without running a full reconciliation cycle.
  • Link a deposit to an existing reconciliation by providing reconciliationID.

Business Rules

  • Requires both the Accounting > ModifyDeposit and Accounting > ModifyReconciliations permissions.
  • If reconciliationID is provided and the reconciliation exists, the deposit is linked to it. If no ID is provided, a new reconciliation record is created.
  • The isSingleTransaction flag is set internally — this action reconciles this deposit only, not all items in a reconciliation batch.
  • Returns the updated deposit via a forward to GET /accounting/deposits/{depositID}.
  • POST /accounting/deposits/{depositID}/unreconcile - Reverse this reconciliation.
  • GET /accounting/deposits/{depositID}?includes=reconciliation - Check reconciliation state.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to reconcile.

Request Body schema: application/json
required
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
Example
{
  • "reconciliationID": 88
}

Response samples

Content type
application/json
{
  • "deposit": {
    }
}

Unreconcile Deposit

Removes the reconciliation link from a deposit, reverting it to an unreconciled state. On success, returns the updated deposit detail with reconciliationID set to null.

Use Cases

  • Correct a mis-reconciled deposit before closing the accounting period.
  • Unreconcile a deposit to allow edits to its transactions.

Business Rules

  • Requires both the Accounting > ModifyDeposit and Accounting > ModifyReconciliations permissions.
  • The previousReconciliationID field on the deposit will record the reconciliation that was removed.
  • This action is single-item only — it does not affect other items in the reconciliation.
  • Returns the updated deposit via a forward to GET /accounting/deposits/{depositID}.
  • POST /accounting/deposits/{depositID}/reconcile - Reconcile the deposit again.
  • GET /accounting/deposits/{depositID}?includes=reconciliation - Check current reconciliation state.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The ID of the deposit to unreconcile.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
{
  • "deposit": {
    }
}

Invoices

List Invoices

Returns a paginated list of invoices. Invoices are inbound documents (uploaded PDFs or vendor-created line items) in various processing states. The AI extraction service populates predicted fields for uploaded invoices.

Use Cases

  • Display a queue of invoices pending review (invoiceStatusID=2).
  • Filter invoices assigned to a specific user for workflow management.
  • Pull all invoices associated with a work order.

Business Rules

  • Results are restricted to the authenticated user's portfolio.
  • Both singular and plural filter parameters are accepted (e.g. invoiceStatusID and invoiceStatusIDs); the plural form takes precedence.
  • Results are paginated; default page size is 25.
  • GET /accounting/invoices/{invoiceID} - Retrieve a single invoice with full detail.
  • POST /accounting/invoices/upload - Upload a new invoice PDF.
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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).

Response samples

Content type
application/json
[
  • {
    }
]

Upload Invoice

Uploads an invoice PDF or image file. The file is stored and an invoice record is created in Processing status. The AI extraction service processes the file asynchronously and populates the predicted* fields when complete. The invoice transitions to Ready status once extraction is done.

Use Cases

  • Allow a property manager to upload a vendor invoice PDF from the manager portal.
  • Trigger AI-powered field extraction for invoice automation workflows.

Business Rules

  • The request must be multipart/form-data with the file as the first upload.
  • The file must be a valid upload (checked by the internal file validation layer).
  • The new invoice is created with invoiceStatusID=1 (Processing) and invoiceSourceID=2 (Upload).
  • On success, forwards to GET /accounting/invoices/{invoiceID} and returns the full invoice detail.
  • The AI prediction runs asynchronously via the queue — the predicted* fields will be populated after a short delay.
  • GET /accounting/invoices/{invoiceID} - Poll for updated prediction results.
  • POST /accounting/invoices/{invoiceID}/decline - Decline an invoice after review.
Authorizations:
basicAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

The invoice PDF or image file to upload.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 invoiceStatusID tracks processing state; the invoiceTypeID distinguishes uploaded PDFs from manually created invoices. Predicted fields are populated by the AI extraction service for uploaded invoices.

lineItems
required
Array of objects

Line items (empty until AI extraction completes).

Response samples

Content type
application/json
{
  • "invoice": {
    },
  • "lineItems": [ ]
}

Get Invoice

Retrieves a single invoice by ID. The base response includes the invoice record and its line items (actual or AI-predicted depending on invoiceTypeID). Additional related data can be requested via the includes query parameter.

Use Cases

  • Load a full invoice detail page including the vendor contact and predicted field data.
  • Display line items for a Created (manually entered) invoice.
  • Pull the associated work order and property for routing/approval context.

Business Rules

  • Returns a 400 error if the invoice does not exist.
  • lineItems are always returned — for invoiceTypeID=2 (Created) these come from InvoiceLineItems; for uploaded invoices they come from the AI prediction data.
  • The workOrder, unit, property, lease, and ledger includes are nested: unit, property, lease, and ledger require workOrder to also be included.

Available Includes (7+)

Use ?includes=contact,workOrder,property to request additional data.

  • contact — The confirmed or predicted payee contact record.
  • predictedInvoice — The raw AI extraction result for uploaded invoices.
  • invoiceFile — The file record for the uploaded invoice PDF.
  • files — Attachments shared with the vendor on this invoice.
  • workOrder — The associated work order, if set.
  • unit — The unit linked to the work order (requires workOrder).
  • property — The property linked to the work order (requires workOrder).
  • lease — The lease linked to the work order (requires workOrder).
  • ledger — The ledger for the unit or property (requires workOrder).
  • 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.
Authorizations:
basicAuth
path Parameters
invoiceID
required
integer
Example: 8850

The ID of the invoice to retrieve.

query Parameters
includes
string
Example: includes=contact,workOrder,property

Comma-separated list of additional data to include. Available values: contact, predictedInvoice, invoiceFile, files, workOrder, unit, property, lease, ledger.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 invoiceStatusID tracks processing state; the invoiceTypeID distinguishes uploaded PDFs from manually created invoices. Predicted fields are populated by the AI extraction service for uploaded invoices.

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 (invoiceTypeID=2) returns its stored line item rows, with every value a string. Any other invoice returns the line items the AI prediction read from the uploaded document, with amount, unitPrice and quantity as JSON numbers (or null when the prediction has no value).

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).

Response samples

Content type
application/json
Example
{
  • "invoice": {
    },
  • "lineItems": [ ]
}

Print Invoice

Renders a printable PDF for the given invoice and streams it as the response body. The response Content-Type is application/pdf.

Use Cases

  • Download a PDF copy of an invoice to send to an owner or attach to a bill.
  • Generate an invoice PDF for record-keeping before converting to a bill.

Business Rules

  • Returns a 400 error if the invoice does not exist.
  • The response is streamed directly — there is no JSON envelope.
  • GET /accounting/invoices/{invoiceID} - Retrieve invoice data in JSON format.
Authorizations:
basicAuth
path Parameters
invoiceID
required
integer
Example: 8850

The ID of the invoice to print.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "error": "Invoice not found"
}

Decline Invoice

Declines an invoice, setting its status to Declined (4) and optionally sending a decline notification to the vendor. On success, returns the updated invoice detail.

Use Cases

  • Reject a vendor invoice that does not match an approved work order or has incorrect details.
  • Decline a duplicate or invalid invoice submission.

Business Rules

  • The invoice invoiceStatusID is set to 4 (Declined) internally regardless of the value provided in the request body.
  • declinedMessage is stored on the invoice and included in the notification email if sendNotification is true.
  • sendNotification defaults to true if not provided in the request body.
  • On success, forwards to GET /accounting/invoices/{invoiceID} and returns the full invoice detail.
  • GET /accounting/invoices/{invoiceID} - View the declined invoice.
  • POST /accounting/invoices/upload - Upload a replacement invoice.
Authorizations:
basicAuth
path Parameters
invoiceID
required
integer
Example: 8850

The ID of the invoice to decline.

Request Body schema: application/json
required
declinedMessage
string or null

Message explaining why the invoice was declined. Sent to the vendor if sendNotification is true.

sendNotification
boolean
Default: true

Whether to send a decline notification email to the vendor.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 invoiceStatusID tracks processing state; the invoiceTypeID distinguishes uploaded PDFs from manually created invoices. Predicted fields are populated by the AI extraction service for uploaded invoices.

lineItems
required
Array of objects

Request samples

Content type
application/json
Example
{
  • "declinedMessage": "Invoice amount does not match the approved work order estimate.",
  • "sendNotification": true
}

Response samples

Content type
application/json
{
  • "invoice": {
    },
  • "lineItems": [ ]
}

Ledgers

List Ledgers

Returns an array of {"ledger": {...}} items matching the given search criteria, with no paging. At least one of search or ledgerIDs must be provided: a request with neither (an empty search counts as none) is refused with a 400 whose body is the bare JSON string "Search Failed".

Use Cases

  • Typeahead / autocomplete: pass search to find ledgers by name.
  • Batch lookup: pass ledgerIDs to fetch a known set of ledgers by ID.
  • Filtered listing: combine ledgerTypeID with search to narrow results to a specific ledger type (e.g. only property operating accounts).

Business Rules

  • Needs no permission.
  • Only active ledgers are returned, and only ledgers whose portfolio, property or unit still exists. A key restricted to some portfolios gets only their ledgers. A ledgerIDs[] lookup drops any ID these filters leave out, with no error.
  • search and ledgerIDs[] together must both match. search=0 counts as no search (the 400).
  • On an account that bills its management fees and hides the manager ledger, manager ledgers (type 1) are left out. This is an account setting, not a permission: every key on the account gets the same rows.
  • Not paginated: every matching ledger comes back in one array, with no pagination headers, so a short search can return over a thousand ledgers. A search of only spaces matches every ledger.
  • ledgerIDs[] values that aren't positive integers are dropped; when none is left the answer is 200 [], not the
    1. A single ledgerIDs=100 (no brackets) is read as a one-item list; a comma list (100,101) isn't split.
  • A ledgerTypeID of 0, or one that isn't a number, is ignored (no type filter); any other value outside 1 to 4 matches nothing: 200 [].
  • Results are ordered by search relevance rank, then ledger type, then name.
  • GET /accounting/ledgers/search — Paginated ledger search with extended filters.
  • GET /accounting/ledgers/{ledgerID} (undocumented) — Retrieve a single ledger with optional includes.
Authorizations:
basicAuth
query Parameters
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.

  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerIDs[]
Array of integers
Example: ledgerIDs[]=100&ledgerIDs[]=101

Filter by one or more ledger IDs. Pass each value as a separate query parameter: ledgerIDs[]=100&ledgerIDs[]=101.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (ledger)

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Search Ledgers

Paginated search across all ledgers with filtering by type, status, and modification date. Results include a left-joined unit object populated only when the ledger is of type Unit (ledgerTypeID 4).

Use Cases

  • Retrieve all active ledgers modified after a given date for sync/reconciliation.
  • Filter to a specific set of ledger types (e.g. property and portfolio) for a reporting UI.
  • Look up a single known ledger by ledgerID to confirm its current state.
  • Combine search + ledgerTypeIDs to power a filtered autocomplete when exact IDs are not known.

Business Rules

  • Portfolio/access restrictions are applied automatically — results are limited to ledgers the authenticated user has permission to view.
  • isActive filters on ledger status; omit it to receive both active and inactive records.
  • ledgerTypeIDs accepts a comma-separated string or repeated array values; ledgerTypeID (singular) is accepted as a convenience fallback for a single type.
  • The unit object is always present in each item but its fields will be null for non-unit ledgers.
  • GET /accounting/ledgers — Lightweight, non-paginated ledger lookup (typeahead / batch ID lookup).
  • GET /accounting/ledgers/{ledgerID} — Single ledger detail with optional includes.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object or null

Unit details joined from property_units. Populated only when ledger.ledgerTypeID is 4 (Unit). All fields are null for non-unit ledgers.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Reconciliations

A reconciliation matches a bank account's records against one bank statement: the deposits, payments, transfers and adjustments the statement cleared are marked reconciled, and the period's balances and transactions are recorded. Each bank account has one current reconciliation, the newest; the next one starts the day after it ends. List, read, complete (create) and void reconciliations here. Single payment returns and bank fees are reconciled into an existing reconciliation, or removed from it, with POST /accounting/transactions/{transactionID}/reconcile and /unreconcile; deposits with their own endpoints. Keys restricted to portfolio groups can't list, read, complete or void reconciliations, since a reconciliation spans every portfolio that uses the bank account.

List Reconciliations

Lists completed bank reconciliations, newest statement first, with the bank account each one belongs to. Voided reconciliations are listed too, unless isVoided filters them out.

Use Cases

  • Find a bank account's current reconciliation (bankAccountID with isCurrent=true) before reconciling a transaction into it.
  • Review a bank account's reconciliation history, or the ones whose balance changed after completion (excludeInBalanceReconciliations=true).

Business Rules

  • No permission is checked beyond a valid API key.
  • A key restricted to any portfolio group gets 403 {"error": "Access Denied"}: a reconciliation spans every portfolio that uses the bank account, so restricted keys can't read reconciliations at all.
  • Sorted by statementEndDate, newest first, then by reconciliationID, highest first.
  • A filter value the API can't read (a date it can't parse, a non-numeric balance, a flag other than true/false/1/0/yes/no) is ignored, and the list comes back unfiltered by it.
  • 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.
Authorizations:
basicAuth
query Parameters
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 (5250.00) to match an ending balance, and text to match the bank account.

bankAccountID
integer
Example: bankAccountID=124

Keeps one bank account's reconciliations. Bank account IDs come from GET /accounting/bank-accounts.

bankAccountIDs[]
Array of integers

Keeps the reconciliations of any of these bank accounts. Send each ID as its own bankAccountIDs[]= value (bankAccountIDs[]=124&bankAccountIDs[]=125); a comma-separated value (bankAccountIDs=124,125) keeps only the first ID.

isCurrent
string
Example: isCurrent=true

true (or 1, yes) keeps only each bank account's current reconciliation, false (or 0, no) only the others. Any other value is ignored.

isVoided
string
Example: isVoided=false

true (or 1, yes) keeps only voided reconciliations, false (or 0, no) only the ones that aren't. Any other value is ignored.

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 (YYYY-MM-DD or MM/DD/YYYY). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp.

statementStartDateMax
string
Example: statementStartDateMax=2026-12-31

Keeps the statements that start on or before this date (YYYY-MM-DD or MM/DD/YYYY). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp.

statementEndDateMin
string
Example: statementEndDateMin=2026-01-01

Keeps the statements that end on or after this date (YYYY-MM-DD or MM/DD/YYYY). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp.

statementEndDateMax
string
Example: statementEndDateMax=2026-12-31

Keeps the statements that end on or before this date (YYYY-MM-DD or MM/DD/YYYY). Ignored when it can't be read as a date; a value of digits alone is read as a Unix timestamp.

excludeInBalanceReconciliations
string
Example: excludeInBalanceReconciliations=true

true (or 1, yes) keeps only the reconciliations whose changeTransactionBalance isn't 0.00: those whose changes after completion don't net to zero. false or any other value applies no filter.

page
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (reconciliation_list_item)

A reconciliation as GET /accounting/reconciliations lists it: every column of the reconciliation row, as stored, plus the net of the single-transaction changes made to it since it was completed.

required
object

The bank account the reconciliation belongs to.

Response samples

Content type
application/json
[
  • {
    }
]

Create Reconciliation

Completes a bank reconciliation: marks the transactions cleared on the bank statement as reconciled, and records the statement period, its balances and a snapshot of the period's transactions. The new reconciliation becomes the bank account's current one.

Use Cases

  • Close a bank statement: send the statement's end date and ending balance with every deposit, payment, transfer and adjustment it cleared.
  • Attach the bank statement file (upload it first with POST /files).

Business Rules

  • Requires the Modify Reconciliations permission (Accounting › ModifyReconciliations); without it the API answers 403 {"error": "Permission Denied"}.
  • A key restricted to any portfolio group gets 403 {"error": "Access Denied"}.
  • The statement period starts the day after the bank account's current reconciliation ends, whatever statementStartDate says. statementStartDate is used, and required, only when the bank account has no current reconciliation: its first, or after every reconciliation it had was voided.
  • statementEndingBalance must equal the current reconciliation's ending balance (0.00 when there is none), plus the money-in items in transactions, minus the money-out items; otherwise 400 Failed reconciled balance check.
  • Each item in transactions must still be unreconciled and dated on or before statementEndDate, with the amount and date it has now, and sent once. Its reconciliationTransactionTypeID and reconciliationObjectTypeID must be the pair the item is listed under: money in (1) for a deposit (4), a bank transfer in (2) or a payout return (11); money out (2) for a payout (5), a payment return (9), a bank fee (10) or a bank transfer out (3); either direction for a bank adjustment (1), a transaction entry (7) or a settlement (8), as its amount goes. The transaction type Adjustment (3) and the object type Transaction (6) never match. The items reconcilable for a period, with their pairs, amounts and dates, are the ones GET /accounting/reconciliations/unreconciled (undocumented) lists.
  • Only one completion or Bank Sync matching run works on a bank account at a time: while another holds it the API answers 400 This reconciliation is being updated, please try again. Retry a moment later.
  • The body is checked in this order: an empty body; transactions; bankAccountID; the end date and ending balance; whether every item can still be reconciled, once; the balance; each item's amount and date; that the ledgers' balances add up to the bank balance; the new record's own rules (a bank account, a start date when there is no current reconciliation, an end date not before the start); then attachments.
  • statementEndingBalance and each item's amount are decimal numbers: a string such as "2450.00", or a JSON number. Each item's reconciliationObjectTypeID is one of the listed values.
  • viewState and matches, which the Manager screen sends for Bank Sync, are optional and left out here.

Side Effects

  • Each item in transactions is marked reconciled with the new reconciliation's ID.
  • The bank account's previous current reconciliation is no longer current.
  • Every unreconciled item dated on or before statementEndDate (older ones included) is copied to the reconciliation's transactions include, with whether it was reconciled; payments and payouts that couldn't be reconciled go to unreconcilableTransactions, and the ledgers' balances to ledgerBalances.
  • Each item it reconciles gets an entry in its activity history: "Deposit Reconciled", "Payout Reconciled", "Payout Return Reconciled", "Bank Adjustment Reconciled", "Settlement Reconciled", "Source Bank Transfer Reconciled" or "Destination Bank Transfer Reconciled", or "Transaction Reconciled" for a payment return or bank fee. A transaction entry gets none.
  • Each file in attachments is attached to the reconciliation. Supporting documents and bank statements attached to the bank account's in-progress reconciliation move to the new one, which then ends.
  • When the bank account's in-progress reconciliation uses Bank Sync, its bank transactions that weren't cleared move to the next period's in-progress reconciliation. Linking bank transactions to the cleared items (matchedBankTransactions) needs matches, which this reference leaves out, so a reconciliation created without it links none.
  • 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.
Authorizations:
basicAuth
Request Body schema: application/json
required
non-empty
bankAccountID
required
string or integer^-?[0-9]+$

The bank account being reconciled, from GET /accounting/bank-accounts. It must be a bank account.

statementEndDate
required
string

Last day of the statement period (YYYY-MM-DD or MM/DD/YYYY). It can't be before the start of the 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 (YYYY-MM-DD or MM/DD/YYYY). Required, and used, only when the bank account has no current reconciliation (its first, or after every one it had was voided); otherwise the period starts the day after the current reconciliation ends, whatever this says.

attachments
Array of strings or integers[ items^-?[0-9]+$ ]

Files to attach to the reconciliation, by fileID from POST /files.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
reconciliationID
required
string^-?[0-9]+$

Unique identifier for the reconciliation record.

reconciliationVersionID
required
integer
Value: 2

Always 2 (Period Adjusted Balance) on a new reconciliation, sent as a JSON number.

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 YYYY-MM-DD: the day after the previous reconciliation's end date when the bank account has one, else the date the request sent.

statementEndDate
required
string <date>

End of the statement period, as YYYY-MM-DD whichever accepted form the request used.

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 1: a new reconciliation becomes the bank account's current one. Sent as a JSON number.

isVoided
required
integer
Value: 0

Always 0 on a new reconciliation, sent as a JSON number.

previousStatementEndingBalance
required
string or number <decimal>

The previous reconciliation's ending balance: a decimal string read from it, or the number 0 when the bank account had no reconciliation before.

moneyInTotal
required
number

Total money-in (credits) for the period. Computed by the API and sent as a JSON number (2450, 2450.25).

moneyOutTotal
required
number

Total money-out (debits) for the period. Computed by the API and sent as a JSON number (2450, 2450.25).

reconciledMoneyInTotal
required
number

Total reconciled credits for the period. Computed by the API and sent as a JSON number (2450, 2450.25).

reconciledMoneyOutTotal
required
number

Total reconciled debits for the period. Computed by the API and sent as a JSON number (2450, 2450.25).

unreconciledMoneyInTotal
required
number

Total unreconciled credits remaining. Computed by the API and sent as a JSON number (2450, 2450.25).

unreconciledMoneyOutTotal
required
number

Total unreconciled debits remaining. Computed by the API and sent as a JSON number (2450, 2450.25).

reconciledBalance
required
number

Net reconciled balance (credits minus debits). Computed by the API and sent as a JSON number (2450, 2450.25).

adjustedCashBalance
required
number

Adjusted cash balance after reconciliation adjustments. Computed by the API and sent as a JSON number (2450, 2450.25).

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 0 on a new reconciliation, sent as a JSON number.

reconciledAdjustmentsTotal
required
number
Value: 0

Total value of reconciled adjustments. Always 0 on a new reconciliation, sent as a JSON number.

unreconciledAdjustmentsTotal
required
number
Value: 0

Total value of unreconciled adjustments. Always 0 on a new reconciliation, sent as a JSON number.

bankAdjustmentBalance
required
number
Value: 0

Net bank adjustment balance. Always 0 on a new reconciliation, sent as a JSON number.

bankAccountUndepositedBalance
required
number
Value: 0

Undeposited balance in the bank account. Always 0 on a new reconciliation, sent as a JSON number.

unsettledPaymentBalance
required
number
Value: 0

Balance of unsettled incoming payments. Always 0 on a new reconciliation, sent as a JSON number.

unsettledPaymentReturnBalance
required
number
Value: 0

Balance of unsettled returned payments. Always 0 on a new reconciliation, sent as a JSON number.

unsettledPayoutBalance
required
number
Value: 0

Balance of unsettled outgoing payouts. Always 0 on a new reconciliation, sent as a JSON number.

unsettledPayoutReturnBalance
required
number
Value: 0

Balance of unsettled returned payouts. Always 0 on a new reconciliation, sent as a JSON number.

createdByUserID
required
string^-?[0-9]+$

ID of the user who created this reconciliation (GET /users (undocumented) lists the account's users).

dateTimeCreated
required
string

When the reconciliation was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

Request samples

Content type
application/json
{
  • "bankAccountID": 395,
  • "statementStartDate": "2026-04-01",
  • "statementEndDate": "2026-04-30",
  • "statementEndingBalance": "2450.00",
  • "transactions": [
    ],
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "reconciliationID": "205",
  • "reconciliationVersionID": 2,
  • "bankAccountID": 395,
  • "statementStartDate": "2026-04-01",
  • "statementEndDate": "2026-04-30",
  • "statementEndingBalance": "2450.00",
  • "isCurrent": 1,
  • "isVoided": 0,
  • "previousStatementEndingBalance": 0,
  • "moneyInTotal": 2450,
  • "moneyOutTotal": 0,
  • "reconciledMoneyInTotal": 2450,
  • "reconciledMoneyOutTotal": 0,
  • "unreconciledMoneyInTotal": 0,
  • "unreconciledMoneyOutTotal": 0,
  • "reconciledBalance": 2450,
  • "adjustedCashBalance": 0,
  • "bankAccountBalance": "0.00",
  • "undepositedPaymentsBalance": "0.00",
  • "paymentsDepositedAfterStatementEndDateBalance": "0.00",
  • "unsettledElectronicTransactionsBalance": "0.00",
  • "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
  • "adjustmentsTotal": 0,
  • "reconciledAdjustmentsTotal": 0,
  • "unreconciledAdjustmentsTotal": 0,
  • "bankAdjustmentBalance": 0,
  • "bankAccountUndepositedBalance": 0,
  • "unsettledPaymentBalance": 0,
  • "unsettledPaymentReturnBalance": 0,
  • "unsettledPayoutBalance": 0,
  • "unsettledPayoutReturnBalance": 0,
  • "createdByUserID": "138",
  • "dateTimeCreated": "2026-11-14 21:18:00"
}

Get Reconciliation

Returns one completed (or voided) bank reconciliation, with the related records the includes parameter asks for: the bank account, the snapshot of the period's transactions taken at completion, the transactions that couldn't be reconciled, the changes made after completion, the ledger balances and the Bank Sync matches.

Use Cases

  • Show a reconciliation report: its totals with transactions and ledgerBalances.
  • Check what changed after completion (reconciliationChangeTransactions, changeTransactionBalance).

Business Rules

  • No permission is checked beyond a valid API key.
  • A key restricted to any portfolio group gets 403 {"error": "Access Denied"}.
  • An ID with no reconciliation answers 400 {"error": "Reconciliation <id> not found"}.

Available Includes (6)

  • bankAccount - The bank account, every column of it.
  • transactions - Every unreconciled item dated on or before the statement end date when the reconciliation was completed (older ones included), cleared or not.
  • unreconcilableTransactions - The payments and payouts in the period that couldn't be reconciled at completion, grouped by why; every group is always sent, as an empty list when it has none.
  • reconciliationChangeTransactions - The transactions reconciled into or removed from the reconciliation on their own after completion, leaving out the ones a void cancelled. Also adds changeTransactionBalance.
  • ledgerBalances - Each ledger's balance in the bank account at the statement end date, leaving out ledgers whose balances are both zero.
  • matchedBankTransactions - The Bank Sync transactions confirmed as matches for the cleared items, grouped by item.
  • GET /accounting/reconciliations - List reconciliations.
  • DELETE /accounting/reconciliations/{reconciliationID} - Void this reconciliation.
  • POST /accounting/transactions/{transactionID}/reconcile - Reconcile one more transaction into it.
Authorizations:
basicAuth
path Parameters
reconciliationID
required
integer
Example: 116

The reconciliation's ID, from GET /accounting/reconciliations.

query Parameters
includes
string
Example: includes=transactions,ledgerBalances

Comma-separated related records to add: bankAccount, transactions, unreconcilableTransactions, reconciliationChangeTransactions, ledgerBalances, matchedBankTransactions. Names it doesn't recognise are ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 transactions include.

object

The period's payments and payouts that couldn't be reconciled at completion, by reason. Requires the unreconcilableTransactions include.

Array of objects

The changes made after completion, without the voided ones. Requires the reconciliationChangeTransactions include.

changeTransactionBalance
number

Net of the changes in reconciliationChangeTransactions: money in added and money out removed count positive, money out added and money in removed count negative. A JSON number (-15, 0), since the API computes it. Sent with the reconciliationChangeTransactions include.

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 ledgerBalances include.

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 (<reconciliationObjectTypeID>_<objectID>, such as 4_51 for deposit 51). An empty JSON array ([]), not an object, when there are none. Requires the matchedBankTransactions include.

Response samples

Content type
application/json
{
  • "reconciliation": {
    },
  • "bankAccount": {
    },
  • "transactions": [
    ],
  • "unreconcilableTransactions": {
    },
  • "reconciliationChangeTransactions": [
    ],
  • "changeTransactionBalance": -15,
  • "ledgerBalances": [
    ],
  • "matchedBankTransactions": {
    }
}

Void Reconciliation

Voids a bank account's current reconciliation: everything it reconciled becomes unreconciled again, and the reconciliation before it becomes current. The voided reconciliation stays readable, with isVoided 1.

Use Cases

  • Redo a reconciliation completed with the wrong items or balance: void it, then complete it again.

Business Rules

  • Requires the Void Reconciliations permission (Accounting › VoidReconciliations); without it the API answers 403 {"error": "Permission Denied"}.
  • A key restricted to any portfolio group gets 403 {"error": "Access Denied"}.
  • Only the bank account's current reconciliation can be voided, one at a time from the newest; an older one, or one already voided, answers 400 Only the most current reconciliation can be deleted.
  • An ID with no reconciliation answers 400 {"error": "Reconciliation <id> not found"}.
  • Only one completion, void or Bank Sync matching run works on a bank account at a time: while another holds it the API answers 400 This reconciliation is being updated, please try again.

Side Effects

  • The reconciliation is kept, marked voided and no longer current.
  • Every deposit, payment, transfer, adjustment and transaction it reconciled, those reconciled into it after completion included, is unreconciled; each keeps the voided reconciliation's ID as its previousReconciliationID.
  • Each item it unreconciles gets the matching "… Unreconciled" entry in its activity history ("Deposit Unreconciled", "Payout Unreconciled", "Transaction Unreconciled", and the rest as on create). A transaction entry gets none.
  • Its change records are voided, so the reconciliationChangeTransactions include no longer lists them.
  • The bank account's newest reconciliation that isn't voided becomes current again.
  • With Bank Sync, the bank transactions it had cleared go back to the bank account's in-progress reconciliation, so the redo can match them again.
  • GET /accounting/reconciliations/{reconciliationID} - Read the voided reconciliation.
  • POST /accounting/reconciliations - Complete the reconciliation again.
Authorizations:
basicAuth
path Parameters
reconciliationID
required
integer
Example: 52

The reconciliation's ID, from GET /accounting/reconciliations (use isCurrent=true to find the one that can be voided).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
reconciliationID
required
string^-?[0-9]+$

Unique identifier for the reconciliation record.

reconciliationVersionID
required
string (reconciliation_versions)
Enum: "1" "2"

Version identifier for the reconciliation.

  • 1 - All Time Adjusted Balance
  • 2 - Period Adjusted Balance
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 0: a voided reconciliation is no longer current. Sent as a JSON number.

isVoided
required
integer
Value: 1

Always 1. Sent as a JSON number.

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 (GET /users (undocumented) lists the account's users).

dateTimeCreated
required
string

When the reconciliation was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "reconciliationID": "259",
  • "reconciliationVersionID": "2",
  • "bankAccountID": "560",
  • "statementStartDate": "2026-04-01",
  • "statementEndDate": "2026-04-30",
  • "statementEndingBalance": "3450.00",
  • "isCurrent": 0,
  • "isVoided": 1,
  • "previousStatementEndingBalance": "1000.00",
  • "moneyInTotal": "2450.00",
  • "moneyOutTotal": "0.00",
  • "reconciledMoneyInTotal": "2450.00",
  • "reconciledMoneyOutTotal": "0.00",
  • "unreconciledMoneyInTotal": "0.00",
  • "unreconciledMoneyOutTotal": "0.00",
  • "reconciledBalance": "3450.00",
  • "adjustedCashBalance": "0.00",
  • "bankAccountBalance": "0.00",
  • "undepositedPaymentsBalance": "0.00",
  • "paymentsDepositedAfterStatementEndDateBalance": "0.00",
  • "unsettledElectronicTransactionsBalance": "0.00",
  • "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
  • "adjustmentsTotal": "0.00",
  • "reconciledAdjustmentsTotal": "0.00",
  • "unreconciledAdjustmentsTotal": "0.00",
  • "bankAdjustmentBalance": "0.00",
  • "bankAccountUndepositedBalance": "0.00",
  • "unsettledPaymentBalance": "0.00",
  • "unsettledPaymentReturnBalance": "0.00",
  • "unsettledPayoutBalance": "0.00",
  • "unsettledPayoutReturnBalance": "0.00",
  • "createdByUserID": "213",
  • "dateTimeCreated": "2026-11-14 21:18:36"
}

Transactions

Search Transactions

Returns a paginated, searchable list of accounting transactions with associated ledger, property, portfolio, and unit context. Each result item contains the transaction plus denormalized lookup data useful for display in transaction lists and reports.

Use Cases

  • Search transactions by date range, amount, or text for audit and reconciliation.
  • Filter by transactionTypeIDs to show only specific payment types (e.g. rent payments).
  • Filter by primaryLedgerIDs to scope results to a specific bank account ledger.
  • Pull recent transactions modified after a given timestamp for sync workflows.

Business Rules

  • Results are restricted to the authenticated user's portfolio.
  • Both propertyIDs (comma-separated) and propertyID (single integer) are accepted; propertyIDs takes precedence.
  • Similarly, transactionTypeIDs takes precedence over transactionTypeID.
  • The ledger, property, portfolio, and unit fields are joined from related tables and may be null if the transaction has no associated property or unit.
  • GET /accounting/transactions/entries/search - Search individual debit/credit entries.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

transactionTypeIDs[]
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

Get Transaction

Returns one accounting transaction of any type (a charge, a payment, a bill, a journal entry, ...), with the related records the includes parameter asks for. Posting a journal entry answers with this same shape.

Use Cases

  • Read a journal entry back after posting it, with its lines (entries) and history (transactionLogs, cashEntryArchives).
  • Follow a payment return to the payment it returned (returnedTransaction), or a payment to its bulk receipt.

Business Rules

  • No permission is checked beyond a valid API key.
  • A key restricted to some portfolios gets 403 {"error": "Access Denied"} for a transaction whose primary ledger it can't access (a manager-ledger transaction needs an unrestricted key).
  • An ID with no transaction answers 400 {"error": "Transaction <id> not found"}.

Available Includes (17)

  • ledger - The primary ledger, or null when there is none.
  • portfolio - The portfolio; false when the transaction has none.
  • property - The property, or null.
  • unit - The unit, or null.
  • lease - The lease, or null.
  • account - Always null.
  • contact - The contact (tenant, owner or vendor), or null.
  • reconciliation - The reconciliation that reconciled the transaction, or null.
  • previousReconciliation - The reconciliation it was reconciled in before, or null.
  • returnedTransaction - The transaction this one returned, or null.
  • bulkPayment - The bulk receipt the transaction belongs to, or null.
  • transactionLogs - Every change made to the transaction, newest first.
  • entries - The cash-basis lines that aren't voided, newest first, with their ledgers and related records.
  • cashEntries - Every cash-basis line, with its ledger.
  • accrualEntries - Every accrual-basis line, with its ledger.
  • cashEntryArchives - The cash-basis lines a change replaced.
  • accrualEntryArchives - The accrual-basis lines a change replaced.
  • GET /accounting/transactions/search - Search transactions.
  • GET /accounting/journal-entries/search - Search journal entries.
  • DELETE /accounting/journal-entries/{transactionID} - Void a journal entry.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

The transaction's ID, from GET /accounting/transactions/search.

query Parameters
includes
string
Example: includes=ledger,property,entries

Comma-separated list of related records to add to the response, each under its own key: ledger, portfolio, property, unit, lease, account, contact, reconciliation, previousReconciliation, returnedTransaction, bulkPayment, transactionLogs, entries, cashEntries, accrualEntries, cashEntryArchives, accrualEntryArchives. Unknown names are ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 ledger include.

included_portfolio (object) or false (any)

The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is false, not null. Requires the portfolio include.

included_property (object) or null

The transaction's property, or null when it has none. Requires the property include.

included_unit (object) or null

The transaction's unit, or null when it has none. Requires the unit include.

included_lease (object) or null

The transaction's lease, or null when it has none. Requires the lease include.

account
null

Always null: transactions have no accountID, so this include never finds an account. Requires the account include.

included_contact (object) or null

The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the contact include.

included_reconciliation (object) or null

The reconciliation that reconciled the transaction, or null. Requires the reconciliation include.

included_reconciliation (object) or null

The reconciliation the transaction was reconciled in before, or null. Requires the previousReconciliation include.

transaction_record (object) or null

The transaction this one returned: the transaction whose returnTransactionID is this transaction's ID (on a payment return, the payment it returned), or null when there is none. Requires the returnedTransaction include.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the bulkPayment include.

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 transactionLogs include.

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 entries include.

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 cashEntries include.

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 accrualEntries include.

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 cashEntryArchives include.

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 accrualEntryArchives include.

Response samples

Content type
application/json
Example
{
  • "transaction": {
    }
}

Reconcile Transaction

Adds one payment return or bank fee to an existing reconciliation of its bank account, outside a full reconciliation: use it for an item that cleared the bank after the reconciliation that should have held it was completed. Answers with the transaction as GET /accounting/transactions/{transactionID} returns it, and takes the same includes.

Use Cases

  • Reconcile a bank fee or a returned payment that was missed when the statement was reconciled.

Business Rules

  • Requires the Modify Reconciliations permission (Accounting › ModifyReconciliations); without it the API answers 403 {"error": "Permission Denied"}.
  • Only lease payment returns, owner payment returns, other payment returns and bank fees can be reconciled one at a time; other types (deposits have their own endpoint) answer 400 Transaction type cannot be reconciled.
  • The transaction must not be voided or already reconciled, and the reconciliation must belong to the transaction's bank account and not be voided. It doesn't have to be the current one.
  • A key restricted to portfolio groups can reconcile only transactions in its groups' portfolios; for any other the API answers 400 {"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.
  • A key restricted to portfolio groups can't list reconciliations (403), so it needs the reconciliation's ID from elsewhere: an unrestricted key, or the previousReconciliationID of a transaction it removed.
  • An ID with no transaction answers 400 {"error": "Transaction <id> not found"}.

Side Effects

  • The transaction's reconciliationID is set, and its previousReconciliationID cleared.
  • A change record (money out added, object type 6 Transaction, whatever the transaction's type) is written to the reconciliation, so its changeTransactionBalance falls by the transaction's amount. Reconciling a transaction back into a reconciliation it was removed from, when that reconciliation holds exactly one removal record for it with the same date and amount, deletes that record instead.
  • A "Transaction Reconciled" entry is added to the transaction's activity history (the Manager screen's history), not to the transactionLogs include.
  • 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.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 99

The transaction's ID, from GET /accounting/transactions/search.

query Parameters
includes
string
Example: includes=ledger,property,entries

Comma-separated list of related records to add to the response, each under its own key: ledger, portfolio, property, unit, lease, account, contact, reconciliation, previousReconciliation, returnedTransaction, bulkPayment, transactionLogs, entries, cashEntries, accrualEntries, cashEntryArchives, accrualEntryArchives. Unknown names are ignored.

Request Body schema: application/json
required
non-empty
reconciliationID
required
string or integer^-?[0-9]+$

The reconciliation to add the transaction to, from GET /accounting/reconciliations. One that doesn't exist answers 400 Reconciliation is required to reconcile a transaction.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 ledger include.

included_portfolio (object) or false (any)

The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is false, not null. Requires the portfolio include.

included_property (object) or null

The transaction's property, or null when it has none. Requires the property include.

included_unit (object) or null

The transaction's unit, or null when it has none. Requires the unit include.

included_lease (object) or null

The transaction's lease, or null when it has none. Requires the lease include.

account
null

Always null: transactions have no accountID, so this include never finds an account. Requires the account include.

included_contact (object) or null

The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the contact include.

included_reconciliation (object) or null

The reconciliation that reconciled the transaction, or null. Requires the reconciliation include.

included_reconciliation (object) or null

The reconciliation the transaction was reconciled in before, or null. Requires the previousReconciliation include.

transaction_record (object) or null

The transaction this one returned: the transaction whose returnTransactionID is this transaction's ID (on a payment return, the payment it returned), or null when there is none. Requires the returnedTransaction include.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the bulkPayment include.

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 transactionLogs include.

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 entries include.

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 cashEntries include.

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 accrualEntries include.

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 cashEntryArchives include.

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 accrualEntryArchives include.

Request samples

Content type
application/json
{
  • "reconciliationID": 73
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Unreconcile Transaction

Removes one reconciled transaction from its reconciliation, leaving the rest of the reconciliation as it is. Answers with the transaction as GET /accounting/transactions/{transactionID} returns it, and takes the same includes. The request has no body.

Use Cases

  • Undo POST /accounting/transactions/{transactionID}/reconcile, or take a transaction out of a completed reconciliation it shouldn't be in.

Business Rules

  • Requires the Modify Reconciliations permission (Accounting › ModifyReconciliations); without it the API answers 403 {"error": "Permission Denied"}.
  • The transaction must be reconciled; otherwise 400 Transaction is not reconciled.
  • A key restricted to portfolio groups can unreconcile only transactions in its groups' portfolios; for any other the API answers 400 {"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.
  • An ID with no transaction answers 400 {"error": "Transaction <id> not found"}.

Side Effects

  • The transaction's reconciliationID is cleared, and its previousReconciliationID set to the reconciliation it was removed from.
  • A change record (money out removed, object type 6 Transaction) is written to that reconciliation, so its changeTransactionBalance rises by the transaction's amount: back to where it was for a transaction reconciled into it on its own, above it for one the full reconciliation cleared.
  • A "Transaction Unreconciled" entry is added to the transaction's activity history (the Manager screen's history), not to the transactionLogs include.
  • 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.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 99

The transaction's ID, from GET /accounting/transactions/search.

query Parameters
includes
string
Example: includes=ledger,property,entries

Comma-separated list of related records to add to the response, each under its own key: ledger, portfolio, property, unit, lease, account, contact, reconciliation, previousReconciliation, returnedTransaction, bulkPayment, transactionLogs, entries, cashEntries, accrualEntries, cashEntryArchives, accrualEntryArchives. Unknown names are ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 ledger include.

included_portfolio (object) or false (any)

The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is false, not null. Requires the portfolio include.

included_property (object) or null

The transaction's property, or null when it has none. Requires the property include.

included_unit (object) or null

The transaction's unit, or null when it has none. Requires the unit include.

included_lease (object) or null

The transaction's lease, or null when it has none. Requires the lease include.

account
null

Always null: transactions have no accountID, so this include never finds an account. Requires the account include.

included_contact (object) or null

The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the contact include.

included_reconciliation (object) or null

The reconciliation that reconciled the transaction, or null. Requires the reconciliation include.

included_reconciliation (object) or null

The reconciliation the transaction was reconciled in before, or null. Requires the previousReconciliation include.

transaction_record (object) or null

The transaction this one returned: the transaction whose returnTransactionID is this transaction's ID (on a payment return, the payment it returned), or null when there is none. Requires the returnedTransaction include.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the bulkPayment include.

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 transactionLogs include.

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 entries include.

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 cashEntries include.

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 accrualEntries include.

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 cashEntryArchives include.

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 accrualEntryArchives include.

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Other Payment

Records a miscellaneous payment receipt against a ledger (e.g. a Money Order, Cash, or Check received that is not a lease rent payment). Creates a transaction of type 12 (Other Payment) and returns the newly created transaction.

Use Cases

  • Record a cash, check, or money order receipt that isn't a standard rent payment.
  • Collect HOA dues, utility reimbursements, or other ad-hoc income against a ledger.
  • Attach scanned copies of receipts via attachments (array of fileID values).

Business Rules

  • Requires the ModifyOtherPayments permission under the Accounting component.
  • ledgerID is required and must reference a valid, accessible ledger.
  • chargeAccountID identifies the income account to credit.
  • bankAccountID identifies the bank account to debit.
  • paymentTypeID must be one of the defined payment type integers (1–8).
  • After a successful save the response is identical to GET /accounting/other-payments/{transactionID}.
  • 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.
Authorizations:
basicAuth
Request Body schema: application/json
required
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 fileID integers from previously uploaded files.

depositID
string or integer or null^-?[0-9]+$

Deposit ID to associate this payment with, if applicable.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Request samples

Content type
application/json
Example
{
  • "ledgerID": 1165,
  • "receivedFrom": "123pm",
  • "amount": 1000,
  • "chargeAccountID": 106,
  • "datePosted": "2026-05-15",
  • "reference": "Test Reference",
  • "description": "Test Description",
  • "bankAccountID": 31,
  • "attachments": [ ],
  • "paymentTypeID": 4
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Lease Charge

Posts a new charge transaction against a lease. The charge is recorded against the specified chart-of-account entry and immediately increases the lease's outstanding balance. Management fees and sales tax charges may be auto-generated depending on the account's configuration and the portfolio's management fee settings.

Use Cases

  • Posting a one-time rent charge outside the recurring schedule (e.g. a prorated amount or a missed month).
  • Applying a non-rent fee such as a parking fee, maintenance reimbursement, or NSF fee.
  • Recording an amenity or utility charge billed directly to the tenant.

Business Rules

  • Requires the Add Charge permission under the Leasing component.
  • The lease must exist and fall within the authenticated user's accessible portfolios; a 400 is returned otherwise.
  • chargeAccountID must reference a valid income-type chart-of-account entry configured for lease charges; invalid accounts are rejected with a 400.
  • datePosted must be a valid calendar date in YYYY-MM-DD format.
  • amount is accepted as a decimal string (e.g. "1000.00").
  • If the account is subject to management fees, a management fee charge transaction is automatically created and linked to this charge.
  • If the account is subject to sales tax, a corresponding sales tax charge transaction is automatically created.
  • 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.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2982

ID of the lease to post the charge against.

Request Body schema: application/json
required
datePosted
required
string <date>

Date the charge should be posted to the ledger (YYYY-MM-DD).

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
Example
{
  • "datePosted": "2026-04-25",
  • "amount": "1500.00",
  • "chargeAccountID": "9",
  • "description": "April Rent"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Lease Payment

Records a payment received from a tenant against a lease. The payment can be applied to specific outstanding charges via the receipts array, applied automatically to the oldest charges first, or held as a prepayment (unapplied credit) for future application. An email receipt is optionally sent to the tenant on success.

Use Cases

  • Recording a rent check payment and applying it to the current month's rent charge.
  • Accepting a partial payment and holding the remainder as a prepayment.
  • Applying a payment automatically across all outstanding charges without specifying individual receipts.
  • Posting an online payment received via the resident portal.

Business Rules

  • Requires the Add Payment permission under the Leasing component.
  • The lease must exist and fall within the authenticated user's accessible portfolios; a 400 is returned otherwise.
  • bankAccountID defaults to the portfolio's primary trust account when null; provide a specific bank account ID to override.
  • leaseTenantID identifies which tenant on the lease is making the payment; this controls the contactID recorded on the transaction and determines where the email receipt is sent.
  • prepaymentAccountID controls where unallocated funds are held. Use -1 to apply to the portfolio's default prepayment account. Set hasPrepayment: true and supply prepaymentAmount to split the payment between charges and prepayment.
  • If applyAutomatically is true, the server allocates the payment to outstanding charges from oldest to newest, ignoring the receipts array.
  • If applyAutomatically is false, supply a receipts array specifying which charge transactions to apply the payment to and the amount to apply to each.
  • receipts[].chargeTransactionID must reference a charge transaction on this lease.
  • The sum of receipts[].amount plus prepaymentAmount should equal amount.
  • emailReceipt: true triggers an email receipt to the tenant identified by leaseTenantID.
  • 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.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2982

ID of the lease to record the payment against.

Request Body schema: application/json
required
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 (YYYY-MM-DD).

leaseTenantID
required
string or integer^-?[0-9]+$

ID of the lease-tenant record identifying the paying tenant. Controls contactID on the transaction and email receipt recipient.

bankAccountID
string or integer or null^-?[0-9]+$

ID of the bank account to deposit the payment into. Pass null to use the portfolio's default trust account.

emailReceipt
boolean
Default: false

Whether to send a payment receipt email to the tenant identified by leaseTenantID.

leaseID
string or integer^-?[0-9]+$

ID of the lease (must match the {leaseID} path parameter).

prepaymentAccountID
string or integer or null^-?[0-9]+$

Account to hold unallocated (prepayment) funds. Use "-1" for the portfolio's default prepayment account. Required when hasPrepayment is true.

prepaymentAmount
string or number or null <decimal>

Portion of amount to hold as a prepayment (unapplied credit). Required when hasPrepayment is true.

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 true, the server applies the payment to outstanding charges oldest-first, ignoring the receipts array. When false, use the receipts array to specify exactly which charges to apply the payment to.

Array of objects

List of charge transactions to apply this payment to. Required when applyAutomatically is false and there are charges to apply the payment against.

hasPrepayment
boolean
Default: false

Whether any portion of this payment should be held as a prepayment. When true, supply prepaymentAccountID and prepaymentAmount.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
Example
{
  • "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": [
    ],
  • "hasPrepayment": false
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Lease Refunded Return

Records a refunded return on a lease: a manual tenant credit to the lease's unallocated (prepayment) account, funded from an equity account. It is used when a payment whose credit was already refunded to the tenant comes back from the bank, to restore the credit the refund drew on. It isn't linked to a specific returned payment.

The response is the new refunded return as GET /accounting/leases/refunded-returns/{transactionID} (undocumented) returns it, with the same includes.

Use Cases

  • Restoring a tenant's credit by hand after a refunded payment was returned, funded from the owner distribution account (the Manager app's default).

Business Rules

  • Requires the Modify Lease Transactions permission (Accounting › ModifyLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • The body must not be empty ({} counts as empty): 400 {"error": "invalid input."}.
  • amount (above 0.00), datePosted, description, equityAccountID and unallocatedAccountID are required; a missing one answers 400 with a validation map keyed transaction.<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).
  • A leaseID with no lease answers 400 {"error": "Failed to get lease details"}, not 404; for an API user restricted to portfolio groups it answers 403 {"error": "Access Denied"} instead, since the restriction check runs first. A path value that isn't a number answers the stock 404.
  • A non-numeric amount answers 500 with no body.

Side Effects

  • The refunded return posts a credit of amount to unallocatedAccountID and a debit of amount to equityAccountID, so the tenant's credit balance rises by amount.

From the code, not covered by a contract test:

  • A create entry is added to its transaction log.

Available Includes (3)

  • property - the lease's property
  • unit - the lease's unit
  • lease - the lease
  • DELETE /accounting/leases/refunded-returns/{transactionID} - Void a refunded return.
  • POST /accounting/leases/payments/{transactionID}/return - Return a payment; it records a refunded return by itself when part of the payment's credit had been refunded.
  • GET /accounting/accounts/search - Find the account IDs.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2982

ID of the lease to credit.

query Parameters
includes
string
Example: includes=lease

Comma-separated related records to add to the response, each under its own key: property, unit, lease.

Request Body schema: application/json
required
non-empty
amount
required
string or number <decimal> > 0

Amount to credit; must be above 0.00.

datePosted
required
string

Date the refunded return posts to the ledger (YYYY-MM-DD or MM/DD/YYYY).

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 GET /accounting/accounts/search.

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 unallocatedAccountID), normally the accounting settings' prepayment account. The IDs come from GET /accounting/accounts/search.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 property include.

object (included_unit)

The lease's unit, with the unit include.

object (included_lease)

The lease, with the lease include.

Request samples

Content type
application/json
{
  • "amount": "120.00",
  • "datePosted": "2026-11-09",
  • "description": "Refunded payment returned",
  • "equityAccountID": "453",
  • "unallocatedAccountID": "3"
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Lease Deposit Release Credit

Releases part or all of a lease's collected security deposit as a tenant credit, and can apply that credit to open charges (final charges at move-out) in the same request. The credit can't release more than was collected on each deposit account, and its parts (depositReleases) must add up to its amount.

The response is the new credit as GET /accounting/leases/deposit-release-credits/{transactionID} (undocumented) returns it, with the same includes.

Use Cases

  • Applying a security deposit to move-out charges (cleaning, damages, unpaid rent).
  • Releasing a deposit as a credit, to refund it with POST /accounting/leases/{leaseID}/payouts.

Business Rules

  • Requires the Modify Lease Transactions permission (Accounting › ModifyLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • The body must not be empty ({} counts as empty): 400 {"error": "invalid input."}.
  • At least one deposit release is required, each naming a deposit liability account the lease has collected a deposit on, for no more than its collected balance; and the releases must add up to amount. Each failure answers 400 with its message (see the examples).
  • description is required: without it the API answers 400 {"depositReleaseCredit.description": ["Description is required"]}.
  • An account whose collected deposit is already fully released counts as not collected, and answers Cannot release a deposit that has not been collected.
  • Each receipts entry must name an open charge on this lease: a charge on another lease answers 400 {"depositReleaseCredit.receipt.receipt": ["Invalid Charge or Payment."]}, and one that doesn't exist {"depositReleaseCredit.receipt.receipt": ["Could not locate receipt charge transaction"]}. Applying more than a charge's open amount (depositReleaseCredit.receipt.charge.amountPaid), or more than the credit (depositReleaseCredit.receipt.payment.amountAllocated), answers 400 (see the examples).
  • A leaseID with no lease has no collected deposit, so it answers 400 {"depositRelease": ["Cannot release a deposit that has not been collected"]}, not 404; for an API user restricted to portfolio groups it answers 403 {"error": "Access Denied"} instead, since the restriction check runs first. A path value that isn't a number answers the stock 404.
  • A non-numeric amount answers 500 with no body.

Side Effects

  • A deposit-release credit (type 19) is posted for amount, and one deposit-release row is written per depositReleases entry; the collected deposit left to release drops by amount.
  • Each receipts entry applies the credit to that charge.

From the code, not covered by a contract test:

  • The credit posts to the account settings' security-deposit release account (or, when there is none, the unallocated credit account), so its unapplied part is a tenant credit.
  • A create entry is added to its transaction log, and the lease's last-activity date is updated.
  • Applying the credit to a charge takes the management fee due on that charge, as any payment does: the charge's and the receipt's managementFeeAmountPaid rise (seen on a live call, where 12.50 was taken on a 125.00 charge).

Available Includes (7)

  • account - always false: the include looks up a column these transactions don't have
  • contact - always false: a deposit-release credit has no contact
  • lease - the lease
  • property - the lease's property
  • unit - the lease's unit
  • receipts - the charges the credit was applied to
  • depositReleases - the credit's deposit-release rows
  • DELETE /accounting/leases/deposit-release-credits/{transactionID} - Void a deposit-release credit.
  • GET /accounting/leases/{leaseID}/charges/for-payment (undocumented) - Find the lease's open charges for receipts.
  • GET /leases/{leaseID}/deposit-balances (undocumented) - The deposit accounts the lease has collected on, with the balance left to release on each.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2982

ID of the lease whose deposit is released.

query Parameters
includes
string
Example: includes=receipts,depositReleases

Comma-separated related records to add to the response, each under its own key: account, contact, lease, property, unit, receipts, depositReleases.

Request Body schema: application/json
required
non-empty
amount
required
string or number <decimal>

Amount to release; must equal the sum of depositReleases[].amount.

datePosted
required
string

Date the credit posts to the ledger (YYYY-MM-DD or MM/DD/YYYY).

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 account include, always false: it looks up the transaction's accountID, which these transactions don't have.

contact
boolean
Value: false

With the contact include, always false; a deposit-release credit has no contact.

object (included_lease)

The lease, with the lease include.

object (included_property)

The lease's property, with the property include.

object (included_unit)

The lease's unit, with the unit include.

Array of objects

The credit's receipts that aren't voided, with the receipts include: the receipt, and the charge and payout it applies to (left joins, so a missing one arrives with every value null).

Array of objects (included_deposit_release)

The credit's deposit-release rows, with the depositReleases include.

Request samples

Content type
application/json
{
  • "amount": "400.00",
  • "datePosted": "2026-11-09",
  • "description": "Security deposit applied to final charges",
  • "depositReleases": [
    ],
  • "receipts": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Create Lease Payout

Refunds a tenant's credit balance: creates a payout batch holding one payout to the tenant, paid from the given bank account, and applies it to the tenant's payments or credits through receipts. Nothing is paid until the batch is approved; the batch is created unapproved unless isApproved is sent and honoured (see Business Rules).

Use Cases

  • Refunding a tenant's remaining credit (a prepayment, an overpayment) by check at move-out.
  • Refunding a credit by ACH to the tenant's bank account, entered or saved.

Business Rules

  • Requires the Modify Lease Transactions permission (Accounting › ModifyLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • The body must not be empty ({} counts as empty): 400 {"error": "invalid input."}.
  • A leaseID with no lease answers 400 {"error": "Lease 999999999 not found"}, not 404. A path value that isn't a number answers the stock 404.
  • isApproved: true approves the batch only when the API key's role also has the Approve Payout Batch permission (Accounting › ApproveBillPay). Without it the flag is silently ignored and the batch is created unapproved, with a 200.
  • Approving needs an MFA code only when the accounting setting isMFACodeRequiredForPayoutApproval is on: then isApproved: true without mfaCode answers 400 {"mfaCode": ["MFA Code is Required"]}, and a wrong code {"mfaCode": ["MFA Code is Invalid"]}.
  • The receipts must add up to amount exactly, and no receipt may apply more than what is left of the payment or credit it names; otherwise 400 (see the examples).
  • The payee, from the code (the tests cover leaseTenantID and an unknown contactID): contactID when sent; else the contact of leaseTenantID, which must be on this lease; else the lease's first tenant. A contactID that names no tenant contact answers 400 {"payoutBatchContract.checkBatch.checks[0].payeeID": ["Payee cannot be found."]} (on a check payout).
  • Each receipts[].paymentTransactionID must be a lease payment, credit or deposit-release credit; any other transaction (a charge, say) answers 400 with a validation map naming the payout's liability account (see the receiptNotAPayment example).
  • An ACH payout (payoutTypeID 4, and from the code 3 as well) needs the payee's bank details: a saved paymentMethodID or the refundAch* fields. Without them it answers 400 with a validation map keyed payouts[0].<field>.
  • A non-numeric amount answers 500 with no body.

Side Effects

  • A payout batch is created on bankAccountID, with one payout of amount to the payee. A check payout takes the bank account's next check number, and the bank account's next check number goes up by one.
  • Each receipt applies the payout to a tenant payment or credit, so the tenant's credit balance drops by amount.
  • With isApproved honoured, the batch is approved and queued for payment; from the code, approval also sends a payout-batch-approved notification and writes a "Payout Batch Modified" log entry.

From the code, not covered by a contract test:

  • An unapproved batch sends the approvers a payout-approval request notification.
  • The payout's isMoveOutTransaction defaults to whether the lease is in move-out (active or completed), unless the body sets it.
  • A checkNumber in the body is used as is, and the bank account's next check number isn't advanced.
  • A "Payout Batch Created" log entry is written.
  • 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).
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2982

ID of the lease whose tenant is refunded.

Request Body schema: application/json
required
non-empty
bankAccountID
required
string or integer^-?[0-9]+$

Bank account the payout is paid from; a missing or unknown one answers 400 {"bankAccount": ["Bank Account not found"]}. The IDs come from GET /accounting/accounts/search.

datePosted
required
string

Date the payout batch posts (YYYY-MM-DD or MM/DD/YYYY).

amount
required
string or number <decimal>

Payout amount; must equal the sum of receipts[].amount.

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:

  • 1 - Other (paid outside Rentvine)
  • 2 - Check
  • 3 - eCheck (ACH through the payment processor)
  • 4 - NACHA (ACH through a file sent to the bank)
leaseTenantID
string or integer^-?[0-9]+$

Tenant on this lease to pay, when contactID isn't sent. The IDs come from GET /leases/{leaseID}/tenants.

contactID
string or integer^-?[0-9]+$

Contact to pay. The tenants' contact IDs come from GET /leases/{leaseID}/tenants.

description
string or null

Ignored; a payout has no description. Its ledger transaction is described with memo.

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 payeeCountryID, so send both: a state without a country answers 400 State does not exist.. The values come from GET /states (undocumented).

payeePostalCode
string or null

Postal code of the payee.

payeeCountryID
string or null

Country of the payee. The values come from GET /countries (undocumented).

isApproved
boolean
Default: false

Approve the batch now. Honoured only when the API key's role has Approve Payout Batch; otherwise ignored.

mfaCode
string or null

The approver's MFA code, needed with isApproved: true only when the setting isMFACodeRequiredForPayoutApproval is on.

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 (payoutTypeID 3 or 4): a saved ACH payment method of the payee to pay to, instead of the refundAch* fields. An ID that isn't one of the payee's saved ACH methods answers 400 {"error": "Saved payment method not found"}. The IDs come from GET /leases/{leaseID}/payment-methods (undocumented).

(bank_account_types_request (string or integer)) or null

For an ACH payout without paymentMethodID, the payee's bank account type.

  • 1 - Savings
  • 2 - Checking
refundAchRoutingNumber
string or null

For an ACH payout without paymentMethodID, the payee's routing number.

refundAchAccountNumber
string or null

For an ACH payout without paymentMethodID, the payee's account number.

refundAchIsCorporateAccount
string or integer or boolean or null

For an ACH payout without paymentMethodID, whether the payee's bank account is a business account.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

The payout batch the request created.

Request samples

Content type
application/json
{
  • "bankAccountID": "437",
  • "datePosted": "2026-11-09",
  • "payoutTypeID": 2,
  • "amount": "150.00",
  • "leaseTenantID": "413",
  • "description": "Move-out credit refund",
  • "memo": "Example memo.",
  • "checkPayeeName": "Jordan Example",
  • "payeeAddress": "123 Main St",
  • "payeeCity": "Springfield",
  • "payeePostalCode": "12345",
  • "receipts": [
    ]
}

Response samples

Content type
application/json
{
  • "payoutBatch": {
    }
}

Void Lease Charge

Voids a posted lease charge. This is not a delete: the charge keeps its row and its history, is flagged voided (isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided charge can't be changed or voided again.

Use Cases

  • Reversing a charge posted in error, while keeping it in the lease's history.

Business Rules

  • Requires the Void Lease Transactions permission (Accounting › VoidLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • A transaction ID that doesn't exist answers 400 {"error": "Charge 999999999 not found"}, and one that isn't a lease charge answers 400 {"error": "Transaction not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • A charge that is already voided answers 400 {"isVoided": ["Cannot modify a voided transaction"]}.
  • A charge with any payment or credit applied to it (amountPaid above 0.00) can't be voided: 400 {"amountPaid": ["Cannot void a charge that has receipts applied. You must reverse all receipts before voiding."]}. Void the payments and credits applied to it first; the void never frees them.

Side Effects

  • Every ledger entry of the charge is voided, and a void entry is added to its transaction log.
  • The charge's tenant notification, if it hasn't been sent yet, is dropped.

From the code, not covered by a contract test:

  • If the charge is the lease's renters-insurance charge, the lease's link to it is cleared.
  • An updateLeaseCharge event is recorded, and the lease's last-activity date is updated.
  • 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).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease charge to void.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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:

  • 1 - Lease Charge
  • 2 - Tenant Receipt
  • 3 - Lease Credit
  • 4 - Lease Payment Return
  • 5 - Owner Receipt
  • 6 - Owner Contribution Return
  • 7 - Bill Charge
  • 8 - Bill Payout Charge
  • 9 - Bank Fee
  • 10 - Bank Transfer
  • 11 - Journal Entry
  • 12 - Other Receipt
  • 13 - Other Payment Return
  • 14 - Management Fee
  • 15 - Ledger Transfer
  • 16 - Ledger Payout
  • 17 - Ledger Payout Return
  • 18 - Bill Payout Charge Return
  • 19 - Lease Deposit Release Credit
  • 20 - Lease Payout
  • 21 - Lease Payout Return
  • 22 - Bill Credit
  • 23 - Bill Credit Applied
  • 24 - Bill Credit Return
  • 25 - Lease Refunded Return
managementFeeMode
required
string (management_fee_modes)
Enum: "1" "2"

Management fee mode the account used when the transaction posted:

  • 1 - Ledger
  • 2 - Bill
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:

  • 1 - Any
  • 2 - None
  • 3 - Account
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 0 in memory. Null for types that don't track it.

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 0. Null for types that don't track it.

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:

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
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 1: the void sets it in memory, so this response sends a number where a read sends the string '1'.

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 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isProrated
required
string or integer
Enum: 0 "1"

Whether this is a prorated charge. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isMoveOutTransaction
required
string or integer
Enum: 0 "1"

Whether this is a move-out transaction. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

moveOutAmount
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

When the transaction was last changed. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "transactionID": "50",
  • "transactionTypeID": "1",
  • "managementFeeMode": "2",
  • "primaryLedgerID": "122",
  • "portfolioID": "62",
  • "propertyID": "60",
  • "unitID": "60",
  • "leaseID": "60",
  • "billID": null,
  • "contactID": null,
  • "bankAccountID": null,
  • "chargeAccountID": "9",
  • "equityAccountID": null,
  • "destinationBankAccountID": null,
  • "managementFeeIncomeAccountID": null,
  • "prepaymentAccountFilterTypeID": null,
  • "prepaymentAccountID": null,
  • "unallocatedAccountID": null,
  • "payoutID": null,
  • "payoutReturnID": null,
  • "amount": "250.00",
  • "amountPaid": 0,
  • "amountAllocated": null,
  • "processingFee": null,
  • "convenienceFee": null,
  • "convenienceFeeTransactionID": null,
  • "description": "Carpet Cleaning",
  • "reference": null,
  • "receivedFrom": null,
  • "returnTransactionID": null,
  • "returnTypeID": null,
  • "returnDescription": null,
  • "bulkPaymentID": null,
  • "paymentTypeID": null,
  • "billChargeTransactionID": null,
  • "billCreditTransactionID": null,
  • "discountAmount": null,
  • "markupAmount": null,
  • "managementFeeAmountPaid": "0.00",
  • "isAdditionalManagementFee": "0",
  • "managementFeePercent": "10.00",
  • "isSuppressed": "0",
  • "managementFeeExpenseAccountID": null,
  • "managementFeePeriodDate": null,
  • "managementFeeSalesTaxSettingID": null,
  • "managementFeeSalesTaxAmountPaid": null,
  • "managementFeeSalesTaxPercent": null,
  • "managementFeeSalesTaxIncomeAccountID": null,
  • "managementFeeSalesTaxExpenseAccountID": null,
  • "managementFeeBatchID": null,
  • "isSalesTaxCharge": null,
  • "salesTaxSettingID": null,
  • "salesTaxInitiatedFromTransactionID": null,
  • "isVoided": 1,
  • "bankAccountGatewayID": null,
  • "bankAccountGatewayTransactionID": null,
  • "settlementID": null,
  • "paymentAccountName": null,
  • "paymentAccountNumberTruncated": null,
  • "depositID": null,
  • "reconciliationID": null,
  • "previousReconciliationID": null,
  • "achStatusID": null,
  • "bankTransferID": null,
  • "lateFeePeriod": null,
  • "isFromManager": null,
  • "isMoveInCharge": 0,
  • "isProrated": 0,
  • "isMoveOutTransaction": 0,
  • "moveOutAmount": null,
  • "discountMarkupBillChargeTransactionID": null,
  • "recurringObjectID": null,
  • "residentServiceID": null,
  • "residentPackageID": null,
  • "withholdingTaxAgencyID": null,
  • "withholdingTaxContactID": null,
  • "datePosted": "2026-11-09",
  • "dateTimeCreated": "2026-11-09 04:47:27",
  • "dateTimeModified": "2026-11-09 04:47:28"
}

Void Lease Credit

Voids a posted lease credit. This is not a delete: the credit keeps its row and its history, is flagged voided (isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided credit can't be changed or voided again.

Use Cases

  • Reversing a credit posted in error, while keeping it in the lease's history.

Business Rules

  • Requires the Void Lease Transactions permission (Accounting › VoidLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • A transaction ID that doesn't exist answers 400 {"error": "Credit 999999999 not found"}, and one that isn't a lease credit answers 400 {"error": "Credit 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • A credit that is already voided answers 400 {"isVoided": ["Cannot modify a voided transaction"]}.
  • A credit partly refunded to the tenant by a payout that is still active, even an unapproved one, can't be voided: 400 {"receipt.isVoided": [...], "credit.receipt.isVoided": [...]}, both Cannot void a payout receipt that is associated with an active payout. Void the payout first with DELETE /accounting/payouts/{payoutID} (undocumented).

Side Effects

  • The credit's receipts are voided, so any charge it was applied to is open again.
  • Every ledger entry of the credit is voided, and a void entry is added to its transaction log.

From the code, not covered by a contract test:

  • The lease's last-activity date is updated.
  • POST /accounting/leases/{leaseID}/credits (undocumented) - Post a credit.
  • GET /accounting/transactions/search - Find the credit to void (transactionTypeIDs[] 3).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease credit to void.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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:

  • 1 - Lease Charge
  • 2 - Tenant Receipt
  • 3 - Lease Credit
  • 4 - Lease Payment Return
  • 5 - Owner Receipt
  • 6 - Owner Contribution Return
  • 7 - Bill Charge
  • 8 - Bill Payout Charge
  • 9 - Bank Fee
  • 10 - Bank Transfer
  • 11 - Journal Entry
  • 12 - Other Receipt
  • 13 - Other Payment Return
  • 14 - Management Fee
  • 15 - Ledger Transfer
  • 16 - Ledger Payout
  • 17 - Ledger Payout Return
  • 18 - Bill Payout Charge Return
  • 19 - Lease Deposit Release Credit
  • 20 - Lease Payout
  • 21 - Lease Payout Return
  • 22 - Bill Credit
  • 23 - Bill Credit Applied
  • 24 - Bill Credit Return
  • 25 - Lease Refunded Return
managementFeeMode
required
string (management_fee_modes)
Enum: "1" "2"

Management fee mode the account used when the transaction posted:

  • 1 - Ledger
  • 2 - Bill
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:

  • 1 - Any
  • 2 - None
  • 3 - Account
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 0 in memory. Null for types that don't track it.

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 0. Null for types that don't track it.

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:

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
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 1: the void sets it in memory, so this response sends a number where a read sends the string '1'.

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 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isProrated
required
string or integer
Enum: 0 "1"

Whether this is a prorated charge. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isMoveOutTransaction
required
string or integer
Enum: 0 "1"

Whether this is a move-out transaction. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

moveOutAmount
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

When the transaction was last changed. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "transactionID": "66",
  • "transactionTypeID": "3",
  • "managementFeeMode": "2",
  • "primaryLedgerID": "155",
  • "portfolioID": "79",
  • "propertyID": "76",
  • "unitID": "76",
  • "leaseID": "76",
  • "billID": null,
  • "contactID": null,
  • "bankAccountID": null,
  • "chargeAccountID": "9",
  • "equityAccountID": null,
  • "destinationBankAccountID": null,
  • "managementFeeIncomeAccountID": null,
  • "prepaymentAccountFilterTypeID": null,
  • "prepaymentAccountID": null,
  • "unallocatedAccountID": "4",
  • "payoutID": null,
  • "payoutReturnID": null,
  • "amount": "75.00",
  • "amountPaid": null,
  • "amountAllocated": 0,
  • "processingFee": null,
  • "convenienceFee": null,
  • "convenienceFeeTransactionID": null,
  • "description": "Rent concession",
  • "reference": null,
  • "receivedFrom": null,
  • "returnTransactionID": null,
  • "returnTypeID": null,
  • "returnDescription": null,
  • "bulkPaymentID": null,
  • "paymentTypeID": null,
  • "billChargeTransactionID": null,
  • "billCreditTransactionID": null,
  • "discountAmount": null,
  • "markupAmount": null,
  • "managementFeeAmountPaid": null,
  • "isAdditionalManagementFee": null,
  • "managementFeePercent": null,
  • "isSuppressed": "0",
  • "managementFeeExpenseAccountID": null,
  • "managementFeePeriodDate": null,
  • "managementFeeSalesTaxSettingID": null,
  • "managementFeeSalesTaxAmountPaid": null,
  • "managementFeeSalesTaxPercent": null,
  • "managementFeeSalesTaxIncomeAccountID": null,
  • "managementFeeSalesTaxExpenseAccountID": null,
  • "managementFeeBatchID": null,
  • "isSalesTaxCharge": null,
  • "salesTaxSettingID": null,
  • "salesTaxInitiatedFromTransactionID": null,
  • "isVoided": 1,
  • "bankAccountGatewayID": null,
  • "bankAccountGatewayTransactionID": null,
  • "settlementID": null,
  • "paymentAccountName": null,
  • "paymentAccountNumberTruncated": null,
  • "depositID": null,
  • "reconciliationID": null,
  • "previousReconciliationID": null,
  • "achStatusID": null,
  • "bankTransferID": null,
  • "lateFeePeriod": null,
  • "isFromManager": "0",
  • "isMoveInCharge": 0,
  • "isProrated": 0,
  • "isMoveOutTransaction": 0,
  • "moveOutAmount": null,
  • "discountMarkupBillChargeTransactionID": null,
  • "recurringObjectID": null,
  • "residentServiceID": null,
  • "residentPackageID": null,
  • "withholdingTaxAgencyID": null,
  • "withholdingTaxContactID": null,
  • "datePosted": "2026-11-09",
  • "dateTimeCreated": "2026-11-09 04:48:08",
  • "dateTimeModified": "2026-11-09 04:48:08"
}

Void Lease Payment

Voids a posted lease payment. This is not a delete: the payment keeps its row and its history, is flagged voided (isVoided '1'), is taken out of its bank deposit, and its receipts and ledger entries are voided, so the charges it paid are open again and it no longer counts toward the lease's balance. The response is the voided payment as GET /accounting/leases/payments/{transactionID} (undocumented) returns it, with the same includes.

Use Cases

  • Reversing a payment entered in error (wrong lease, wrong amount, a duplicate).
  • Reversing a check that was never deposited. A deposited payment that bounced is returned instead (POST /accounting/leases/payments/{transactionID}/return), which keeps the payment and records the return.

Business Rules

  • Requires the Void Lease Transactions permission (Accounting › VoidLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • A transaction ID that doesn't exist, or isn't a lease payment, answers 400 {"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • These payments can't be voided, each answering 400 with a validation map:
    • already voided: {"isVoided": ["Cannot modify a voided transaction"]};
    • gateway-connected (an online payment): {"isVoided": ["Cannot void a gateway connected transaction"]};
    • returned: {"isVoided": ["Transaction has been returned and cannot be voided"]};
    • reconciled: {"depositID": [...], "deposit.transaction.depositID": [...]}, both Cannot remove deposit from reconciled transaction;
    • part of a bulk payment (bulk receipt) that isn't voided: {"isVoided": ["Cannot void a transaction that is connected to a bulk payment that is not voided"]}. Once the bulk payment is voided, its payments can be voided one by one;
    • partly refunded to the tenant by a payout that is still active, even an unapproved one: {"receipt.isVoided": [...], "payment.receipt.isVoided": [...]}, both Cannot void a payout receipt that is associated with an active payout. Void the payout first with DELETE /accounting/payouts/{payoutID} (undocumented).

Side Effects

  • The payment is taken out of its bank deposit (depositID becomes null).
  • Its receipts are voided, so every charge it paid is open again.
  • Every ledger entry of the payment is voided, and a void entry is added to its transaction log.

From the code, not covered by a contract test:

  • The lease's last-activity date is updated.

Available Includes (12)

  • deposit - the bank deposit; always false after a void, which takes the payment out of its deposit
  • contact - the paying tenant's contact
  • lease - the lease
  • portfolio - the portfolio the payment posted to
  • property - the lease's property
  • unit - the lease's unit
  • propertyPortfolios - every ownership period of the property
  • returnTransaction - the return transaction; always null here, since a returned payment can't be voided
  • bulkPayment - the bulk payment it belongs to, or null
  • transactionLogs - the payment's change log, the void included
  • receipts - receipts that aren't voided; always empty after a void
  • managementFees - management fees that aren't voided; empty after a void
  • POST /accounting/leases/{leaseID}/payments - Record a payment.
  • POST /accounting/leases/payments/{transactionID}/return - Return a deposited payment instead of voiding it.
  • GET /accounting/transactions/search - Find the payment to void (transactionTypeIDs[] 2).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80981

ID of the lease payment to void.

query Parameters
includes
string
Example: includes=returnTransaction,transactionLogs

Comma-separated related records to add to the response, each under its own key: deposit, contact, lease, portfolio, property, unit, propertyPortfolios, returnTransaction, bulkPayment, transactionLogs, receipts, managementFees.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 deposit include; false when it isn't in one. A void takes the payment out of its deposit, so after a void this is always false.

object (included_contact)

The paying tenant's contact, with the contact include.

object (included_lease)

The payment's lease, with the lease include.

object (included_portfolio)

The portfolio the payment posted to, with the portfolio include.

object (included_property)

The lease's property, with the property include.

object (included_unit)

The lease's unit, with the unit include.

Array of objects (included_property_portfolio)

Every ownership period of the lease's property, with the propertyPortfolios include.

lease_transaction (object) or null

The payment's return transaction, with the returnTransaction include; null until the payment is returned.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the payment belongs to, with the bulkPayment include; null when none.

Array of objects

The payment's change log, with the transactionLogs include.

Array of objects (lease_receipt_row)

The payment's receipts that aren't voided, with the receipts include. A void voids every receipt and a return voids the charge receipts, so after either only refund receipts can remain.

Array of objects (included_management_fee)

The management fees taken on the payment that aren't voided, with the managementFees include. Voiding a receipt voids its fees, so after a void or a return this is empty in every case the contract tests and the live call produced.

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Return Lease Payment

Records that a deposited lease payment came back from the bank (a bounced check, an NSF). The payment itself is kept unchanged except that it now points at a new return transaction (returnTransactionID), which reverses it for the full amount on the same bank account. The charges the payment paid are open again. Optionally, a bank fee and a tenant charge (an NSF fee) are posted in the same request.

The response is the original payment, not the return: request includes=returnTransaction to get the return transaction too. It is the payment as GET /accounting/leases/payments/{transactionID} (undocumented) returns it, with the same includes.

Use Cases

  • Recording a tenant's bounced check, and charging the tenant the lease's NSF fee in the same call.
  • Recording a returned payment and the bank's return fee, when management fees are kept in the ledger.

Business Rules

  • Requires the Modify Lease Transactions permission (Accounting › ModifyLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • The body must not be empty ({} counts as empty): 400 {"error": "invalid input."}. It must hold a return object with a datePosted. The checks run in this order: the body; whether the payment is voided or already returned; the return object; whether the payment is deposited; and only then the return's own fields.
  • A transaction ID that doesn't exist, or isn't a lease payment, answers 400 {"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • Only a payment that is deposited, not voided and not already returned can be returned. A voided or an already returned payment answers {"payment": ["This payment cannot be returned"]}; one that isn't in a bank deposit answers {"transactionID": ["Cannot return a payment that has not been deposited."]}. A payment in a bulk payment (bulk receipt) is never in a deposit of its own, so it gets the same not-deposited answer.
  • An online (gateway-connected) payment can't be returned through this API: its returns come from the payment processor, and the request answers {"return.bankAccountGatewayTransactionID": ["Bank Account Gateway Transaction ID is required for gateway connect transaction"]}.
  • bankFee is posted only when the account keeps management fees in the ledger; under bill management fees it is ignored. The tenant charge is always posted, with the description NSF Fee.
  • When part of the payment's credit was already refunded to the tenant, the refund is recovered (see Side Effects) from the account's owner distribution account. If that can't be saved (for example, the accounting settings name no owner distribution account), the API answers 400 with an empty array [] and no message.

Side Effects

  • A return transaction (type 4, Lease Payment Return) is created for the payment's full amount, on its bank account, dated return.datePosted; the payment's returnTransactionID points at it.
  • The payment's charge receipts are voided, so the charges it paid are open again.
  • If part of the payment's credit had been refunded to the tenant (a payout), a refunded return (a tenant credit funded from the owner distribution account, described Refunded Payment Returned) and a matching charge (Refunded Payment Return Recovery) are posted for the refunded amount.
  • With bankFee under ledger management fees, a bank fee is posted on the payment's bank account.
  • With charge, a tenant charge described NSF Fee is posted on the lease, dated return.datePosted. Like any new charge, it is paid at once from the tenant's other unapplied credits (prepayments), if there are any.

From the code, not covered by a contract test:

  • A return entry is added to the payment's transaction log, and a create entry to the return's.
  • If the payment paid its own convenience-fee charge, that charge is voided.
  • When the accounting settings lock the tenant portal after a number of returns, and the lease reaches it, the lease's portal payments are disabled (and certified funds required, if the settings say so).
  • A createLeasePaymentReturn event is recorded, and the lease's last-activity date is updated.

Available Includes (12)

  • deposit - the bank deposit the payment is in
  • contact - the paying tenant's contact
  • lease - the lease
  • portfolio - the portfolio the payment posted to
  • property - the lease's property
  • unit - the lease's unit
  • propertyPortfolios - every ownership period of the property
  • returnTransaction - the return transaction this request created
  • bulkPayment - the bulk payment it belongs to, or null
  • transactionLogs - the payment's change log
  • receipts - receipts that aren't voided: after a return, only refund (payout) receipts
  • managementFees - management fees that aren't voided; empty after a return
  • DELETE /accounting/leases/payments/{transactionID} - Void a payment instead (one that was never deposited).
  • POST /accounting/leases/{leaseID}/payouts - Refund a tenant's credit.
  • GET /accounting/accounts/search - Find the account IDs for bankFee and charge.
  • POST /accounting/deposits and POST /accounting/deposits/{depositID}/transactions - Put the payment in a bank deposit, which a return requires.
  • GET /accounting/transactions/search - Find the payment to return (transactionTypeIDs[] 2).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80981

ID of the lease payment that was returned.

query Parameters
includes
string
Example: includes=returnTransaction,transactionLogs

Comma-separated related records to add to the response, each under its own key: deposit, contact, lease, portfolio, property, unit, propertyPortfolios, returnTransaction, bulkPayment, transactionLogs, receipts, managementFees.

Request Body schema: application/json
required
non-empty
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 NSF Fee. Ignored when it has neither key.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 deposit include; false when it isn't in one. A void takes the payment out of its deposit, so after a void this is always false.

object (included_contact)

The paying tenant's contact, with the contact include.

object (included_lease)

The payment's lease, with the lease include.

object (included_portfolio)

The portfolio the payment posted to, with the portfolio include.

object (included_property)

The lease's property, with the property include.

object (included_unit)

The lease's unit, with the unit include.

Array of objects (included_property_portfolio)

Every ownership period of the lease's property, with the propertyPortfolios include.

lease_transaction (object) or null

The payment's return transaction, with the returnTransaction include; null until the payment is returned.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the payment belongs to, with the bulkPayment include; null when none.

Array of objects

The payment's change log, with the transactionLogs include.

Array of objects (lease_receipt_row)

The payment's receipts that aren't voided, with the receipts include. A void voids every receipt and a return voids the charge receipts, so after either only refund receipts can remain.

Array of objects (included_management_fee)

The management fees taken on the payment that aren't voided, with the managementFees include. Voiding a receipt voids its fees, so after a void or a return this is empty in every case the contract tests and the live call produced.

Request samples

Content type
application/json
{
  • "return": {
    },
  • "charge": {
    }
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "returnTransaction": {
    }
}

Void Lease Refunded Return

Voids a posted lease refunded return. This is not a delete: the refunded return keeps its row and its history, is flagged voided (isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided refunded return can't be changed or voided again.

Use Cases

  • Reversing a refunded return posted in error, while keeping it in the lease's history.

Business Rules

  • Requires the Void Lease Transactions permission (Accounting › VoidLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • A transaction ID that doesn't exist answers 400 {"error": "Refunded Return 999999999 not found"}, and one that isn't a lease refunded return answers 400 {"error": "Refunded Return 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • A refunded return that is already voided answers 400 {"isVoided": ["Cannot modify a voided transaction"]}.

Side Effects

  • Every ledger entry of the refunded return is voided (so the tenant credit it gave is gone), and a void entry is added to its transaction log.
  • POST /accounting/leases/{leaseID}/refunded-returns - Record a refunded return.
  • GET /accounting/transactions/search - Find the refunded return to void (transactionTypeIDs[] 25).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease refunded return to void.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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:

  • 1 - Lease Charge
  • 2 - Tenant Receipt
  • 3 - Lease Credit
  • 4 - Lease Payment Return
  • 5 - Owner Receipt
  • 6 - Owner Contribution Return
  • 7 - Bill Charge
  • 8 - Bill Payout Charge
  • 9 - Bank Fee
  • 10 - Bank Transfer
  • 11 - Journal Entry
  • 12 - Other Receipt
  • 13 - Other Payment Return
  • 14 - Management Fee
  • 15 - Ledger Transfer
  • 16 - Ledger Payout
  • 17 - Ledger Payout Return
  • 18 - Bill Payout Charge Return
  • 19 - Lease Deposit Release Credit
  • 20 - Lease Payout
  • 21 - Lease Payout Return
  • 22 - Bill Credit
  • 23 - Bill Credit Applied
  • 24 - Bill Credit Return
  • 25 - Lease Refunded Return
managementFeeMode
required
string (management_fee_modes)
Enum: "1" "2"

Management fee mode the account used when the transaction posted:

  • 1 - Ledger
  • 2 - Bill
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:

  • 1 - Any
  • 2 - None
  • 3 - Account
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 0 in memory. Null for types that don't track it.

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 0. Null for types that don't track it.

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:

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
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 1: the void sets it in memory, so this response sends a number where a read sends the string '1'.

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 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isProrated
required
string or integer
Enum: 0 "1"

Whether this is a prorated charge. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isMoveOutTransaction
required
string or integer
Enum: 0 "1"

Whether this is a move-out transaction. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

moveOutAmount
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

When the transaction was last changed. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "transactionID": "280",
  • "transactionTypeID": "25",
  • "managementFeeMode": "2",
  • "primaryLedgerID": "503",
  • "portfolioID": "259",
  • "propertyID": "244",
  • "unitID": "244",
  • "leaseID": "244",
  • "billID": null,
  • "contactID": null,
  • "bankAccountID": null,
  • "chargeAccountID": null,
  • "equityAccountID": "255",
  • "destinationBankAccountID": null,
  • "managementFeeIncomeAccountID": null,
  • "prepaymentAccountFilterTypeID": null,
  • "prepaymentAccountID": null,
  • "unallocatedAccountID": "3",
  • "payoutID": null,
  • "payoutReturnID": null,
  • "amount": "120.00",
  • "amountPaid": null,
  • "amountAllocated": null,
  • "processingFee": null,
  • "convenienceFee": null,
  • "convenienceFeeTransactionID": null,
  • "description": "Refunded payment returned",
  • "reference": null,
  • "receivedFrom": null,
  • "returnTransactionID": null,
  • "returnTypeID": null,
  • "returnDescription": null,
  • "bulkPaymentID": null,
  • "paymentTypeID": null,
  • "billChargeTransactionID": null,
  • "billCreditTransactionID": null,
  • "discountAmount": null,
  • "markupAmount": null,
  • "managementFeeAmountPaid": null,
  • "isAdditionalManagementFee": null,
  • "managementFeePercent": null,
  • "isSuppressed": "0",
  • "managementFeeExpenseAccountID": null,
  • "managementFeePeriodDate": null,
  • "managementFeeSalesTaxSettingID": null,
  • "managementFeeSalesTaxAmountPaid": null,
  • "managementFeeSalesTaxPercent": null,
  • "managementFeeSalesTaxIncomeAccountID": null,
  • "managementFeeSalesTaxExpenseAccountID": null,
  • "managementFeeBatchID": null,
  • "isSalesTaxCharge": null,
  • "salesTaxSettingID": null,
  • "salesTaxInitiatedFromTransactionID": null,
  • "isVoided": 1,
  • "bankAccountGatewayID": null,
  • "bankAccountGatewayTransactionID": null,
  • "settlementID": null,
  • "paymentAccountName": null,
  • "paymentAccountNumberTruncated": null,
  • "depositID": null,
  • "reconciliationID": null,
  • "previousReconciliationID": null,
  • "achStatusID": null,
  • "bankTransferID": null,
  • "lateFeePeriod": null,
  • "isFromManager": null,
  • "isMoveInCharge": 0,
  • "isProrated": 0,
  • "isMoveOutTransaction": 0,
  • "moveOutAmount": null,
  • "discountMarkupBillChargeTransactionID": null,
  • "recurringObjectID": null,
  • "residentServiceID": null,
  • "residentPackageID": null,
  • "withholdingTaxAgencyID": null,
  • "withholdingTaxContactID": null,
  • "datePosted": "2026-11-09",
  • "dateTimeCreated": "2026-11-09 04:54:19",
  • "dateTimeModified": "2026-11-09 04:54:19"
}

Void Lease Deposit Release Credit

Voids a posted lease deposit-release credit. This is not a delete: the deposit-release credit keeps its row and its history, is flagged voided (isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's balance. A voided deposit-release credit can't be changed or voided again.

Use Cases

  • Reversing a deposit-release credit posted in error, while keeping it in the lease's history.

Business Rules

  • Requires the Void Lease Transactions permission (Accounting › VoidLeaseTransactions); without it the API answers 403 {"error": "Permission Denied"}.
  • The lease must be in one of the API user's portfolio groups when the user is restricted; otherwise 403 {"error": "Access Denied"}.
  • A transaction ID that doesn't exist answers 400 {"error": "Deposit Release Credit 999999999 not found"}, and one that isn't a lease deposit-release credit answers 400 {"error": "Deposit Release Credit 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • A deposit-release credit that is already voided answers 400 {"isVoided": ["Cannot modify a voided transaction"]}.
  • A deposit-release credit partly refunded to the tenant by a payout that is still active, even an unapproved one, can't be voided: 400 {"receipt.isVoided": [...], "depositReleaseCredit.receipt.isVoided": [...]}, both Cannot void a payout receipt that is associated with an active payout. Void the payout first with DELETE /accounting/payouts/{payoutID} (undocumented).

Side Effects

  • The credit's receipts are voided, so any charge it paid is open again.
  • Its ledger entries are voided, so the released deposit counts as held again and can be released anew; its deposit-release rows stay (the depositReleases include still lists them). A void entry is added to its transaction log.

From the code, not covered by a contract test:

  • The lease's last-activity date is updated.
  • POST /accounting/leases/{leaseID}/deposit-release-credits - Release a collected deposit.
  • GET /accounting/transactions/search - Find the deposit-release credit to void (transactionTypeIDs[] 19).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease deposit-release credit to void.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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:

  • 1 - Lease Charge
  • 2 - Tenant Receipt
  • 3 - Lease Credit
  • 4 - Lease Payment Return
  • 5 - Owner Receipt
  • 6 - Owner Contribution Return
  • 7 - Bill Charge
  • 8 - Bill Payout Charge
  • 9 - Bank Fee
  • 10 - Bank Transfer
  • 11 - Journal Entry
  • 12 - Other Receipt
  • 13 - Other Payment Return
  • 14 - Management Fee
  • 15 - Ledger Transfer
  • 16 - Ledger Payout
  • 17 - Ledger Payout Return
  • 18 - Bill Payout Charge Return
  • 19 - Lease Deposit Release Credit
  • 20 - Lease Payout
  • 21 - Lease Payout Return
  • 22 - Bill Credit
  • 23 - Bill Credit Applied
  • 24 - Bill Credit Return
  • 25 - Lease Refunded Return
managementFeeMode
required
string (management_fee_modes)
Enum: "1" "2"

Management fee mode the account used when the transaction posted:

  • 1 - Ledger
  • 2 - Bill
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:

  • 1 - Any
  • 2 - None
  • 3 - Account
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 0 in memory. Null for types that don't track it.

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 0. Null for types that don't track it.

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:

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
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 1: the void sets it in memory, so this response sends a number where a read sends the string '1'.

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 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isProrated
required
string or integer
Enum: 0 "1"

Whether this is a prorated charge. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

isMoveOutTransaction
required
string or integer
Enum: 0 "1"

Whether this is a move-out transaction. The save sets an empty value to the number 0 in memory, so this response sends 0 (a number) for no and the stored string '1' for yes.

moveOutAmount
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

When the transaction was last changed. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "transactionID": "361",
  • "transactionTypeID": "19",
  • "managementFeeMode": "2",
  • "primaryLedgerID": "615",
  • "portfolioID": "317",
  • "propertyID": "298",
  • "unitID": "298",
  • "leaseID": "298",
  • "billID": null,
  • "contactID": null,
  • "bankAccountID": null,
  • "chargeAccountID": "56",
  • "equityAccountID": null,
  • "destinationBankAccountID": null,
  • "managementFeeIncomeAccountID": null,
  • "prepaymentAccountFilterTypeID": null,
  • "prepaymentAccountID": null,
  • "unallocatedAccountID": "56",
  • "payoutID": null,
  • "payoutReturnID": null,
  • "amount": "1000.00",
  • "amountPaid": null,
  • "amountAllocated": 0,
  • "processingFee": null,
  • "convenienceFee": null,
  • "convenienceFeeTransactionID": null,
  • "description": "Security deposit release",
  • "reference": null,
  • "receivedFrom": null,
  • "returnTransactionID": null,
  • "returnTypeID": null,
  • "returnDescription": null,
  • "bulkPaymentID": null,
  • "paymentTypeID": null,
  • "billChargeTransactionID": null,
  • "billCreditTransactionID": null,
  • "discountAmount": null,
  • "markupAmount": null,
  • "managementFeeAmountPaid": null,
  • "isAdditionalManagementFee": null,
  • "managementFeePercent": null,
  • "isSuppressed": "0",
  • "managementFeeExpenseAccountID": null,
  • "managementFeePeriodDate": null,
  • "managementFeeSalesTaxSettingID": null,
  • "managementFeeSalesTaxAmountPaid": null,
  • "managementFeeSalesTaxPercent": null,
  • "managementFeeSalesTaxIncomeAccountID": null,
  • "managementFeeSalesTaxExpenseAccountID": null,
  • "managementFeeBatchID": null,
  • "isSalesTaxCharge": null,
  • "salesTaxSettingID": null,
  • "salesTaxInitiatedFromTransactionID": null,
  • "isVoided": 1,
  • "bankAccountGatewayID": null,
  • "bankAccountGatewayTransactionID": null,
  • "settlementID": null,
  • "paymentAccountName": null,
  • "paymentAccountNumberTruncated": null,
  • "depositID": null,
  • "reconciliationID": null,
  • "previousReconciliationID": null,
  • "achStatusID": null,
  • "bankTransferID": null,
  • "lateFeePeriod": null,
  • "isFromManager": null,
  • "isMoveInCharge": 0,
  • "isProrated": 0,
  • "isMoveOutTransaction": 0,
  • "moveOutAmount": null,
  • "discountMarkupBillChargeTransactionID": null,
  • "recurringObjectID": null,
  • "residentServiceID": null,
  • "residentPackageID": null,
  • "withholdingTaxAgencyID": null,
  • "withholdingTaxContactID": null,
  • "datePosted": "2026-11-09",
  • "dateTimeCreated": "2026-11-09 04:56:23",
  • "dateTimeModified": "2026-11-09 04:56:24"
}

Search Ledger Transfers

Paginated search for ledger transfer transactions. Returns transactions of type LedgerTransfer only, each enriched with the primary ledger, property, portfolio, unit, and the names of all debited/credited ledgers from the transaction entries.

Use Cases

  • List all ledger transfers posted between two dates for a reconciliation report.
  • Filter by one or more propertyIDs to see transfers affecting specific properties.
  • Filter by transactionEntriesLedgerIDs to find transfers that touched a given ledger.
  • Retrieve voided transfers separately using isVoided=1.

Business Rules

  • Only transactions of type LedgerTransfer (transactionTypeID 15) are returned; the type filter is applied server-side and cannot be overridden by the caller.
  • Portfolio/property access restrictions are applied automatically.
  • amountMin and amountMax filter on the absolute transaction amount as a decimal.
  • GET /accounting/recurring-ledger-transfers/search — Search recurring ledger transfer schedules.
  • GET /accounting/transactions/search — Broad transaction search across all types.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

propertyIDs[]
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (transaction)
required
object
required
object
required
object
required
object
required
object

Response samples

Content type
application/json
[
  • {
    }
]

Create Journal Entry

Posts a journal entry: a transaction of type 11 (Journal Entry) on one ledger, made of at least two lines that debit and credit chart-of-accounts accounts by equal totals. Answers with the new transaction as GET /accounting/transactions/{transactionID} reads it.

Use Cases

  • Reclassify an amount from one account to another on a property's books.
  • Record an adjustment the other transaction types don't cover, on a portfolio, property, unit or the manager ledger.

Business Rules

  • Requires the Modify Journal Entries permission (Accounting › ModifyJournalEntries); without it, 403 {"error": "Permission Denied"}.
  • A key restricted to some portfolios can post only on a ledger it can access (a manager ledger needs an unrestricted key); any other ledger answers 403 {"error": "Access Denied"}.
  • The checks run in stages, each answering 400 on its own, so fixing one stage's errors can show the next stage's: the empty-body check; ledgerID present ({"ledgerID": "Ledger is Required"}) and naming a ledger (Ledger is Invalid); the ledger restriction above; the lines as a set (at least two, Journal Entry must have at least 2 entries.; a debit or a credit on each line, not both; debits equal to credits, Entries debits must equal credits.), every failure listed; the entry (description and datePosted required, a total above zero, Amount must be greater than 0.00), every failure listed; then each line in turn, stopping at the first that fails.
  • A line with a debit above zero is written as a debit, any other line as a credit. A line's own errors are keyed debitEntry.<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.
  • A debit or credit that isn't a number fails while the lines are read, after the ledger checks, and answers 500 with an empty body.
  • A property or unit ledger posts on its portfolio's ledger: the transaction's primaryLedgerID is the portfolio's ledger, with propertyID (and unitID) set.
  • When the account bills its management fees and hides the manager ledger, the manager ledger is refused (Cannot create a journal entry on the manager ledger when in billed management fee mode).
  • The transaction takes the account's management fee mode (managementFeeMode).
  • Send includes to get related records in the response, as GET /accounting/transactions/{transactionID} takes them.

Side Effects

  • Writes the transaction, a "create" transaction log (transactionLogs include) and one cash-and-accrual entry per line (entries, cashEntries and accrualEntries includes).
  • When the account bills its management fees, a line on an account whose fees are suppressed for the property is written with isSuppressed 1.
  • 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.
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=ledger,property,entries

Comma-separated list of related records to add to the response, each under its own key: ledger, portfolio, property, unit, lease, account, contact, reconciliation, previousReconciliation, returnedTransaction, bulkPayment, transactionLogs, entries, cashEntries, accrualEntries, cashEntryArchives, accrualEntryArchives. Unknown names are ignored.

Request Body schema: application/json
required
non-empty
ledgerID
required
string or integer^-?[0-9]+$

The ledger to post on, from GET /accounting/ledgers/search. A property or unit ledger posts on its portfolio's ledger with the property (and unit) recorded on the entry; a manager ledger has no portfolio.

datePosted
required
string

The date the entry posts on, YYYY-MM-DD (MM/DD/YYYY is read too).

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 amount.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 ledger include.

included_portfolio (object) or false (any)

The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is false, not null. Requires the portfolio include.

included_property (object) or null

The transaction's property, or null when it has none. Requires the property include.

included_unit (object) or null

The transaction's unit, or null when it has none. Requires the unit include.

included_lease (object) or null

The transaction's lease, or null when it has none. Requires the lease include.

account
null

Always null: transactions have no accountID, so this include never finds an account. Requires the account include.

included_contact (object) or null

The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the contact include.

included_reconciliation (object) or null

The reconciliation that reconciled the transaction, or null. Requires the reconciliation include.

included_reconciliation (object) or null

The reconciliation the transaction was reconciled in before, or null. Requires the previousReconciliation include.

transaction_record (object) or null

The transaction this one returned: the transaction whose returnTransactionID is this transaction's ID (on a payment return, the payment it returned), or null when there is none. Requires the returnedTransaction include.

included_bulk_payment (object) or null

The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the bulkPayment include.

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 transactionLogs include.

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 entries include.

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 cashEntries include.

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 accrualEntries include.

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 cashEntryArchives include.

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 accrualEntryArchives include.

Request samples

Content type
application/json
{
  • "ledgerID": "109",
  • "datePosted": "2026-10-31",
  • "description": "Reclassify October landscaping invoice to repairs",
  • "entries": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "transaction": {
    }
}

Search Journal Entries

Paginated search for journal entry transactions. Returns transactions of type JournalEntry only, each enriched with the primary ledger, property, portfolio, unit, and the names of all debited/credited ledgers from the transaction entries.

Use Cases

  • List all journal entries posted within a date range for an audit or reconciliation.
  • Filter by propertyIDs to find journal entries affecting a specific property.
  • Filter by transactionEntriesLedgerIDs to find entries that touched a given ledger.
  • Retrieve voided journal entries using isVoided=1.

Business Rules

  • Only transactions of type JournalEntry (transactionTypeID 11) are returned; the type filter is applied server-side and cannot be overridden by the caller.
  • Portfolio/property access restrictions are applied automatically.
  • amountMin and amountMax filter on the absolute transaction amount as a decimal.
  • GET /accounting/recurring-journal-entries/search — Search recurring journal entry schedules.
  • GET /accounting/transactions/search — Broad transaction search across all types.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

propertyIDs[]
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (transaction)
required
object
required
object
required
object
required
object
required
object

Response samples

Content type
application/json
[
  • {
    }
]

Void Journal Entry

Voids a journal entry: the transaction and its lines are marked voided and stay on record, with a "void" log. It answers with the voided transaction itself, not wrapped in transaction.

Use Cases

  • Reverse a journal entry posted in error while keeping its history.

Business Rules

  • Requires the Void Journal Entries permission (Accounting › VoidJournalEntries); without it, 403 {"error": "Permission Denied"}. Modify Journal Entries alone isn't enough.
  • An ID with no journal entry, including another type of transaction's ID, answers 400 {"error": "Journal Entry <id> not found"}.
  • A key restricted to some portfolios gets 403 {"error": "Access Denied"} for an entry outside them.
  • An entry already voided is refused ({"isVoided": ["Cannot modify a voided transaction"]}), and so is one with a reconciled line ({"reconciliationID": ["Cannot modify a journal entry that has been reconciled"]}).

Side Effects

  • The transaction's isVoided becomes 1, and so does each of its lines that isn't voided yet (the cashEntries and accrualEntries includes show them; the entries include, which lists only lines that aren't voided, comes back empty).
  • A "void" transaction log is written (transactionLogs include).
  • Nothing is deleted.
  • GET /accounting/transactions/{transactionID} - Read the voided entry and its lines.
  • POST /accounting/journal-entries - Post a corrected entry.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

The journal entry's transaction ID, from GET /accounting/journal-entries/search.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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"
  • 1 - Lease Charge
  • 2 - Tenant Receipt
  • 3 - Lease Credit
  • 4 - Lease Payment Return
  • 5 - Owner Receipt
  • 6 - Owner Contribution Return
  • 7 - Bill Charge
  • 8 - Bill Payout Charge
  • 9 - Bank Fee
  • 10 - Bank Transfer
  • 11 - Journal Entry
  • 12 - Other Receipt
  • 13 - Other Payment Return
  • 14 - Management Fee
  • 15 - Ledger Transfer
  • 16 - Ledger Payout
  • 17 - Ledger Payout Return
  • 18 - Bill Payout Charge Return
  • 19 - Lease Deposit Release Credit
  • 20 - Lease Payout
  • 21 - Lease Payout Return
  • 22 - Bill Credit
  • 23 - Bill Credit Applied
  • 24 - Bill Credit Return
  • 25 - Lease Refunded Return
managementFeeMode
required
string (management_fee_modes)
Enum: "1" "2"

Management fee calculation mode applied to this transaction.

  • 1 - Ledger
  • 2 - Bill
primaryLedgerID
required
string or null^-?[0-9]+$

The ledger the transaction posts on (accounting_ledgers: a manager or portfolio ledger), not a bank account; null on types that have none, such as a ledger transfer.

portfolioID
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.

  • 1 - Any
  • 2 - None
  • 3 - Account
prepaymentAccountID
required
string or null^-?[0-9]+$

Prepayment/unapplied account ID. Use -1 to apply to the default prepayment account.

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 returnedTransaction include follows the link the other way.

required
return_types (string) or null

Return type code when this is a returned payment.

  • 1 - Insufficient Funds
  • 2 - Bad Account
  • 3 - Returned
  • 4 - Other
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.

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
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 (1 = yes, 0 = no).

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 (1 = yes, 0 = no).

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 (1 = yes, 0 = no).

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 1, as a JSON number.

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.

  • 1 - Created
  • 2 - Batched
  • 3 - Settled
  • 4 - Returned
  • 5 - Failed
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 (1 = yes, 0 = no).

isMoveInCharge
required
integer
Value: 0

Always 0 on a journal entry, as a JSON number.

isProrated
required
integer
Value: 0

Always 0 on a journal entry, as a JSON number.

isMoveOutTransaction
required
integer
Value: 0

Always 0 on a journal entry, as a JSON number.

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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Timestamp when the transaction record was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "transactionID": "11",
  • "transactionTypeID": "11",
  • "managementFeeMode": "2",
  • "primaryLedgerID": "62",
  • "portfolioID": "21",
  • "propertyID": "21",
  • "unitID": null,
  • "leaseID": null,
  • "billID": null,
  • "contactID": null,
  • "bankAccountID": null,
  • "chargeAccountID": null,
  • "equityAccountID": null,
  • "destinationBankAccountID": null,
  • "managementFeeIncomeAccountID": null,
  • "prepaymentAccountFilterTypeID": null,
  • "prepaymentAccountID": null,
  • "unallocatedAccountID": null,
  • "payoutID": null,
  • "payoutReturnID": null,
  • "amount": "125.00",
  • "amountPaid": null,
  • "amountAllocated": null,
  • "processingFee": null,
  • "convenienceFee": null,
  • "convenienceFeeTransactionID": null,
  • "description": "Reclassify October landscaping invoice to repairs",
  • "reference": null,
  • "receivedFrom": null,
  • "returnTransactionID": null,
  • "returnTypeID": null,
  • "returnDescription": null,
  • "bulkPaymentID": null,
  • "paymentTypeID": null,
  • "billChargeTransactionID": null,
  • "billCreditTransactionID": null,
  • "discountAmount": null,
  • "markupAmount": null,
  • "managementFeeAmountPaid": null,
  • "isAdditionalManagementFee": null,
  • "managementFeePercent": null,
  • "isSuppressed": "0",
  • "managementFeeExpenseAccountID": null,
  • "managementFeePeriodDate": null,
  • "managementFeeSalesTaxSettingID": null,
  • "managementFeeSalesTaxAmountPaid": null,
  • "managementFeeSalesTaxPercent": null,
  • "managementFeeSalesTaxIncomeAccountID": null,
  • "managementFeeSalesTaxExpenseAccountID": null,
  • "managementFeeBatchID": null,
  • "isSalesTaxCharge": null,
  • "salesTaxSettingID": null,
  • "salesTaxInitiatedFromTransactionID": null,
  • "isVoided": 1,
  • "bankAccountGatewayID": null,
  • "bankAccountGatewayTransactionID": null,
  • "settlementID": null,
  • "paymentAccountName": null,
  • "paymentAccountNumberTruncated": null,
  • "depositID": null,
  • "reconciliationID": null,
  • "previousReconciliationID": null,
  • "achStatusID": null,
  • "bankTransferID": null,
  • "lateFeePeriod": null,
  • "isFromManager": null,
  • "isMoveInCharge": 0,
  • "isProrated": 0,
  • "isMoveOutTransaction": 0,
  • "moveOutAmount": null,
  • "discountMarkupBillChargeTransactionID": null,
  • "recurringObjectID": null,
  • "residentServiceID": null,
  • "residentPackageID": null,
  • "withholdingTaxAgencyID": null,
  • "withholdingTaxContactID": null,
  • "datePosted": "2026-10-31",
  • "dateTimeCreated": "2026-11-12 23:25:52",
  • "dateTimeModified": "2026-11-12 23:25:53"
}

Search Recurring Ledger Transfers

Paginated search for recurring ledger transfer schedules. Each result represents a scheduled transfer that posts ledger-to-ledger transactions on a recurring basis (daily, weekly, monthly, etc.). The ledgerNames field contains a comma-separated list of the involved ledger names.

Use Cases

  • List all active recurring ledger transfers to display in a scheduled payments UI.
  • Filter by bankAccountIDs to find transfers associated with a specific bank account.
  • Filter by nextRunDateMin/nextRunDateMax to see transfers running in the next N days.
  • Filter by ledgerIDs to find transfers that involve a specific ledger.

Business Rules

  • Portfolio/access restrictions are applied automatically.
  • amountMin and amountMax filter on the transfer amount as a decimal.
  • endDate is nullable; a null value means the schedule runs indefinitely.
  • GET /accounting/ledger-transfers/search — Search posted ledger transfer transactions.
Authorizations:
basicAuth
query Parameters
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Search Recurring Journal Entries

Paginated search for recurring journal entry schedules. Each result contains the recurring journal entry record alongside the full ledger object it is associated with.

Use Cases

  • List all recurring journal entries to display in a scheduled accounting UI.
  • Filter by ledgerIDs to find recurring entries associated with a specific ledger.
  • Filter by nextRunDateMin/nextRunDateMax to see entries posting in the next N days.
  • Filter by endDateMin/endDateMax to find schedules expiring in a given window.

Business Rules

  • Portfolio/access restrictions are applied automatically.
  • amountMin and amountMax filter on the entry amount as a decimal.
  • endDate is nullable; a null value means the schedule runs indefinitely.
  • GET /accounting/journal-entries/search — Search posted journal entry transactions.
Authorizations:
basicAuth
query Parameters
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Transaction Entries

Search Transaction Entries

Returns a paginated, searchable list of individual transaction entries (debit/credit lines) with associated transaction, ledger, property, portfolio, and unit context. Transaction entries represent the individual accounting lines within a double-entry transaction.

Use Cases

  • Search entries by ledger to build a ledger statement or account register.
  • Filter by isCash or isAccrual for cash vs. accrual basis reporting.
  • Filter by isSuppressed to show or exclude management-fee suppressed entries.
  • Pull entries modified after a given timestamp for sync or reconciliation workflows.

Business Rules

  • Results are restricted to the authenticated user's portfolio.
  • Both propertyIDs (comma-separated) and propertyID (single integer) are accepted; propertyIDs takes precedence.
  • Similarly, ledgerIDs takes precedence over ledgerID.
  • The ledger, primaryLedger, property, portfolio, and unit fields are joined from related tables and may be null if the entry has no associated property or unit.
  • Each entry references both its own ledger (the account being debited/credited) and the primaryLedger (the bank account of the parent transaction).
  • GET /accounting/transactions/search - Search parent transactions.
Authorizations:
basicAuth
query Parameters
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
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: 2024-01-01T10:00:00-05:00 and 2024-01-01T10:00:00Z both mean 10:00 UTC, so convert the time to UTC first. A date alone means its midnight, so it leaves out the rest of that day. Encode a + offset as %2B: an unencoded + reads as a space, and the time is dropped. A value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

transactionTypeIDs[]
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (transaction_entry)
required
object (transaction)
object or null
object or null
object or null
object or null
object or null

Response samples

Content type
application/json
[
  • {
    }
]

Diagnostics

Unused Vendor Credits

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
contactName
string
amount
string <decimal>
amountAllocated
string or null <decimal>
description
string or null
isSuppressed
string
Enum: "0" "1"
datePosted
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

Suppressed Fee Balance Mismatch

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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

Response samples

Content type
application/json
[
  • {
    }
]

Negative Bank Accounts

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
ledgerID
string^-?[0-9]+$
ledgerName
string
ledgerTypeID
string (ledger_types)
Enum: "1" "2" "3" "4"
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
accountID
string^-?[0-9]+$
accountName
string
accountNumber
string
balance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Reserve Not Met By Ledger

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
ledgerID
string^-?[0-9]+$
ledgerName
string
ledgerTypeID
string (ledger_types)
Enum: "1" "2" "3" "4"
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
operatingBalance
number <double>
reserveAmount
string <decimal>

Response samples

Content type
application/json
[
  • {
    }
]

Escrow Mismatch By Ledger

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
ledgerID
string^-?[0-9]+$
ledgerName
string
ledgerTypeID
string (ledger_types)
Enum: "1" "2" "3" "4"
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
depositBalance
number <double>
escrowBalance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Prepayment Mismatch By Ledger

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
ledgerID
string^-?[0-9]+$
ledgerName
string
ledgerTypeID
string (ledger_types)
Enum: "1" "2" "3" "4"
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
ledgerObjectID
integer
operatingBalance
number <double>
prepaymentBalance
number <double>

Response samples

Content type
application/json
[
  • {
    }
]

Unused Prepayments

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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>

Response samples

Content type
application/json
[
  • {
    }
]

Bank Account Reconcialiation Lapse

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
accountID
string^-?[0-9]+$
name
string
number
string
lastReconciliationDate
string <date>

Response samples

Content type
application/json
[
  • {
    }
]

Vendor Insurance Lapse

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
contactID
string^-?[0-9]+$
name
string
contactTypeID
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
liabilityInsuranceExpiresDate
string or null <date>
workersCompInsuranceExpiresDate
string or null <date>

Response samples

Content type
application/json
[
  • {
    }
]

Credit Debit Mismatch

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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>

Response samples

Content type
application/json
[
  • {
    }
]

Manager Ledger Balances

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
ledgerID
string^-?[0-9]+$
ledgerName
string
ledgerTypeID
string (ledger_types)
Enum: "1" "2" "3" "4"
  • 1 - Manager
  • 2 - Portfolio
  • 3 - Property
  • 4 - Unit
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>

Response samples

Content type
application/json
[
  • {
    }
]

Owners

List Owners

Returns a page of owners, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /owners/search for more filters and computed columns.

Use Cases

  • Page through every active (or inactive) owner on the account
  • Look up owners by name or code

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets only the owners who hold a share of a portfolio in those groups, plus owners who hold no portfolio at all (a filtered 200, never a 403).
  • isActive defaults to 1: only active owners. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.
  • search is a substring match on name and code. The text is HTML-encoded before it is matched, so text holding ', ", &, < or > (O'Brien, Smith & Sons) finds nothing here; GET /owners/search matches it as typed.
  • The page size defaults to 15 and is capped at 5000.
  • Sorted by name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /owners/search, which breaks ties on contactID.
  • GET /owners/search - filtered search with computed insurance and tax columns
  • GET /owners/{contactID} - one owner, with includes
  • POST /owners - create an owner
Authorizations:
basicAuth
query Parameters
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 name and code. HTML-encoded before matching, so text holding ', ", &, < or > finds nothing.

isActive
string
Default: "1"

1 (the default) returns active contacts, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (contact_record)

A contact: every column of the row, plus the computed contactType.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Owner

Creates a new owner contact and returns the full owner detail (same shape as GET /owners/{contactID}).

Use Cases

  • Onboard a new property owner into the system
  • Create an owner with initial payout settings, emails, phones, and addresses in a single request

Business Rules

  • Requires Contacts.UpdateOwner permission.
  • name is required.
  • payoutTypeID, achAccountTypeID, achIsCorporateAccount, holdPayments, preventConsolidatedPayments, and payeeName may only be set at creation time via this endpoint; use the ACH details endpoint to modify payout settings after creation.
  • Tax fields (taxPayerName, taxFormTypeID, taxIdentifier) require the Contacts.ManageTaxInfo permission.
  • Bank account fields (routingNumber, accountNumber) are stored encrypted; only the last 4 digits of accountNumber are returned in responses.
  • After creation the endpoint forwards to the view action — the response is the full owner detail.
  • GET /owners/{contactID} — retrieve the created owner
  • POST /owners/{contactID} — update owner fields after creation
  • POST /owners/{contactID}/ach-details (undocumented) — update payout/ACH settings
Authorizations:
basicAuth
Request Body schema: application/json
required
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
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "New User"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Search Owners

Returns a page of owners with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.

Use Cases

  • Find owners by name, code, email, phone or address (the row doesn't carry code: read it from GET /owners/{contactID})
  • Sync owners changed since a point in time with dateTimeModifiedMin
  • Review tax-identifier data quality with hasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifier

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets only the owners who hold a share of a portfolio in those groups, plus owners who hold no portfolio at all (a filtered 200, never a 403).
  • isActive filters only when sent: without it the search returns active and inactive owners.
  • search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15.
  • Sorted by orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.
  • Boolean filters read 1, true and yes as yes and 0, false and no as no; any other value is ignored.
  • List filters take each value as a separate name[]=.
  • GET /owners - the plain list, with the full contact row
  • GET /owners/{contactID} - one owner, with includes
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value that isn't a number is served at 15.

search
string

Substring match on name, code, email, phone and address. Spaces in the text match any run of characters.

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 (1) or not (0). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isActive
string

Only active (1) or inactive (0) contacts. Without it, both. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

hasTaxIdentifier
string

Only contacts with (1) or without (0) a stored tax identifier. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isTaxIdentifierValid
string

Only contacts whose stored tax identifier passed (1) or failed (0) validation; a contact with no identifier counts as 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

taxIdentifierTypeIDs[]
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 taxIdentifierTypeIDs[]=.

hasDuplicateTaxIdentifier
string

Only contacts whose tax identifier another contact also stores (1), or that no other contact shares (0, including contacts with none). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only contacts last modified on or after this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send 20240101 as 2024-01-01. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-01T10:00:00Z

Only contacts last modified on or before this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound.

isInsuranceRequiredForPayment
string

Only contacts that must (1) or needn't (0) have current insurance to be paid. The API stores null here for owners, so 1 returns none and 0 only a few older rows that store 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

orderBy
string
Default: "contact.name"
Example: orderBy=contact.name|desc

Sort columns, comma-separated, each optionally followed by |desc (or |asc, the default): contact.name|desc. Default contact.name; contactID breaks ties. Sortable: contact.contactID, contact.isActive, contact.contactTypeID, contact.vendorTypeID, contact.name, contact.email, contact.phone, contact.defaultBillChargeAccountID, contact.payeeName, contact.taxPayerName, contact.taxFormTypeID, contact.payoutTypeID, contact.achAccountNumberTruncated, contact.achAccountTypeID, contact.holdPayments, contact.liabilityInsuranceName, contact.workersCompInsurancePolicyNumber, contact.workersCompInsuranceExpiresDate, contact.discountPercent, contact.discountGraceDays, contact.isInsuranceRequiredForPayment, contact.isTaxIdentifierValid, contact.taxIdentifierTypeID, contact.taxIdentifierCountryID, contact.hasTaxIdentifier, contact.hasDuplicateTaxIdentifier, contact.propertyCount, contact.daysUntilInsuranceExpires, contact.daysUntilLiabilityInsuranceExpires, contact.daysUntilWorkersCompInsuranceExpires, and search.rank when search is sent. Any other column is dropped without an error; with none left, rows come back in contactID order. A - prefix isn't read as descending: it makes the column unknown.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used: the requested pageSize (default 25) or the number of matching items, whichever is smaller, when anything matches.

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 page below 1 is read as 1)

pagination-next-page
integer
Example: "1"

Next page number. On the last page it repeats the last page number, so stop paging once pagination-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

The contact columns the search selects, plus values computed in SQL.

object

Sent only when search is given: the row's match rank.

Response samples

Content type
application/json
[
  • {
    }
]

Get Owner

Returns one owner: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.

Use Cases

  • Show an owner's full record
  • Load the owner's emails, phones and addresses in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups (a manager user or API key that is a member of one or more portfolio groups) can read an owner only when the owner holds a share of a portfolio in those groups, or holds no portfolio at all; any other owner is refused with a 403.
  • A well-formed ID with no contact, or the ID of a contact of another type, answers 400 {"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.
  • The tax identifier itself is never returned: contact.hasTaxIdentifier says whether one is stored.
  • includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.

Available Includes (7)

  • emails - the contact's email addresses, each under email
  • phones - the contact's phone numbers, each under phone
  • addresses - the contact's addresses, each under address
  • portfolios - the portfolios the owner holds a share of, each as owner (the share) and portfolio. A user restricted to portfolio groups gets only the portfolios they may access
  • portalAccounts - the owner portal accounts linked to the contact
  • portalInvitations - the pending, unexpired invitations to the owner portal, newest first
  • taxAdjustments - the contact's 1099 tax adjustments
  • GET /owners - list owners
  • GET /owners/search - search owners
  • POST /owners/{contactID} - update the owner
Authorizations:
basicAuth
path Parameters
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.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact_detail)

The contact: every column of the row plus the computed contactType, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here.

Array of objects (contact_email_row)

The contact's email addresses, each under email. Requires the emails include.

Array of objects (contact_phone_row)

The contact's phone numbers, each under phone. Requires the phones include.

Array of objects (contact_address_row)

The contact's addresses, each under address. Requires the addresses include.

Array of objects (owner_portfolio_row)

The portfolios the owner holds a share of, each as owner (the share) and portfolio. A user restricted to portfolio groups gets only the portfolios they may access. Requires the portfolios include.

Array of objects (contact_portal_account)

The owner portal accounts linked to the contact. Requires the portalAccounts include.

Array of objects (contact_portal_invitation)

The pending, unexpired invitations to the owner portal, newest first. Requires the portalInvitations include.

Array of objects (contact_tax_adjustment)

The contact's 1099 tax adjustments. Requires the taxAdjustments include.

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ],
  • "portfolios": [
    ],
  • "portalAccounts": [
    ],
  • "portalInvitations": [
    ],
  • "taxAdjustments": [
    ]
}

Update Owner

Updates editable fields on an existing owner contact and returns the full owner detail (same shape as GET /owners/{contactID}).

Use Cases

  • Update an owner's display name, code, website, or birth date
  • Toggle bill approval exemption for an owner (requires UpdateBillApprovalExemption permission)

Business Rules

  • Requires Update Owner Details permission.
  • Returns 400 if the contact is not found or is not an owner.
  • Access is restricted to contacts within the authenticated account's scope.
  • Only the following fields are accepted: name, code, websiteUrl, birthDate, and isBillApprovalExempt (permission-gated).
  • After update the endpoint forwards to the view action — pass includes query params to include related data in the response.
  • GET /owners/{contactID} — retrieve current owner detail
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 3513

The unique owner contact ID

query Parameters
includes
string
Example: includes=portfolios

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments

Request Body schema: application/json
required
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)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
{
  • "name": "Chris Campos",
  • "isBillApprovalExempt": "0",
  • "birthDate": null,
  • "code": null
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Owner

Permanently deletes an owner contact. Returns the deleted contact as a flat object (not wrapped in a contact key).

Use Cases

  • Remove an owner who was created in error
  • Clean up test or duplicate owner records

Business Rules

  • Requires Update Owner Details permission.
  • Returns 400 if the contact is not found or is not an owner.
  • Access is restricted to contacts within the authenticated account's scope.
  • Deletion may fail if the owner has associated financial records or active portfolio memberships — the service layer will return errors in that case.
  • The response is the contact's last known state as a flat object (no contact wrapper).
  • POST /owners/{contactID}/deactivate — soft-deactivate instead of permanently deleting
  • GET /owners/{contactID} — verify owner state before deletion
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5258

The unique owner contact ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
contactID
required
string^-?[0-9]+$
contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
name
required
string
payoutTypeID
required
string (payout_types)
Enum: "1" "2" "3" "4"
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
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]+$

Response samples

Content type
application/json
{
  • "contactID": "5258",
  • "contactTypeID": "1",
  • "vendorTypeID": null,
  • "code": null,
  • "name": "New User",
  • "firstName": "New",
  • "middleName": null,
  • "lastName": "User",
  • "suffix": null,
  • "email": null,
  • "phone": null,
  • "countryID": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "stateID": null,
  • "postalCode": null,
  • "birthDate": null,
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": null,
  • "taxFormTypeID": null,
  • "identificationTypeID": null,
  • "identificationNumber": null,
  • "identificationCountryID": null,
  • "identificationIssuingLocation": null,
  • "identificationExpirationDate": null,
  • "payoutTypeID": "2",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": null,
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "isActive": "1",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "dateTimeCreated": "2026-04-24 17:49:23",
  • "dateTimeModified": "2026-04-24 17:49:23",
  • "dateTimeDeactivated": null,
  • "contactType": "Owner"
}

Activate 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}).

Use Cases

  • Re-activate an owner who was previously deactivated but has returned as an active client
  • Restore owner portal access and distribution eligibility

Business Rules

  • Requires Contacts.UpdateOwner permission.
  • Returns 400 if the contact is not found or is not an owner.
  • Access is restricted to contacts within the authenticated account's scope via verifyAccessToContact.
  • Sets isActive = 1 and clears dateTimeDeactivated on the contact record.
  • The response is the full owner detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /owners/{contactID} — retrieve owner details
  • POST /owners/{contactID}/deactivate — deactivate an active owner
  • POST /owners/{contactID} — update owner fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 3513

The unique owner contact ID to activate

query Parameters
includes
string
Example: includes=portfolios

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Deactivate Owner

Sets an owner's isActive flag to 0, marking them as inactive. Returns the updated owner detail (same shape as GET /owners/{contactID}).

Use Cases

  • Mark an owner as inactive when they no longer have an active relationship with the property management company
  • Prevent future distributions or portal access without deleting the record

Business Rules

  • Requires Contacts.UpdateOwner permission.
  • Returns 400 if the contact is not found or is not an owner.
  • Access is restricted to contacts within the authenticated account's scope via verifyAccessToContact.
  • Sets isActive = 0 and updates dateTimeModified and dateTimeDeactivated on the contact record.
  • The response is the full owner detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /owners/{contactID} — retrieve owner details
  • POST /owners/{contactID}/activate — re-activate a deactivated owner
  • POST /owners/{contactID} — update owner fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 3513

The unique owner contact ID to deactivate

query Parameters
includes
string
Example: includes=portfolios

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Tenants

List Tenants

Returns a page of tenants, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /tenants/search for more filters and computed columns.

Use Cases

  • Page through every active (or inactive) tenant on the account
  • Look up tenants by name or code

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets only the tenants on a lease at a property in those groups' portfolios, plus tenants on no lease at all (a filtered 200, never a 403).
  • isActive defaults to 1: only active tenants. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.
  • search is a substring match on name and code. The text is HTML-encoded before it is matched, so text holding ', ", &, < or > (O'Brien, Smith & Sons) finds nothing here; GET /tenants/search matches it as typed.
  • The page size defaults to 15 and is capped at 5000.
  • Sorted by name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /tenants/search, which breaks ties on contactID.
  • GET /tenants/search - filtered search with computed insurance and tax columns
  • GET /tenants/{contactID} - one tenant, with includes
  • POST /tenants - create a tenant
Authorizations:
basicAuth
query Parameters
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 name and code. HTML-encoded before matching, so text holding ', ", &, < or > finds nothing.

isActive
string
Default: "1"

1 (the default) returns active contacts, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (contact_record)

A contact: every column of the row, plus the computed contactType.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Tenant

Creates a new tenant contact and returns the full tenant detail (same shape as GET /tenants/{contactID}).

Use Cases

  • Onboard a new tenant into the system before adding them to a lease
  • Create a tenant with contact details (emails, phones, addresses) in a single request

Business Rules

  • Requires Contacts.UpdateTenant permission.
  • name is required.
  • Accepted fields are restricted to code, name, websiteUrl, birthDate, identificationTypeID, identificationNumber, identificationCountryID, identificationIssuingLocation, and identificationExpirationDate. Any other fields in the request body are silently ignored.
  • Tax fields (taxPayerName, taxFormTypeID, taxIdentifier) require the Contacts.ManageTaxInfo permission.
  • After creation the endpoint forwards to the view action — the response is the full tenant detail.
  • GET /tenants/{contactID} — retrieve the created tenant
  • POST /tenants/{contactID} — update tenant fields after creation
Authorizations:
basicAuth
Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "Aaron Boone"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Search Tenants

Returns a page of tenants with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.

Use Cases

  • Find tenants by name, code, email, phone or address (the row doesn't carry code: read it from GET /tenants/{contactID})
  • Sync tenants changed since a point in time with dateTimeModifiedMin
  • Review tax-identifier data quality with hasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifier

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets only the tenants on a lease at a property in those groups' portfolios, plus tenants on no lease at all (a filtered 200, never a 403).
  • isActive filters only when sent: without it the search returns active and inactive tenants.
  • search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15.
  • Sorted by orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.
  • Boolean filters read 1, true and yes as yes and 0, false and no as no; any other value is ignored.
  • List filters take each value as a separate name[]=.
  • GET /tenants - the plain list, with the full contact row
  • GET /tenants/{contactID} - one tenant, with includes
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value that isn't a number is served at 15.

search
string

Substring match on name, code, email, phone and address. Spaces in the text match any run of characters.

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 (1) or not (0). Every tenant stores 0, so 1 returns none. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isActive
string

Only active (1) or inactive (0) contacts. Without it, both. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

hasTaxIdentifier
string

Only contacts with (1) or without (0) a stored tax identifier. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isTaxIdentifierValid
string

Only contacts whose stored tax identifier passed (1) or failed (0) validation; a contact with no identifier counts as 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

taxIdentifierTypeIDs[]
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 taxIdentifierTypeIDs[]=.

hasDuplicateTaxIdentifier
string

Only contacts whose tax identifier another contact also stores (1), or that no other contact shares (0, including contacts with none). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only contacts last modified on or after this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send 20240101 as 2024-01-01. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-01T10:00:00Z

Only contacts last modified on or before this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound.

isInsuranceRequiredForPayment
string

Only contacts that must (1) or needn't (0) have current insurance to be paid. The API stores null here for tenants, so 1 returns none and 0 only a few older rows that store 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

orderBy
string
Default: "contact.name"
Example: orderBy=contact.name|desc

Sort columns, comma-separated, each optionally followed by |desc (or |asc, the default): contact.name|desc. Default contact.name; contactID breaks ties. Sortable: contact.contactID, contact.isActive, contact.contactTypeID, contact.vendorTypeID, contact.name, contact.email, contact.phone, contact.defaultBillChargeAccountID, contact.payeeName, contact.taxPayerName, contact.taxFormTypeID, contact.payoutTypeID, contact.achAccountNumberTruncated, contact.achAccountTypeID, contact.holdPayments, contact.liabilityInsuranceName, contact.workersCompInsurancePolicyNumber, contact.workersCompInsuranceExpiresDate, contact.discountPercent, contact.discountGraceDays, contact.isInsuranceRequiredForPayment, contact.isTaxIdentifierValid, contact.taxIdentifierTypeID, contact.taxIdentifierCountryID, contact.hasTaxIdentifier, contact.hasDuplicateTaxIdentifier, contact.propertyCount, contact.daysUntilInsuranceExpires, contact.daysUntilLiabilityInsuranceExpires, contact.daysUntilWorkersCompInsuranceExpires, and search.rank when search is sent. Any other column is dropped without an error; with none left, rows come back in contactID order. A - prefix isn't read as descending: it makes the column unknown.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used: the requested pageSize (default 25) or the number of matching items, whichever is smaller, when anything matches.

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 page below 1 is read as 1)

pagination-next-page
integer
Example: "1"

Next page number. On the last page it repeats the last page number, so stop paging once pagination-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

The contact columns the search selects, plus values computed in SQL.

object

Sent only when search is given: the row's match rank.

Response samples

Content type
application/json
[
  • {
    }
]

Get Tenant

Returns one tenant: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.

Use Cases

  • Show a tenant's full record
  • Load the tenant's emails, phones and addresses in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups (a manager user or API key that is a member of one or more portfolio groups) can read a tenant only when the tenant is on a lease at a property in those groups' portfolios, or on no lease at all; any other tenant is refused with a 403.
  • A well-formed ID with no contact, or the ID of a contact of another type, answers 400 {"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.
  • The tax identifier itself is never returned: contact.hasTaxIdentifier says whether one is stored.
  • includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.

Available Includes (6)

  • emails - the contact's email addresses, each under email
  • phones - the contact's phone numbers, each under phone
  • addresses - the contact's addresses, each under address
  • leases - the leases the tenant is on, each with leaseTenant, contact, lease, property and unit. Documented for a user with no portfolio-group restriction; a restricted user reads a tenant's leases through GET /leases/search.
  • portalAccounts - the resident portal accounts linked to the contact
  • portalInvitations - the pending, unexpired invitations to the resident portal, newest first
  • GET /tenants - list tenants
  • GET /tenants/search - search tenants
  • POST /tenants/{contactID} - update the tenant
Authorizations:
basicAuth
path Parameters
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.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, leases, portalAccounts, portalInvitations.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact_detail)

The contact: every column of the row plus the computed contactType, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here.

Array of objects (contact_email_row)

The contact's email addresses, each under email. Requires the emails include.

Array of objects (contact_phone_row)

The contact's phone numbers, each under phone. Requires the phones include.

Array of objects (contact_address_row)

The contact's addresses, each under address. Requires the addresses include.

Array of objects (tenant_lease_row)

The leases the tenant is on, each with leaseTenant, contact, lease, property and unit. Requires the leases include. Documented for a user with no portfolio-group restriction; a restricted user reads a tenant's leases through GET /leases/search.

Array of objects (contact_portal_account)

The resident portal accounts linked to the contact. Requires the portalAccounts include.

Array of objects (contact_portal_invitation)

The pending, unexpired invitations to the resident portal, newest first. Requires the portalInvitations include.

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ],
  • "leases": [
    ],
  • "portalAccounts": [
    ],
  • "portalInvitations": [
    ]
}

Update Tenant

Updates editable fields on an existing tenant contact and returns the full tenant detail (same shape as GET /tenants/{contactID}).

Use Cases

  • Update a tenant's display name, code, birth date, or government identification details
  • Correct a name spelling or code after initial creation

Business Rules

  • Requires Update Tenant Details permission.
  • Returns 400 if the contact is not found or is not a tenant.
  • Access is restricted to contacts within the authenticated account's scope.
  • Only the following fields are accepted: code, name, birthDate, identificationTypeID, identificationNumber, identificationCountryID, identificationIssuingLocation, identificationExpirationDate. All other fields in the request body are silently ignored.
  • After update the endpoint forwards to the view action — pass includes query params to include related data in the response.
  • GET /tenants/{contactID} — retrieve current tenant detail
  • POST /tenants/{contactID}/activate — activate an inactive tenant
  • POST /tenants/{contactID}/deactivate — deactivate an active tenant
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 4976

The unique tenant contact ID

query Parameters
includes
string
Example: includes=leases

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, leases, portalAccounts, portalInvitations

Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "Aaron Boone"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Tenant

Permanently deletes a tenant contact. Returns the deleted contact as a flat object (not wrapped in a contact key).

Use Cases

  • Remove a tenant who was created in error
  • Clean up test or duplicate tenant records

Business Rules

  • Requires Contacts.UpdateTenant permission.
  • Returns 400 if the contact is not found or is not a tenant.
  • Access is restricted to contacts within the authenticated account's scope.
  • Deletion may fail if the tenant has associated financial records or active lease memberships — the service layer will return errors in that case.
  • The response is the contact's last known state as a flat object (no contact wrapper).
  • POST /tenants/{contactID}/deactivate — soft-deactivate instead of permanently deleting
  • GET /tenants/{contactID} — verify tenant state before deletion
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2793

The unique tenant contact ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
contactID
required
string^-?[0-9]+$
contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
name
required
string
payoutTypeID
required
string (payout_types)
Enum: "1" "2" "3" "4"
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
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]+$

Response samples

Content type
application/json
{
  • "contactID": "2793",
  • "contactTypeID": "2",
  • "vendorTypeID": null,
  • "code": null,
  • "name": "Aaron Boone",
  • "firstName": "Aaron",
  • "middleName": null,
  • "lastName": "Boone",
  • "suffix": null,
  • "email": "tenant@example.com",
  • "phone": "+12395370474",
  • "countryID": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "stateID": null,
  • "postalCode": null,
  • "birthDate": "1981-10-22",
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": null,
  • "taxFormTypeID": null,
  • "identificationTypeID": null,
  • "identificationNumber": null,
  • "identificationCountryID": null,
  • "identificationIssuingLocation": null,
  • "identificationExpirationDate": null,
  • "payoutTypeID": "2",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": null,
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "isActive": "1",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "dateTimeCreated": "2024-10-31 17:32:50",
  • "dateTimeModified": "2025-04-25 21:06:37",
  • "dateTimeDeactivated": null,
  • "contactType": "Tenant"
}

Activate 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}).

Use Cases

  • Re-activate a tenant who was previously deactivated but has renewed a lease
  • Restore tenant portal access after reinstatement

Business Rules

  • Requires Update Tenant Details permission.
  • Returns 400 if the contact is not found or is not a tenant.
  • Sets isActive = 1
  • GET /tenants/{contactID} — retrieve tenant details
  • POST /tenants/{contactID}/deactivate — deactivate an active tenant
  • POST /tenants/{contactID} — update tenant fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2793

The unique tenant contact ID to activate

query Parameters
includes
string
Example: includes=leases

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, leases, portalAccounts, portalInvitations

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Deactivate Tenant

Sets a tenant's isActive flag to 0, marking them as inactive. Returns the updated tenant detail (same shape as GET /tenants/{contactID}).

Use Cases

  • Mark a tenant as inactive after they have vacated and closed out their lease
  • Prevent portal access without permanently deleting the contact record

Business Rules

  • Requires Update Tenant Details permission.
  • Returns 400 if the contact is not found or is not a tenant.
  • Sets isActive = 0 and updates dateTimeModified and dateTimeDeactivated on the contact record.
  • The response is the full tenant detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /tenants/{contactID} — retrieve tenant details
  • POST /tenants/{contactID}/activate — re-activate a deactivated tenant
  • POST /tenants/{contactID} — update tenant fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2793

The unique tenant contact ID to deactivate

query Parameters
includes
string
Example: includes=leases

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, leases, portalAccounts, portalInvitations

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Vendors

List Vendors

Returns a page of vendors, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /vendors/search for more filters and computed columns.

Use Cases

  • Page through every active (or inactive) vendor on the account
  • Look up vendors by name or code
  • Load a known set of contacts by ID with contactIDs[]

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every vendor.
  • isActive defaults to 1: only active vendors. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.
  • search is a substring match on name and code. The text is HTML-encoded before it is matched, so text holding ', ", &, < or > (O'Brien, Smith & Sons) finds nothing here; GET /vendors/search matches it as typed.
  • The page size defaults to 250 and is capped at 5000.
  • Sorted by name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /vendors/search, which breaks ties on contactID.
  • includeManager adds manager contacts and includeMaintenanceTechnician adds maintenance technicians to the list.
  • contactIDs[] (or vendorContactIDs[]) returns those contacts when they are vendors, maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply.
  • GET /vendors/search - filtered search with computed insurance and tax columns
  • GET /vendors/{contactID} - one vendor, with includes
  • POST /vendors - create a vendor
Authorizations:
basicAuth
query Parameters
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 name and code. HTML-encoded before matching, so text holding ', ", &, < or > finds nothing.

isActive
string
Default: "1"

1 (the default) returns active contacts, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

includeManager
string

Also list manager contacts. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

includeMaintenanceTechnician
string

Also list maintenance technicians. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTypeID
integer

Only contacts of this vendor type, from GET /contacts/vendor-types (undocumented). A value that isn't a number is ignored.

contactIDs[]
Array of integers

Only these contacts. Send each ID as a separate contactIDs[]=; a single contactIDs= value holding an ID is read as a list of one. Widens the types listed to vendors, maintenance technicians and managers. vendorContactIDs[] is read when contactIDs[] isn't sent.

vendorContactIDs[]
Array of integers

The older name of contactIDs[], read only when contactIDs[] isn't sent.

Responses

Response Headers
pagination-page-size
integer
Example: "250"

Page size used -- the requested pageSize (default 250), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (contact_record)

A contact: every column of the row, plus the computed contactType.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Vendor

Creates a new vendor contact and returns the full vendor detail (same shape as GET /vendors/{contactID}).

Use Cases

  • Onboard a new vendor into the system with name, contact info, and payout settings
  • Create a vendor with initial emails, phones, and addresses in a single request

Business Rules

  • Requires Update Vendor Details permission.
  • name is the only required field.
  • After creation the endpoint forwards to the view action — the response is the full vendor detail.
  • GET /vendors/{contactID} — retrieve the created vendor
  • POST /vendors/{contactID} — update vendor fields after creation
Authorizations:
basicAuth
Request Body schema: application/json
required
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
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "New Vendor"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Search Vendors

Returns a page of vendors with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.

Use Cases

  • Find vendors by name, code, email, phone or address (the row doesn't carry code: read it from GET /vendors/{contactID})
  • Sync vendors changed since a point in time with dateTimeModifiedMin
  • Review tax-identifier data quality with hasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifier

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every vendor.
  • isActive filters only when sent: without it the search returns active and inactive vendors.
  • search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15.
  • Sorted by orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.
  • Boolean filters read 1, true and yes as yes and 0, false and no as no; any other value is ignored.
  • List filters take each value as a separate name[]=.
  • includeManager=1 adds manager contacts and includeMaintenanceTechnician=1 adds maintenance technicians. Only 1, true or yes turns them on.
  • isLiabilityInsuranceExpired, isWorkersCompInsuranceExpired and isInsuranceExpired take only a yes value; 0, false and no aren't supported.
  • GET /vendors - the plain list, with the full contact row
  • GET /vendors/{contactID} - one vendor, with includes
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value that isn't a number is served at 15.

search
string

Substring match on name, code, email, phone and address. Spaces in the text match any run of characters.

includeManager
string

Also return manager contacts. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

includeMaintenanceTechnician
string

Also return maintenance technicians. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTypeIDs[]
Array of integers

Only contacts of these vendor types, from GET /contacts/vendor-types (undocumented). Send each value as a separate vendorTypeIDs[]=.

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 (1) or not (0). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isActive
string

Only active (1) or inactive (0) contacts. Without it, both. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

hasTaxIdentifier
string

Only contacts with (1) or without (0) a stored tax identifier. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isTaxIdentifierValid
string

Only contacts whose stored tax identifier passed (1) or failed (0) validation; a contact with no identifier counts as 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

taxIdentifierTypeIDs[]
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 taxIdentifierTypeIDs[]=.

hasDuplicateTaxIdentifier
string

Only contacts whose tax identifier another contact also stores (1), or that no other contact shares (0, including contacts with none). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only contacts last modified on or after this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send 20240101 as 2024-01-01. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-01T10:00:00Z

Only contacts last modified on or before this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound.

isInsuranceRequiredForPayment
string

Only contacts that must (1) or needn't (0) have current insurance to be paid. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTradeIDs[]
Array of integers

Only contacts assigned to at least one of these trades, from GET /maintenance/vendor-trades. Send each value as a separate vendorTradeIDs[]=.

propertyIDs[]
Array of integers

Only contacts linked as the association of at least one of these properties (POST /properties/associations (undocumented) links a contact of any type, though normally only associations are linked, so this usually returns no vendors). Send each value as a separate propertyIDs[]=.

isLiabilityInsuranceExpired
string

1 (or true, yes) returns only contacts whose liability insurance has expired. 0, false and no aren't supported. Any other value is ignored.

daysUntilLiabilityInsuranceExpiresMin
integer

Only contacts whose liability insurance expires at least this many days from today. 0 is ignored.

daysUntilLiabilityInsuranceExpiresMax
integer

Only contacts whose liability insurance expires at most this many days from today (negative for already expired). 0 is ignored.

isWorkersCompInsuranceExpired
string

1 (or true, yes) returns only contacts whose workers' comp insurance has expired. 0, false and no aren't supported. Any other value is ignored.

daysUntilWorkersCompInsuranceExpiresMin
integer

Only contacts whose workers' comp insurance expires at least this many days from today. 0 is ignored.

daysUntilWorkersCompInsuranceExpiresMax
integer

Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). 0 is ignored.

isInsuranceExpired
string

1 (or true, yes) returns only contacts whose insurance (the earlier of the two dates) has expired. 0, false and no aren't supported. Any other value is ignored.

daysUntilInsuranceExpiresMin
integer

Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. 0 is ignored.

daysUntilInsuranceExpiresMax
integer

Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). 0 is ignored.

tagIDs[]
Array of integers

Only contacts with at least one of these tags, from GET /tags (undocumented), attached to the contact as a vendor tag. Send each value as a separate tagIDs[]=.

orderBy
string
Default: "contact.name"
Example: orderBy=contact.name|desc

Sort columns, comma-separated, each optionally followed by |desc (or |asc, the default): contact.name|desc. Default contact.name; contactID breaks ties. Sortable: contact.contactID, contact.isActive, contact.contactTypeID, contact.vendorTypeID, contact.name, contact.email, contact.phone, contact.defaultBillChargeAccountID, contact.payeeName, contact.taxPayerName, contact.taxFormTypeID, contact.payoutTypeID, contact.achAccountNumberTruncated, contact.achAccountTypeID, contact.holdPayments, contact.liabilityInsuranceName, contact.workersCompInsurancePolicyNumber, contact.workersCompInsuranceExpiresDate, contact.discountPercent, contact.discountGraceDays, contact.isInsuranceRequiredForPayment, contact.isTaxIdentifierValid, contact.taxIdentifierTypeID, contact.taxIdentifierCountryID, contact.hasTaxIdentifier, contact.hasDuplicateTaxIdentifier, contact.propertyCount, contact.daysUntilInsuranceExpires, contact.daysUntilLiabilityInsuranceExpires, contact.daysUntilWorkersCompInsuranceExpires, and search.rank when search is sent. Any other column is dropped without an error; with none left, rows come back in contactID order. A - prefix isn't read as descending: it makes the column unknown.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used: the requested pageSize (default 25) or the number of matching items, whichever is smaller, when anything matches.

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 page below 1 is read as 1)

pagination-next-page
integer
Example: "1"

Next page number. On the last page it repeats the last page number, so stop paging once pagination-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

The contact columns the search selects, plus values computed in SQL.

object

Sent only when search is given: the row's match rank.

Response samples

Content type
application/json
[
  • {
    }
]

Get Vendor

Returns one vendor: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.

Use Cases

  • Show a vendor's full record
  • Load the vendor's emails, phones and addresses in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every vendor.
  • A well-formed ID with no contact, or the ID of a contact of another type, answers 400 {"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.
  • The tax identifier itself is never returned: contact.hasTaxIdentifier says whether one is stored.
  • includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.

Available Includes (10)

  • emails - the contact's email addresses, each under email
  • phones - the contact's phone numbers, each under phone
  • addresses - the contact's addresses, each under address
  • portalAccounts - the vendor portal accounts linked to the contact
  • portalInvitations - the pending, unexpired invitations to the vendor portal, newest first
  • vendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTrade
  • taxAdjustments - the contact's 1099 tax adjustments
  • contactPersons - the people on file at the contact
  • reviewStats - one row counting the contact's completed maintenance reviews by rating
  • invoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has none
  • GET /vendors - list vendors
  • GET /vendors/search - search vendors
  • POST /vendors/{contactID} - update the vendor
Authorizations:
basicAuth
path Parameters
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.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact_detail)

The contact: every column of the row plus the computed contactType, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here.

Array of objects (contact_email_row)

The contact's email addresses, each under email. Requires the emails include.

Array of objects (contact_phone_row)

The contact's phone numbers, each under phone. Requires the phones include.

Array of objects (contact_address_row)

The contact's addresses, each under address. Requires the addresses include.

Array of objects (contact_portal_account)

The vendor portal accounts linked to the contact. Requires the portalAccounts include.

Array of objects (contact_portal_invitation)

The pending, unexpired invitations to the vendor portal, newest first. Requires the portalInvitations include.

Array of objects (vendor_trade_row)

The trades assigned to the contact, each as contactVendorTrade and vendorTrade. Requires the vendorTrades include.

Array of objects (contact_tax_adjustment)

The contact's 1099 tax adjustments. Requires the taxAdjustments include.

Array of objects (contact_person)

The people on file at the contact. Requires the contactPersons include.

Array of objects (vendor_review_stats)

One row counting the contact's completed maintenance reviews by rating. Requires the reviewStats include.

contact_invoice_autofill_template (object) or null

The invoice autofill template the contact uses, or null when it has none. Requires the invoiceAutofillTemplate include.

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ],
  • "portalAccounts": [
    ],
  • "portalInvitations": [
    ],
  • "vendorTrades": [
    ],
  • "taxAdjustments": [
    ],
  • "contactPersons": [
    ],
  • "reviewStats": [
    ],
  • "invoiceAutofillTemplate": {
    }
}

Update Vendor

Updates editable fields on an existing vendor contact and returns the full vendor detail (same shape as GET /vendors/{contactID}).

Use Cases

  • Update a vendor's display name, code, website, or discount settings
  • Toggle bill approval exemption, sales tax, or QuickBooks export for a vendor
  • Update insurance information for payment eligibility

Business Rules

  • Requires Update Vendor Details permission.
  • Returns 400 if the contact is not found or is not a vendor.
  • isBillApprovalExempt requires the Update Bill Approval Exemption permission to take effect.
  • After update the endpoint forwards to the view action — pass includes query params to include related data in the response.
  • GET /vendors/{contactID} — retrieve current vendor detail
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5263

The unique vendor contact ID

query Parameters
includes
string
Example: includes=vendorTrades

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Request Body schema: application/json
required
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)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
{
  • "name": "New Vendor Name",
  • "code": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "birthDate": null,
  • "websiteUrl": null,
  • "defaultBillChargeAccountID": null,
  • "vendorTypeID": null,
  • "discountGraceDays": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "isBillingSalesTaxEnabled": "0",
  • "invoiceAutofillTemplateID": null
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Vendor

Permanently deletes a vendor contact. Returns the deleted contact as a flat object.

Use Cases

  • Remove a vendor who was created in error
  • Clean up test or duplicate vendor records

Business Rules

  • Requires Update Vendor Details permission.
  • Returns 400 if the contact is not found or is not a vendor.
  • Deletion may fail if the vendor has associated financial records (bills, invoices, payouts) — the service layer returns errors in that case.
  • POST /vendors/{contactID}/deactivate — soft-deactivate instead of permanently deleting
  • GET /vendors/{contactID} — verify vendor state before deletion
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5263

The unique vendor contact ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
contactID
required
string^-?[0-9]+$
contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
name
required
string
payoutTypeID
required
string (payout_types)
Enum: "1" "2" "3" "4"
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
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]+$

Response samples

Content type
application/json
{
  • "contactID": "5263",
  • "contactTypeID": "3",
  • "vendorTypeID": null,
  • "code": null,
  • "name": "New Vendor Name",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": null,
  • "phone": null,
  • "countryID": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "stateID": null,
  • "postalCode": null,
  • "birthDate": null,
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": "New Vendor",
  • "taxFormTypeID": "1",
  • "identificationTypeID": null,
  • "identificationNumber": null,
  • "identificationCountryID": null,
  • "identificationIssuingLocation": null,
  • "identificationExpirationDate": null,
  • "payoutTypeID": "2",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": null,
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": null,
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": null,
  • "dateTimeCreated": "2026-04-24 19:26:47",
  • "dateTimeModified": "2026-04-24 19:28:28",
  • "dateTimeDeactivated": null,
  • "contactType": "Vendor"
}

Activate 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}).

Use Cases

  • Re-activate a vendor who was previously deactivated but is returning as an active supplier
  • Restore a vendor to eligibility for bill payments and work order assignments

Business Rules

  • Requires Update Vendor Details permission.
  • Returns 400 if the contact is not found or is not a vendor.
  • Sets isActive = 1 and clears dateTimeDeactivated on the contact record.
  • The response is the full vendor detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /vendors/{contactID} — retrieve vendor details
  • POST /vendors/{contactID}/deactivate — deactivate an active vendor
  • POST /vendors/{contactID} — update vendor fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2888

The unique vendor contact ID to activate

query Parameters
includes
string
Example: includes=vendorTrades

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Deactivate Vendor

Sets a vendor's isActive flag to 0, soft-deactivating them. Returns the updated vendor detail (same shape as GET /vendors/{contactID}).

Use Cases

  • Deactivate a vendor who is no longer used to prevent new bill assignments
  • Soft-delete a vendor while preserving historical financial records

Business Rules

  • Requires Update Vendor Details permission.
  • Returns 400 if the contact is not found or is not a vendor.
  • Historical records (bills, invoices, payments) are preserved after deactivation.
  • The response is the full vendor detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /vendors/{contactID} — retrieve vendor details
  • POST /vendors/{contactID}/activate — re-activate a deactivated vendor
  • DELETE /vendors/{contactID} — permanently delete a vendor
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2888

The unique vendor contact ID to deactivate

query Parameters
includes
string
Example: includes=vendorTrades

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Associations

List Associations

Returns a page of associations, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /associations/search for more filters and computed columns.

Use Cases

  • Page through every active (or inactive) association on the account
  • Look up associations by name or code

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every association.
  • isActive defaults to 1: only active associations. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.
  • search is a substring match on name and code. The text is HTML-encoded before it is matched, so text holding ', ", &, < or > (O'Brien, Smith & Sons) finds nothing here; GET /associations/search matches it as typed.
  • The page size defaults to 15 and is capped at 5000.
  • Sorted by name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /associations/search, which breaks ties on contactID.
  • includeManager adds manager contacts to the list.
  • associationContactIDs[] limits the list to those contacts (associations, or managers with includeManager); the other filters, the isActive default included, still apply.
  • GET /associations/search - filtered search with computed insurance and tax columns
  • GET /associations/{contactID} - one association, with includes
  • POST /associations - create an association
Authorizations:
basicAuth
query Parameters
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 name and code. HTML-encoded before matching, so text holding ', ", &, < or > finds nothing.

isActive
string
Default: "1"

1 (the default) returns active contacts, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

includeManager
string

Also list manager contacts. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

associationContactIDs[]
Array of integers

Only these contacts. Send each ID as a separate associationContactIDs[]=.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (contact_record)

A contact: every column of the row, plus the computed contactType.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Association

Creates a new association contact and returns the full association detail (same shape as GET /associations/{contactID}).

Use Cases

  • Onboard a new homeowner association (HOA) or condo association into the system
  • Create an association with initial contact info (emails, phones, addresses) in a single request
  • Set up an association with ACH payout details for dues collection

Business Rules

  • Requires Update Association Details permission.
  • name is the only required field.
  • Tax info fields (taxPayerName, taxIdentifier, taxFormTypeID) require the ManageTaxInfo permission.
  • ACH bank details (routingNumber, accountNumber) are stored encrypted; only the last 4 digits of the account number are returned.
  • GET /associations/{contactID} — retrieve a created association
  • POST /associations/{contactID} — update association fields after creation
Authorizations:
basicAuth
Request Body schema: application/json
required
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
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "New Association"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Search Associations

Returns a page of associations with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.

Use Cases

  • Find associations by name, code, email, phone or address (the row doesn't carry code: read it from GET /associations/{contactID})
  • Sync associations changed since a point in time with dateTimeModifiedMin
  • Review tax-identifier data quality with hasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifier

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every association.
  • isActive filters only when sent: without it the search returns active and inactive associations.
  • search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15.
  • Sorted by orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.
  • Boolean filters read 1, true and yes as yes and 0, false and no as no; any other value is ignored.
  • List filters take each value as a separate name[]=.
  • GET /associations - the plain list, with the full contact row
  • GET /associations/{contactID} - one association, with includes
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value that isn't a number is served at 15.

search
string

Substring match on name, code, email, phone and address. Spaces in the text match any run of characters.

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 (1) or not (0). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isActive
string

Only active (1) or inactive (0) contacts. Without it, both. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

hasTaxIdentifier
string

Only contacts with (1) or without (0) a stored tax identifier. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isTaxIdentifierValid
string

Only contacts whose stored tax identifier passed (1) or failed (0) validation; a contact with no identifier counts as 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

taxIdentifierTypeIDs[]
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 taxIdentifierTypeIDs[]=.

hasDuplicateTaxIdentifier
string

Only contacts whose tax identifier another contact also stores (1), or that no other contact shares (0, including contacts with none). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only contacts last modified on or after this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send 20240101 as 2024-01-01. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-01T10:00:00Z

Only contacts last modified on or before this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound.

propertyIDs[]
Array of integers

Only contacts linked as the association of at least one of these properties (POST /properties/associations (undocumented) links a contact of any type, though normally only associations are linked). Send each value as a separate propertyIDs[]=.

orderBy
string
Default: "contact.name"
Example: orderBy=contact.name|desc

Sort columns, comma-separated, each optionally followed by |desc (or |asc, the default): contact.name|desc. Default contact.name; contactID breaks ties. Sortable: contact.contactID, contact.isActive, contact.contactTypeID, contact.vendorTypeID, contact.name, contact.email, contact.phone, contact.defaultBillChargeAccountID, contact.payeeName, contact.taxPayerName, contact.taxFormTypeID, contact.payoutTypeID, contact.achAccountNumberTruncated, contact.achAccountTypeID, contact.holdPayments, contact.liabilityInsuranceName, contact.workersCompInsurancePolicyNumber, contact.workersCompInsuranceExpiresDate, contact.discountPercent, contact.discountGraceDays, contact.isInsuranceRequiredForPayment, contact.isTaxIdentifierValid, contact.taxIdentifierTypeID, contact.taxIdentifierCountryID, contact.hasTaxIdentifier, contact.hasDuplicateTaxIdentifier, contact.propertyCount, contact.daysUntilInsuranceExpires, contact.daysUntilLiabilityInsuranceExpires, contact.daysUntilWorkersCompInsuranceExpires, and search.rank when search is sent. Any other column is dropped without an error; with none left, rows come back in contactID order. A - prefix isn't read as descending: it makes the column unknown.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used: the requested pageSize (default 25) or the number of matching items, whichever is smaller, when anything matches.

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 page below 1 is read as 1)

pagination-next-page
integer
Example: "1"

Next page number. On the last page it repeats the last page number, so stop paging once pagination-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

The contact columns the search selects, plus values computed in SQL.

object

Sent only when search is given: the row's match rank.

Response samples

Content type
application/json
[
  • {
    }
]

Get Association

Returns one association: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.

Use Cases

  • Show an association's full record
  • Load the association's emails, phones and addresses in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every association.
  • A well-formed ID with no contact, or the ID of a contact of another type, answers 400 {"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.
  • The tax identifier itself is never returned: contact.hasTaxIdentifier says whether one is stored.
  • includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.

Available Includes (6)

  • emails - the contact's email addresses, each under email
  • phones - the contact's phone numbers, each under phone
  • addresses - the contact's addresses, each under address
  • properties - the properties linked to the association, each as propertyAssociation and property. A user restricted to portfolio groups gets only the properties in those groups' portfolios
  • contactPersons - the people on file at the contact
  • invoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has none
  • GET /associations - list associations
  • GET /associations/search - search associations
  • POST /associations/{contactID} - update the association
Authorizations:
basicAuth
path Parameters
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.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact_detail)

The contact: every column of the row plus the computed contactType, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here.

Array of objects (contact_email_row)

The contact's email addresses, each under email. Requires the emails include.

Array of objects (contact_phone_row)

The contact's phone numbers, each under phone. Requires the phones include.

Array of objects (contact_address_row)

The contact's addresses, each under address. Requires the addresses include.

Array of objects (association_property_row)

The properties linked to the association, each as propertyAssociation and property. A user restricted to portfolio groups gets only the properties in those groups' portfolios. Requires the properties include.

Array of objects (contact_person)

The people on file at the contact. Requires the contactPersons include.

contact_invoice_autofill_template (object) or null

The invoice autofill template the contact uses, or null when it has none. Requires the invoiceAutofillTemplate include.

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ],
  • "properties": [
    ],
  • "contactPersons": [
    ],
  • "invoiceAutofillTemplate": {
    }
}

Update Association

Updates editable fields on an existing association contact and returns the full association detail (same shape as GET /associations/{contactID}).

Use Cases

  • Update an association's display name, website, or discount settings
  • Toggle bill approval exemption or sales tax for an association
  • Update insurance information for payment eligibility

Business Rules

  • Requires Update Association Details permission.
  • Returns 400 if the contact is not found or is not an association.
  • isBillApprovalExempt requires the Update Bill Approval Exemption permission to take effect.
  • Only changed fields need to be included in the request body.
  • After update the endpoint forwards to the view action — pass includes query params to include related data in the response.
  • GET /associations/{contactID} — retrieve current association detail
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2305

The unique association contact ID

query Parameters
includes
string
Example: includes=emails,properties

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate

Request Body schema: application/json
required
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)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
{
  • "name": "Sunset Heights HOA Updated",
  • "code": null,
  • "defaultBillChargeAccountID": null,
  • "discountPercent": null,
  • "discountGraceDays": null,
  • "isBillingSalesTaxEnabled": "0",
  • "invoiceAutofillTemplateID": null
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Association

Permanently deletes an association contact. Returns the deleted contact as a flat object.

Use Cases

  • Remove an association that was created in error
  • Clean up test or duplicate association records

Business Rules

  • Requires Update Association Details permission.
  • Returns 400 if the contact is not found or is not an association.
  • Returns 400 if contactID is not provided in the path.
  • Deletion may fail if the association has associated financial records.
  • POST /associations/{contactID}/deactivate — soft-deactivate instead of permanently deleting
  • GET /associations/{contactID} — verify association state before deletion
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2305

The unique association contact ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
contactID
required
string^-?[0-9]+$
contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
name
required
string
payoutTypeID
required
string (payout_types)
Enum: "1" "2" "3" "4"
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
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]+$

Response samples

Content type
application/json
{
  • "contactID": "2305",
  • "contactTypeID": "5",
  • "vendorTypeID": null,
  • "code": null,
  • "name": "New Association",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": null,
  • "phone": null,
  • "countryID": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "stateID": null,
  • "postalCode": null,
  • "birthDate": null,
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": null,
  • "taxFormTypeID": null,
  • "identificationTypeID": null,
  • "identificationNumber": null,
  • "identificationCountryID": null,
  • "identificationIssuingLocation": null,
  • "identificationExpirationDate": null,
  • "payoutTypeID": "2",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": null,
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": null,
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": null,
  • "dateTimeCreated": "2024-01-04 15:45:47",
  • "dateTimeModified": "2024-01-04 15:45:47",
  • "dateTimeDeactivated": null,
  • "contactType": "Association"
}

Activate 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}).

Use Cases

  • Re-activate an association that was previously deactivated but is now active again
  • Restore an association to eligibility for bill payments and property linkage

Business Rules

  • Requires Update Association Details permission.
  • Returns 400 if the contact is not found or is not an association.
  • Sets isActive = 1
  • The response is the full association detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /associations/{contactID} — retrieve association details
  • POST /associations/{contactID}/deactivate — deactivate an active association
  • POST /associations/{contactID} — update association fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2305

The unique association contact ID to activate

query Parameters
includes
string
Example: includes=emails,properties

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Deactivate Association

Sets an association's isActive flag to 0, soft-deactivating it. Returns the updated association detail (same shape as GET /associations/{contactID}).

Use Cases

  • Deactivate an association that is no longer active to prevent new bill assignments
  • Soft-delete an association while preserving historical financial records

Business Rules

  • Requires Update Association Details permission.
  • Returns 400 if the contact is not found or is not an association.
  • Historical records (bills, invoices, payments) are preserved after deactivation.
  • The response is the full association detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /associations/{contactID} — retrieve association details
  • POST /associations/{contactID}/activate — re-activate a deactivated association
  • DELETE /associations/{contactID} — permanently delete an association
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 2305

The unique association contact ID to deactivate

query Parameters
includes
string
Example: includes=emails,properties

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Maintenance Technicians

List Maintenance Technicians

Returns a page of maintenance technicians, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /maintenance-technicians/search for more filters and computed columns.

Use Cases

  • Page through every active (or inactive) maintenance technician on the account
  • Look up maintenance technicians by name or code
  • Load a known set of contacts by ID with contactIDs[]

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every maintenance technician.
  • isActive defaults to 1: only active maintenance technicians. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.
  • search is a substring match on name and code. The text is HTML-encoded before it is matched, so text holding ', ", &, < or > (O'Brien, Smith & Sons) finds nothing here; GET /maintenance-technicians/search matches it as typed.
  • The page size defaults to 250 and is capped at 5000.
  • Sorted by name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /maintenance-technicians/search, which breaks ties on contactID.
  • includeManager adds manager contacts to the list. includeMaintenanceTechnician changes nothing here: the list already holds maintenance technicians.
  • contactIDs[] (or vendorContactIDs[]) returns those contacts when they are maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply.
  • GET /maintenance-technicians/search - filtered search with computed insurance and tax columns
  • GET /maintenance-technicians/{contactID} - one maintenance technician, with includes
  • POST /maintenance-technicians - create a maintenance technician
Authorizations:
basicAuth
query Parameters
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 name and code. HTML-encoded before matching, so text holding ', ", &, < or > finds nothing.

isActive
string
Default: "1"

1 (the default) returns active contacts, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

includeManager
string

Also list manager contacts. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

includeMaintenanceTechnician
string

Changes nothing here: the list already holds maintenance technicians. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTypeID
integer

Only contacts of this vendor type, from GET /contacts/vendor-types (undocumented). A value that isn't a number is ignored.

contactIDs[]
Array of integers

Only these contacts. Send each ID as a separate contactIDs[]=; a single contactIDs= value holding an ID is read as a list of one. Widens the types listed to maintenance technicians and managers. vendorContactIDs[] is read when contactIDs[] isn't sent.

vendorContactIDs[]
Array of integers

The older name of contactIDs[], read only when contactIDs[] isn't sent.

Responses

Response Headers
pagination-page-size
integer
Example: "250"

Page size used -- the requested pageSize (default 250), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (contact_record)

A contact: every column of the row, plus the computed contactType.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Maintenance Technician

Creates a new maintenance technician contact and returns the full technician detail (same shape as GET /maintenance-technicians/{contactID}).

Use Cases

  • Onboard a new in-house technician with a name and optional contact details
  • Create a technician with initial emails, phones, and addresses in a single request

Business Rules

  • Requires Update Internal Technician Details permission.
  • name is the only required field.
  • taxPayerName, taxFormTypeID, and taxIdentifier are only applied when the caller has the ManageTaxInfo permission.
  • After creation the endpoint forwards to the view action — the response is the full technician detail.
  • GET /maintenance-technicians/{contactID} — retrieve the created technician
  • POST /maintenance-technicians/{contactID} — update technician fields after creation
Authorizations:
basicAuth
Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
Example
{
  • "name": "New Tech Name"
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Search Maintenance Technicians

Returns a page of maintenance technicians with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.

Use Cases

  • Find maintenance technicians by name, code, email, phone or address (the row doesn't carry code: read it from GET /maintenance-technicians/{contactID})
  • Sync maintenance technicians changed since a point in time with dateTimeModifiedMin
  • Review tax-identifier data quality with hasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifier

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every maintenance technician.
  • isActive filters only when sent: without it the search returns active and inactive maintenance technicians.
  • search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15.
  • Sorted by orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.
  • Boolean filters read 1, true and yes as yes and 0, false and no as no; any other value is ignored.
  • List filters take each value as a separate name[]=.
  • includeManager=1 adds manager contacts. Only 1, true or yes turns it on.
  • isLiabilityInsuranceExpired, isWorkersCompInsuranceExpired and isInsuranceExpired take only a yes value; 0, false and no aren't supported. Maintenance technicians store no insurance dates, so the other insurance filters return none.
  • GET /maintenance-technicians - the plain list, with the full contact row
  • GET /maintenance-technicians/{contactID} - one maintenance technician, with includes
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value that isn't a number is served at 15.

search
string

Substring match on name, code, email, phone and address. Spaces in the text match any run of characters.

includeManager
string

Also return manager contacts. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

includeMaintenanceTechnician
string

Changes nothing here: the search already returns maintenance technicians. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTypeIDs[]
Array of integers

Only contacts of these vendor types, from GET /contacts/vendor-types (undocumented). Send each value as a separate vendorTypeIDs[]=.

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 (1) or not (0). Every maintenance technician stores 0, so 1 returns none. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isActive
string

Only active (1) or inactive (0) contacts. Without it, both. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

hasTaxIdentifier
string

Only contacts with (1) or without (0) a stored tax identifier. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

isTaxIdentifierValid
string

Only contacts whose stored tax identifier passed (1) or failed (0) validation; a contact with no identifier counts as 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

taxIdentifierTypeIDs[]
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 taxIdentifierTypeIDs[]=.

hasDuplicateTaxIdentifier
string

Only contacts whose tax identifier another contact also stores (1), or that no other contact shares (0, including contacts with none). 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only contacts last modified on or after this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight. A value of digits only is read as a Unix timestamp, so send 20240101 as 2024-01-01. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound, so check the value before relying on it for a sync.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-01T10:00:00Z

Only contacts last modified on or before this date and time, in UTC. Send it as 2024-01-01T10:00:00Z or 2024-01-01 10:00:00, with no offset other than Z. A date alone means its midnight, so it leaves out the rest of that day. A value of digits only is read as a Unix timestamp. Any other value that can't be read as a date is ignored, not refused: the response is unfiltered by this bound.

isInsuranceRequiredForPayment
string

Only contacts that must (1) or needn't (0) have current insurance to be paid. The API stores null here for maintenance technicians, so 1 returns none and 0 only a few older rows that store 0. 1, true and yes mean yes; 0, false and no mean no; any other value is ignored.

vendorTradeIDs[]
Array of integers

Only contacts assigned to at least one of these trades, from GET /maintenance/vendor-trades. Send each value as a separate vendorTradeIDs[]=.

propertyIDs[]
Array of integers

Only contacts linked as the association of at least one of these properties (POST /properties/associations (undocumented) links a contact of any type, though normally only associations are linked, so this usually returns no maintenance technicians). Send each value as a separate propertyIDs[]=.

isLiabilityInsuranceExpired
string

1 (or true, yes) returns only contacts whose liability insurance has expired. Maintenance technicians store no insurance dates, so this returns none. 0, false and no aren't supported. Any other value is ignored.

daysUntilLiabilityInsuranceExpiresMin
integer

Only contacts whose liability insurance expires at least this many days from today. 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

daysUntilLiabilityInsuranceExpiresMax
integer

Only contacts whose liability insurance expires at most this many days from today (negative for already expired). 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

isWorkersCompInsuranceExpired
string

1 (or true, yes) returns only contacts whose workers' comp insurance has expired. Maintenance technicians store no insurance dates, so this returns none. 0, false and no aren't supported. Any other value is ignored.

daysUntilWorkersCompInsuranceExpiresMin
integer

Only contacts whose workers' comp insurance expires at least this many days from today. 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

daysUntilWorkersCompInsuranceExpiresMax
integer

Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

isInsuranceExpired
string

1 (or true, yes) returns only contacts whose insurance (the earlier of the two dates) has expired. Maintenance technicians store no insurance dates, so this returns none. 0, false and no aren't supported. Any other value is ignored.

daysUntilInsuranceExpiresMin
integer

Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

daysUntilInsuranceExpiresMax
integer

Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). 0 is ignored. Maintenance technicians store no insurance dates, so this returns none.

tagIDs[]
Array of integers

Only contacts with at least one of these tags, from GET /tags (undocumented), attached to the contact as a vendor tag. Send each value as a separate tagIDs[]=.

orderBy
string
Default: "contact.name"
Example: orderBy=contact.name|desc

Sort columns, comma-separated, each optionally followed by |desc (or |asc, the default): contact.name|desc. Default contact.name; contactID breaks ties. Sortable: contact.contactID, contact.isActive, contact.contactTypeID, contact.vendorTypeID, contact.name, contact.email, contact.phone, contact.defaultBillChargeAccountID, contact.payeeName, contact.taxPayerName, contact.taxFormTypeID, contact.payoutTypeID, contact.achAccountNumberTruncated, contact.achAccountTypeID, contact.holdPayments, contact.liabilityInsuranceName, contact.workersCompInsurancePolicyNumber, contact.workersCompInsuranceExpiresDate, contact.discountPercent, contact.discountGraceDays, contact.isInsuranceRequiredForPayment, contact.isTaxIdentifierValid, contact.taxIdentifierTypeID, contact.taxIdentifierCountryID, contact.hasTaxIdentifier, contact.hasDuplicateTaxIdentifier, contact.propertyCount, contact.daysUntilInsuranceExpires, contact.daysUntilLiabilityInsuranceExpires, contact.daysUntilWorkersCompInsuranceExpires, and search.rank when search is sent. Any other column is dropped without an error; with none left, rows come back in contactID order. A - prefix isn't read as descending: it makes the column unknown.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used: the requested pageSize (default 25) or the number of matching items, whichever is smaller, when anything matches.

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 page below 1 is read as 1)

pagination-next-page
integer
Example: "1"

Next page number. On the last page it repeats the last page number, so stop paging once pagination-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

The contact columns the search selects, plus values computed in SQL.

object

Sent only when search is given: the row's match rank.

Response samples

Content type
application/json
[
  • {
    }
]

Get Maintenance Technician

Returns one maintenance technician: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.

Use Cases

  • Show a maintenance technician's full record
  • Load the maintenance technician's emails, phones and addresses in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • Portfolio restrictions don't apply: a restricted user gets every maintenance technician.
  • A well-formed ID with no contact, or the ID of a contact of another type, answers 400 {"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.
  • The tax identifier itself is never returned: contact.hasTaxIdentifier says whether one is stored.
  • includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.

Available Includes (10)

  • emails - the contact's email addresses, each under email
  • phones - the contact's phone numbers, each under phone
  • addresses - the contact's addresses, each under address
  • portalAccounts - the maintenance portal accounts linked to the contact
  • portalInvitations - the pending, unexpired invitations to the maintenance portal, newest first
  • vendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTrade
  • taxAdjustments - the contact's 1099 tax adjustments
  • contactPersons - the people on file at the contact
  • reviewStats - one row counting the contact's completed maintenance reviews by rating
  • invoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has none
  • GET /maintenance-technicians - list maintenance technicians
  • GET /maintenance-technicians/search - search maintenance technicians
  • POST /maintenance-technicians/{contactID} - update the maintenance technician
Authorizations:
basicAuth
path Parameters
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.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact_detail)

The contact: every column of the row plus the computed contactType, and four tax-identifier keys the view action adds in PHP. The tax identifier itself is never returned here.

Array of objects (contact_email_row)

The contact's email addresses, each under email. Requires the emails include.

Array of objects (contact_phone_row)

The contact's phone numbers, each under phone. Requires the phones include.

Array of objects (contact_address_row)

The contact's addresses, each under address. Requires the addresses include.

Array of objects (contact_portal_account)

The maintenance portal accounts linked to the contact. Requires the portalAccounts include.

Array of objects (contact_portal_invitation)

The pending, unexpired invitations to the maintenance portal, newest first. Requires the portalInvitations include.

Array of objects (vendor_trade_row)

The trades assigned to the contact, each as contactVendorTrade and vendorTrade. Requires the vendorTrades include.

Array of objects (contact_tax_adjustment)

The contact's 1099 tax adjustments. Requires the taxAdjustments include.

Array of objects (contact_person)

The people on file at the contact. Requires the contactPersons include.

Array of objects (vendor_review_stats)

One row counting the contact's completed maintenance reviews by rating. Requires the reviewStats include.

contact_invoice_autofill_template (object) or null

The invoice autofill template the contact uses, or null when it has none. Requires the invoiceAutofillTemplate include.

Response samples

Content type
application/json
{
  • "contact": {
    },
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ],
  • "portalAccounts": [
    ],
  • "portalInvitations": [
    ],
  • "vendorTrades": [
    ],
  • "taxAdjustments": [
    ],
  • "contactPersons": [
    ],
  • "reviewStats": [
    ],
  • "invoiceAutofillTemplate": null
}

Update Maintenance Technician

Updates editable fields on an existing maintenance technician contact and returns the full technician detail (same shape as GET /maintenance-technicians/{contactID}).

Use Cases

  • Update a technician's display name, code, birth date

Business Rules

  • Requires Update Internal Technician Details permission.
  • Returns 400 if the contact is not found or is not a maintenance technician.
  • Only the fields name, code, and birthDate are writable via this endpoint. All other fields in the request body are silently ignored.
  • After update the endpoint forwards to the view action — pass includes query params to include related data in the response.
  • GET /maintenance-technicians/{contactID} — retrieve current technician detail
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5267

The unique maintenance technician contact ID

query Parameters
includes
string
Example: includes=emails,phones

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (contact)

Request samples

Content type
application/json
{
  • "name": "new tech names",
  • "code": null,
  • "birthDate": null
}

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Maintenance Technician

Permanently deletes a maintenance technician contact. Returns the deleted contact as a flat object.

Use Cases

  • Remove a technician who was created in error
  • Clean up test or duplicate technician records

Business Rules

  • Requires Update Maintenance Technician permission.
  • Returns 400 if the contact is not found or is not a maintenance technician.
  • Deletion may fail if the technician has associated financial records — the service layer returns errors in that case.
  • POST /maintenance-technicians/{contactID}/deactivate — soft-deactivate instead of permanently deleting
  • GET /maintenance-technicians/{contactID} — verify technician state before deletion
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5267

The unique maintenance technician contact ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
contactID
required
string^-?[0-9]+$
contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"
  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Manager
  • 5 - Association
  • 6 - Applicant
  • 7 - Screening Prospect
  • 8 - Internal Technician
  • 9 - Owner Lead
name
required
string
payoutTypeID
required
string (payout_types)
Enum: "1" "2" "3" "4"
  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
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]+$

Response samples

Content type
application/json
{
  • "contactID": "5267",
  • "contactTypeID": "8",
  • "vendorTypeID": null,
  • "code": null,
  • "name": "new tech names",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": null,
  • "phone": null,
  • "countryID": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "stateID": null,
  • "postalCode": null,
  • "birthDate": null,
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": "new tech name",
  • "taxFormTypeID": "1",
  • "identificationTypeID": null,
  • "identificationNumber": null,
  • "identificationCountryID": null,
  • "identificationIssuingLocation": null,
  • "identificationExpirationDate": null,
  • "payoutTypeID": "2",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": null,
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": null,
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": null,
  • "dateTimeCreated": "2026-04-24 22:15:55",
  • "dateTimeModified": "2026-04-24 22:20:10",
  • "dateTimeDeactivated": null,
  • "contactType": "Internal Technician"
}

Activate Maintenance 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}).

Use Cases

  • Re-activate a technician who was previously deactivated but is returning to service
  • Restore a technician to eligibility for work order assignments

Business Rules

  • Requires Update Internal Technician Details permission.
  • Returns 400 if the contact is not found or is not a maintenance technician.
  • Sets isActive = 1
  • The response is the full technician detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /maintenance-technicians/{contactID} — retrieve technician details
  • POST /maintenance-technicians/{contactID}/deactivate — deactivate an active technician
  • POST /maintenance-technicians/{contactID} — update technician fields
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5267

The unique maintenance technician contact ID to activate

query Parameters
includes
string
Example: includes=emails,phones

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Deactivate Maintenance Technician

Sets a maintenance technician's isActive flag to 0, soft-deactivating them. Returns the updated technician detail (same shape as GET /maintenance-technicians/{contactID}).

Use Cases

  • Deactivate a technician who is no longer available to prevent new work order assignments
  • Soft-delete a technician while preserving historical records

Business Rules

  • Requires Update Internal Technician Details permission.
  • Returns 400 if the contact is not found or is not a maintenance technician.
  • Historical records (work orders, bills) are preserved after deactivation.
  • The response is the full technician detail (forwarded to the view action). Pass includes query params to include related data.
  • GET /maintenance-technicians/{contactID} — retrieve technician details
  • POST /maintenance-technicians/{contactID}/activate — re-activate a deactivated technician
  • DELETE /maintenance-technicians/{contactID} — permanently delete a technician
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 5267

The unique maintenance technician contact ID to deactivate

query Parameters
includes
string
Example: includes=emails,phones

Comma-separated list of related data to include in the response.

Available values: emails, phones, addresses, portalAccounts, portalInvitations, vendorTrades, taxAdjustments, contactPersons, reviewStats, invoiceAutofillTemplate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Files

List Files

Lists the account's attachable files, newest first, one page at a time. Each item wraps the file under file, beside a token the list adds.

Use Cases

  • Pick an existing file to attach to a record, instead of uploading it again
  • Find a file by part of its title

Business Rules

  • Requires only authentication; no permission is checked.
  • Use a key with no portfolio-group limit.
  • Lists only files with isAttachable 1; to include the others, use GET /files/search.
  • search matches any part of the title, in any case. Its &, <, >, ' and " are HTML-escaped first, so a search holding one of them matches no title that has it. Without search, the list isn't filtered by title.
  • Sorted by dateTimeCreated, newest first, with no tie-breaker: files created in the same second can repeat or be skipped across pages.
  • GET /files/search - search the account's files, with filters
  • GET /files/{fileID} - one file, with its attachments
  • POST /files - upload a file
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
pagination-page-size
integer
Example: "50"

Page size used -- the requested pageSize (default 50), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

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.

Response samples

Content type
application/json
[
  • {
    }
]

Upload

Uploading a file in Rentvine is generally a 2-step process.

  1. Upload the file to store within Rentvine
  2. Attach the file to an object, e.g. Unit, Lease, etc.

To upload the file and attach it to an object in one step, provide the objectID and objectTypeID as query parameters.

E.g. if you uploaded the file using the path /files?objectTypeID=7&objectID=123, the file would be uploaded and attached to the Unit (object type id for Unit is 7) with unitID of 123.

Authorizations:
basicAuth
query Parameters
objectID
integer

The primary key of the object

objectTypeID
integer

The id of the Object Type

includes
string
Value: "attachment"
  • attachment - Includes the attachment object in the response
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

object (attachment)

Included if attachment provided in includes query parameter

Response samples

Content type
application/json
{
  • "file": {
    },
  • "attachment": {
    }
}

Search Files

Searches the account's files, attachable or not, with filters on type, size, source and uploader, one page at a time, sorted by title. Each item wraps the file under file.

Use Cases

  • Find the PDFs or images uploaded by one user
  • Find large files, or files Rentvine created (letters, statements), by fileSourceIDs[]

Business Rules

  • Requires only authentication; no permission is checked.
  • Use a key with no portfolio-group limit.
  • Filters combine with AND. A filter left out doesn't filter; neither does an isAttachable, fileSizeMin or fileSizeMax value it can't read. A list filter given values that match nothing (fileSourceIDs[]=abc) returns no files.
  • A list filter (fileTypes[], fileSourceIDs[], userIDs[]) takes one name[]= per value, and matches any of them.
  • Sorted by title, then by fileID.
  • attachedToObjectTypeIDs[], dateTimeCreatedMin and dateTimeCreatedMax fail with an empty 500 for any value they can use (any attachedToObjectTypeIDs[] value, any date): the SQL they add is malformed or names a column the table doesn't have. An empty value, or a date that can't be read, is dropped. Don't send them.
  • GET /files - the attachable files, newest first
  • GET /files/{fileID} - one file, with its attachments
Authorizations:
basicAuth
query Parameters
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

true lists only attachable files, false only the others; 1/0 and yes/no work too. Any other value doesn't filter.

fileType
string
Example: fileType=pdf

One extension (pdf, jpg), matched in any case.

fileTypes[]
Array of strings
Example: fileTypes[]=pdf&fileTypes[]=jpg

Extensions, any of which matches. Send one fileTypes[]= per value; a single comma-separated value is read as one extension.

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 fileSourceIDs[]= per value.

  • 1 - Upload
  • 2 - Inbound Message
  • 3 - Letter
  • 4 - Bulk Letter
  • 5 - Statement Batch
  • 6 - Created Invoice
  • 7 - RentSign
  • 8 - Move Out Statement
userIDs[]
Array of integers
Example: userIDs[]=2

The users who uploaded or created the file (a file's userID), any of which matches. Send one userIDs[]= per value.

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). 0 or a negative value is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25), with no upper limit. 0 or a negative value is read as 15.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

Page size used -- the requested pageSize (default 25), or the number of matching items when that is smaller. When nothing matches, read pagination-total-items (0) instead.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

Response samples

Content type
application/json
[
  • {
    }
]

Get File

Returns one file's record under file, and with the fileAttachments include, every record the file is attached to.

Use Cases

  • Read a file's title, type and size before downloading it
  • Find every record a file is attached to before deleting it

Business Rules

  • Requires only authentication; no permission is checked.
  • With a key limited to some portfolio groups, don't send the fileID of a file attached only to records outside those portfolios.
  • A well-formed fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits (abc, -1) answers the stock 404.

Available Includes (1)

  • fileAttachments - every attachment of the file, an empty list when it has none
  • POST /files/{fileID} - rename the file or change whether it can be attached
  • DELETE /files/{fileID} - delete the file
  • GET /files/{fileID}/download (undocumented) - the file itself
Authorizations:
basicAuth
path Parameters
fileID
required
integer
Example: 60

The file, from GET /files or GET /files/search.

query Parameters
includes
string
Example: includes=fileAttachments

Comma-separated includes. One is available, fileAttachments; any other name is ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

Array of objects (attachment)

Every attachment of the file, an empty list when it has none. Requires the fileAttachments include.

Response samples

Content type
application/json
{
  • "file": {
    },
  • "fileAttachments": [
    ]
}

Update File

Renames a file or changes whether it can be attached, and returns it in the GET /files/{fileID} shape (with fileAttachments when the request's query string asks for it).

Use Cases

  • Give an uploaded file a readable title
  • Hide a file from the attachable list (GET /files) without deleting it

Business Rules

  • Requires the Update Files permission (Files › UpdateFile), checked before anything else: a key without it gets the 403 whatever the body or ID.
  • With a key limited to some portfolio groups, don't send the fileID of a file attached only to records outside those portfolios.
  • Only title and isAttachable are read; any other key in the body is ignored.
  • An empty body, or {}, answers 400 invalid input..
  • A well-formed fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits (abc, -1) answers the stock 404.
  • A title that is empty, only spaces or longer than 200 characters, or an isAttachable that isn't a boolean, answers 400 with the validation messages, keyed by field.

Side Effects

  • A new title is copied into the file list kept on each email and text message the file is attached to.
  • GET /files/{fileID} - the file
Authorizations:
basicAuth
path Parameters
fileID
required
integer
Example: 60

The file, from GET /files or GET /files/search.

query Parameters
includes
string
Example: includes=fileAttachments

fileAttachments adds the file's attachments to the response, as on GET /files/{fileID}.

Request Body schema: application/json
required
non-empty
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 GET /files.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

Array of objects (attachment)

Every attachment of the file, an empty list when it has none. Requires the fileAttachments include.

Request samples

Content type
application/json
{
  • "title": "Front door photo (cropped)",
  • "isAttachable": false
}

Response samples

Content type
application/json
{
  • "file": {
    }
}

Delete File

Deletes a file: its record, every attachment of it, and the stored file. Returns the deleted file under file.

Use Cases

  • Remove a file uploaded by mistake from every record it is attached to

Business Rules

  • Requires the Update Files permission (Files › UpdateFile), checked before anything else: a key without it gets the 403 whatever the body or ID.
  • With a key limited to some portfolio groups, don't send the fileID of a file attached only to records outside those portfolios.
  • A well-formed fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits (abc, -1) answers the stock 404.
  • The delete can't be undone.

Side Effects

  • Every attachment of the file is deleted, so it disappears from each record it was on, with whatever is linked to the attachment itself (its notes, activity and the like). On a record whose activity is tracked, the "File Added" entry keeps its title but loses its link to the file, and a "File Deleted" entry is added.
  • The key's user is added as a watcher of each record the file was on, where that record type has watchers.
  • The file list kept on each email and text message the file was attached to is updated.
  • A maintenance material that used the file as its image keeps no image (imageFileID becomes null).
  • Each work-order receipt scanned from the file is deleted.
  • The stored file and its preview are removed from storage.
  • GET /files/{fileID} - the file and its attachments, to check before deleting
Authorizations:
basicAuth
path Parameters
fileID
required
integer
Example: 60

The file, from GET /files or GET /files/search.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 GET /files/{fileID}/download (undocumented); this object is its record. A file is shown on a record (a unit, a lease, a work order) through a file attachment.

Response samples

Content type
application/json
{
  • "file": {
    }
}

Leases

List Lease Statuses

Returns all lease statuses defined for the account, ordered by orderIndex. Each result wraps a single leaseStatus object. System statuses (isSystemStatus = 1) are built-in and cannot be deleted; custom statuses are account-defined.

Use Cases

  • Displaying the full list of available statuses in lease status management settings

Business Rules

  • No special permission required — any authenticated user can read lease statuses
  • Results are ordered by orderIndex ascending
  • primaryLeaseStatusID groups each status under one of three top-level states: Pending (1), Active (2), or Closed (3)
  • POST /leases/{leaseID}/status - Update the status of a specific lease
Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

List Leases

Lists leases

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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, null when empty.

Response samples

Content type
application/json
[
  • {
    }
]

Create Lease

Creates a new lease with all associated entities: tenants, recurring charges, move-in charges, occupants, pets, emergency contacts, and vehicles.

Use Cases

  • Converting an approved rental application into an active lease
  • Creating a lease directly without a prior application

Business Rules

  • Requires Update Lease permission in Roles
  • The unit specified in unitID must exist and be active
  • At least one entry in the tenants array is required
  • If applicationID is provided, the application must exist and be in a compatible state
  • If chargeLeaseFee is true, both leaseFeeAmount and leaseFeeDatePosted must be provided
  • On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail
  • GET /leases - List leases
  • GET /leases/{leaseID} - Get lease detail (same shape as the response here)
  • POST /leases/{leaseID} - Update lease
Authorizations:
basicAuth
Request Body schema: application/json
required
required
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 (resident_packages) — a top-level field, not part of the lease object. When set, the lease is enrolled on create: it opens the single bundled recurring charge and snapshots the package's services as member entitlements. Must reference an existing, active package with at least one active service (a missing id returns 400). Omit/null to create the lease without a package.

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 residentServiceID must reference an active catalog service (resident_services).

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 lease.applicationID is set.

Array of objects

Co-signer applicants from the linked application. Only processed when lease.applicationID is set.

Array of objects

Non-tenant occupants (minors, roommates, etc.) listed on the lease.

processPetsFromApplication
boolean
Default: true

When true (default), pets are copied from the linked application. Set to false and provide the pets array to supply pet data directly.

Array of objects

Pets on the lease. Only used when processPetsFromApplication is false.

processEmergencyContactsFromApplication
boolean
Default: true

When true (default), emergency contacts are copied from the linked application. Set to false and provide emergencyContacts directly.

Array of objects

Emergency contacts for the tenant. Only used when processEmergencyContactsFromApplication is false.

processVehiclesFromApplication
boolean
Default: true

When true (default), vehicles are copied from the linked application. Set to false and provide the vehicles array directly.

Array of objects

Vehicles registered to the lease. Only used when processVehiclesFromApplication is false.

sendPortalInvitations
boolean
Default: false

When true, portal invitation emails are sent to all tenants on the lease at creation.

deactivateListing
boolean
Default: false

When true, the property listing is deactivated upon lease creation.

chargeLeaseFee
boolean
Default: false

When true, a management lease fee is charged at creation. Requires leaseFeeAmount and leaseFeeDatePosted.

leaseFeeAmount
string or number <decimal>

Lease fee amount. Required when chargeLeaseFee is true.

leaseFeeDatePosted
string <date>

Date to post the lease fee. Required when chargeLeaseFee is true.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Request samples

Content type
application/json
{
  • "lease": {
    },
  • "application": {
    },
  • "applicants": [ ],
  • "tenants": [
    ],
  • "cosignerTenants": [ ],
  • "cosignerApplicants": [ ],
  • "occupants": [ ],
  • "processEmergencyContactsFromApplication": false,
  • "emergencyContacts": [ ],
  • "processPetsFromApplication": false,
  • "pets": [ ],
  • "processVehiclesFromApplication": false,
  • "vehicles": [ ],
  • "recurringCharges": [
    ],
  • "otherRecurringCharges": [
    ],
  • "charges": [
    ],
  • "sendPortalInvitations": false,
  • "deactivateListing": false,
  • "chargeLeaseFee": true,
  • "leaseFeeAmount": "1500.00",
  • "leaseFeeDatePosted": "04/29/2026"
}

Response samples

Content type
application/json
{
  • "lease": {
    }
}

View

Returns a single lease. The response always contains lease; every other top-level key is opt-in via the includes query parameter, so the frontend fetches exactly the related data a page needs in one request.

Includes

Pass a comma-separated list, e.g. ?includes=property,unit,tenants,residentPackage. Each include adds the listed top-level key(s) to the response. Some includes are nested — they only resolve when their parent include is also requested (noted below).

Property & portfolio

  • property → property
  • portfolio → portfolio (requires property)
  • postingSetting → postingSetting, operatingAccount (requires property, portfolio)
  • portfolioOwners → portfolioOwners (requires property, portfolio)
  • chargesForPayment → chargesForPayment (requires property)
  • previousPropertyPortfolio → previousPropertyPortfolio (omitted when none)

Unit

  • unit → unit
  • propertyManager → propertyManager (requires unit)

Lease meta

  • leaseStatus → leaseStatus
  • tenants → tenants
  • occupants → occupants
  • vehicles → vehicles
  • emergencyContacts → emergencyContacts
  • moveOutContact → moveOutContact (null when none)
  • application → application (only when the lease has an application)
  • leaseDocumentTransaction → leaseDocumentTransaction
  • statementSetting → statementSetting (null when using the portfolio default)
  • tenantAddresses → tenantAddresses

Pets

  • pets → pets, plus petScreeningEnabled, petscreeningData, noPetData when the lease has an application

Billing & accounting

  • recurringCharges → recurringCharges
  • leaseRecurringPayments → leaseRecurringPayments
  • leaseRecurringCredits → leaseRecurringCredits
  • outstandingCharges → outstandingCharges
  • outstandingCredits → outstandingCredits
  • outstandingPayments → outstandingPayments
  • transactions → transactions
  • refundableTransactions → refundableTransactions
  • balances → balances
  • lateFeeSetting → lateFeeSetting
  • leaseFeeTransaction → leaseFeeTransaction
  • leaseFeeBill → leaseFeeBill
  • leaseFeeBillCharges → leaseFeeBillCharges

Renewals

  • renewals → renewals
  • activeRenewal → activeRenewal (the most recent in-progress renewal, or null)

Insurance

  • tenantLiabilityInsuranceProvider → tenantLiabilityInsuranceProvider (null when none)
  • tenantLiabilityInsurance → tenantLiabilityInsurance
  • rentersInsuranceFile → rentersInsuranceFile (null when none)
  • rentersInsuranceRequest → rentersInsuranceRequest (null when none)
  • tenantPolicyStatus → tenantPolicyStatus (system/provider policy status; null for non-system leases)

Resident Experience Package (REP)

  • residentPackage → leaseResidentPackage, residentPackage (both null when the lease isn't enrolled)
  • residentServices → residentServices
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease)
object

The lease's property. Requires property include.

portfolio
object

The property's portfolio. Requires property,portfolio.

postingSetting
object

The portfolio's posting setting. Requires property,portfolio,postingSetting.

operatingAccount
object

The posting setting's operating account. Added alongside postingSetting.

portfolioOwners
Array of objects

The portfolio's owners (each with their contact). Requires property,portfolio,portfolioOwners.

chargesForPayment
Array of objects

Unpaid charges available for payment, each wrapped as { transaction }. Requires property,chargesForPayment.

previousPropertyPortfolio
object

The property's prior (non-current) portfolio. Present only when one exists. Requires previousPropertyPortfolio.

object

The lease's unit. Requires unit include.

propertyManager
object

The unit's property manager. Requires unit,propertyManager.

object

The lease's status record. Requires leaseStatus include.

Array of objects (tenant)

The lease's tenants (each lease-tenant link joined to its contact). Requires tenants include.

occupants
Array of objects or null

The lease's occupants. Requires occupants include.

vehicles
Array of objects or null

The lease's vehicles. Requires vehicles include.

emergencyContacts
Array of objects or null

The lease's emergency contacts. Requires emergencyContacts include.

moveOutContact
object or null

The move-out contact, or null. Requires moveOutContact include.

application
object

The originating rental application. Present only when the lease has an application. Requires application include.

leaseDocumentTransaction
object

The lease's e-sign document transaction. Requires leaseDocumentTransaction include.

statementSetting
object or null

The lease's statement-setting override, or null when using the portfolio default. Requires statementSetting include.

tenantAddresses
Array of objects

The lease's tenant mailing addresses. Requires tenantAddresses include.

pets
Array of objects or null

The lease's pets. Requires pets include.

petScreeningEnabled
boolean

Whether pet screening is enabled for the lease's application. Added with pets when the lease has an application.

petscreeningData
object

Pet-screening profile data for the application's applicants. Added with pets when the lease has an application.

noPetData
object

No-pet acknowledgement data, when an applicant declared no pets. Added with pets when present.

recurringCharges
Array of objects

The lease's recurring charges. Requires recurringCharges include.

leaseRecurringPayments
Array of objects

The lease's recurring payments (with payment method). Requires leaseRecurringPayments include.

leaseRecurringCredits
Array of objects

The lease's recurring credits. Requires leaseRecurringCredits include.

outstandingCharges
Array of objects

Outstanding charge transactions. Requires outstandingCharges include.

outstandingCredits
Array of objects

Outstanding credit transactions. Requires outstandingCredits include.

outstandingPayments
Array of objects

Outstanding payment transactions. Requires outstandingPayments include.

transactions
Array of objects

The lease's non-voided transactions, newest first. Requires transactions include.

refundableTransactions
Array of objects

Transactions eligible for refund. Requires refundableTransactions include.

balances
object

The lease's account balances as of today (account timezone). Requires balances include.

lateFeeSetting
object or null

The lease's late-fee setting, or null. Requires lateFeeSetting include.

leaseFeeTransaction
object or null

The lease-fee transaction, or null. Requires leaseFeeTransaction include.

leaseFeeBill
object or null

The lease-fee bill, or null. Requires leaseFeeBill include.

leaseFeeBillCharges
Array of objects

The lease-fee bill's charge transactions (empty when no bill). Requires leaseFeeBillCharges include.

renewals
Array of objects

The lease's renewals, each with a resolved leaseRenewalStatusName. Requires renewals include.

activeRenewal
object or null

The most recent in-progress renewal, or null when none is active. Requires activeRenewal include.

tenantLiabilityInsuranceProvider
object or null

The lease's TLL provider, or null. Requires tenantLiabilityInsuranceProvider include.

tenantLiabilityInsurance
object

The lease's tenant liability insurance view. Requires tenantLiabilityInsurance include.

rentersInsuranceFile
object or null

The uploaded proof-of-insurance file (non-system policies), or null. Requires rentersInsuranceFile include.

rentersInsuranceRequest
object or null

A pending renters-insurance request, or null. Requires rentersInsuranceRequest include.

tenantPolicyStatus
object or null

System/provider policy status ({ tenantPolicyStatusID }), or null for non-system leases. Requires tenantPolicyStatus include.

object

The lease's one REP package enrollment (lease_resident_packages), or null when not enrolled. Requires residentPackage include.

object

The catalog package (resident_packages) the enrollment points to, or null when not enrolled. Added alongside leaseResidentPackage via the residentPackage include.

Array of objects

The lease's REP service entitlements (lease_resident_services), each joined to its catalog service. Requires residentServices include.

Response samples

Content type
application/json
{
  • "lease": {
    },
  • "property": {
    },
  • "portfolio": { },
  • "postingSetting": { },
  • "operatingAccount": { },
  • "portfolioOwners": [
    ],
  • "chargesForPayment": [
    ],
  • "previousPropertyPortfolio": { },
  • "unit": {
    },
  • "propertyManager": { },
  • "leaseStatus": {
    },
  • "tenants": [
    ],
  • "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": {
    },
  • "residentPackage": {
    },
  • "residentServices": [
    ]
}

Update Lease

Updates an existing lease's details. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.

Use Cases

  • Modifying lease dates (start, end, move-in, move-out, notice, expected move-out)
  • Changing the assigned property manager (assignedToUserID)
  • Adjusting late fee settings, allowed tenant payment amount, and statement settings
  • Providing the lease with a closedDate and closedDescription within the lease details

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist; a 400 is returned if not found
  • Portfolio restrictions apply — users can only update leases within their accessible portfolios
  • leaseStatusID is not updated by this endpoint; use POST /leases/{leaseID}/status to change status
  • GET /leases/{leaseID} - Get full lease detail (same response shape as returned here)
  • POST /leases/{leaseID}/status - Update lease status only
  • POST /leases - Create a new lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
Request Body schema: application/json
required
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 POST /leases/{leaseID}/status to change status.

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 to close a lease.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease)

Request samples

Content type
application/json
{
  • "assignedToUserID": "122188",
  • "leaseStatusID": "21",
  • "noticeDate": "2025-03-21",
  • "expectedMoveOutDate": "2025-08-05",
  • "moveInDate": "2025-03-05",
  • "moveOutDate": "2025-08-05",
  • "depositRefundDueDate": "2026-04-21",
  • "closedDate": "2026-04-21",
  • "closedDescription": "test 1",
  • "startDate": "2026-04-17",
  • "endDate": "2026-10-17",
  • "increaseEligibilityDate": "2028-03-05",
  • "rentAmount": 100,
  • "leaseReturnChargeAmount": "35.00",
  • "lateFeeSettingID": "87",
  • "showOverriddenAllowedPaymentType": true,
  • "allowedPaymentAmountTypeID": 1,
  • "isTenantPastDueNoticeEnabled": "1",
  • "statementSettingID": "1",
  • "sendStatements": "1"
}

Response samples

Content type
application/json
{
  • "lease": {
    }
}

Delete Lease

Permanently deletes a lease from the system. On success, returns the deleted lease record as it existed at time of deletion.

This endpoint will only succeed if the lease has never had any accounting transactions, payouts, or deposit releases tied to it. Voiding or deleting individual charges, tenant credits, or tenant receipts does not satisfy this requirement — once any transaction has ever been recorded against a lease, the lease cannot be deleted. Use lease closure or move-out workflows instead to retire a lease that has financial history.

Use Cases

  • Removing a lease that was created in error before any accounting activity occurred
  • Cleaning up test or draft leases in non-production environments

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist; a 400 is returned if not found
  • The lease must have zero accounting transactions ever recorded (including voided ones); a 400 is returned with "Cannot delete a lease that has accounting transactions" if any exist
  • All associated tenants, occupants, recurring charges, and related records are cascade-deleted as part of this operation
  • GET /leases/{leaseID} - Get the lease detail before deleting
  • POST /leases/{leaseID}/status - Close or change lease status (for leases with transaction history)
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease)

Response samples

Content type
application/json
{
  • "leaseID": "2213",
  • "propertyID": "406",
  • "unitID": "391",
  • "primaryLeaseStatusID": "1",
  • "leaseStatusID": "21",
  • "moveOutStatusID": "1",
  • "assignedToUserID": null,
  • "applicationID": null,
  • "leaseDocumentTransactionID": null,
  • "code": null,
  • "moveInDate": "2026-05-01",
  • "startDate": "2026-05-01",
  • "endDate": "2027-04-30",
  • "dateTimeCreated": "2026-04-22 10:00:00",
  • "dateTimeModified": "2026-04-22 10:00:00",
  • "lateFeeSettingID": null,
  • "isPortalDisabled": "0",
  • "isPortalPaymentDisabled": "0",
  • "isCertifiedFundsRequired": "0",
  • "isLateFeesActive": "1",
  • "isLeaseAgreementViolated": "0",
  • "tenantRefundPayoutTypeID": "1",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "isTenantPastDueNoticeEnabled": "0",
  • "isAutoClosed": "0",
  • "isPublicStatementEnabled": "0",
  • "isMarkedToVacate": "0"
}

Update Lease Status

Updates the status of an existing lease. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.

Use Cases

  • Adjusting a lease status

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist; a 400 is returned if not found
  • Portfolio restrictions apply — users can only update leases within their accessible portfolios
  • leaseStatusID is the only required field; all other fields are optional and will be updated only when provided
  • leaseStatusID references custom statuses configured in the account (see GET /leases/statuses)
  • 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
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
Request Body schema: application/json
required
leaseStatusID
required
string or integer^-?[0-9]+$

ID of the custom lease status to assign. References the account-configured statuses from GET /leases/statuses.

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).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease)

Request samples

Content type
application/json
Example
{
  • "leaseStatusID": 2
}

Response samples

Content type
application/json
{
  • "lease": {
    }
}

List Lease Tenants

Returns all tenants associated with a lease, each as a pair of leaseTenant and contact objects. Portal access data (hasPortalAccess, hasPortalInvitation, invitationDateTimeCreated, hasApplicantUser) is always included.

Use Cases

  • Displaying a list of current and past tenants for a lease
  • Checking whether a tenant has portal access or a pending invitation

Business Rules

  • The lease must be within the user's accessible portfolios; a 400 is returned otherwise
  • Results are ordered: active first, primary first, then by orderIndex, then by leaseTenantID
  • When isActive is omitted, both active and inactive tenants are returned
  • Portal data is always computed inline (not an opt-in include)
  • POST /leases/{leaseID}/tenants - Add a tenant to the lease
  • DELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
query Parameters
isActive
integer
Enum: 0 1
Example: isActive=1

Filter by active status. 1 returns only active tenants, 0 returns only inactive tenants. Omit to return all.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Add Tenant to Lease

Adds a new tenant to an existing lease. You can either link an existing contact by providing contactID, or create a brand-new tenant contact by supplying name, emails, phones, and/or addresses. On success the endpoint internally forwards to GET /leases/{leaseID}/tenants/{leaseTenantID} and returns the full tenant detail.

Use Cases

  • Adding a new tenant to an active lease mid-term
  • Linking an existing tenant contact to a lease they will now occupy
  • Recording a co-signer who is financially responsible but not a primary tenant

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist and be within the user's accessible portfolios; a 400 is returned otherwise
  • Cannot add a tenant to a lease in Closed status (primaryLeaseStatusID = 3)
  • If contactID is omitted or empty, a new contact is created using name (required), plus optional emails, phones, and addresses
  • If contactID is provided, the existing contact is linked directly — name, emails, phones, and addresses are ignored
  • The linked or newly-created contact must be of type Tenant (contactTypeID = 2) and must be active
  • A contact can only appear once on a given lease — duplicate assignments return a 400
  • moveInDate is required
  • GET /leases/{leaseID}/tenants - List all tenants on the lease
  • GET /leases/{leaseID}/tenants/{leaseTenantID} - Get a single tenant (same response shape returned here)
  • DELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
Request Body schema: application/json
required
moveInDate
required
string <date>

Date the tenant moves in. Required.

name
required
string

Full name of the new tenant contact. Required when contactID is not provided.

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 name, emails, phones, and addresses.

Array of objects

Email addresses to attach to the new tenant contact. Ignored when contactID is provided.

Array of objects

Phone numbers to attach to the new tenant contact. Ignored when contactID is provided.

Array of objects

Addresses to attach to the new tenant contact. Ignored when contactID is provided.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

The newly created lease tenant record.

required
object

The contact record for the tenant.

Request samples

Content type
application/json
Example
{
  • "moveInDate": "2026-04-21",
  • "isCosigner": 0,
  • "name": "Testing Doc",
  • "emails": [
    ],
  • "phones": [
    ]
}

Response samples

Content type
application/json
{
  • "leaseTenant": {
    },
  • "contact": {
    }
}

Remove Tenant from Lease

Removes a tenant from a lease. On success, returns the deleted lease tenant record as it existed at time of deletion.

Use Cases

  • Removing a tenant who no longer occupies the unit
  • Correcting a mistakenly added tenant before any accounting activity

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist and be within the user's accessible portfolios; a 400 is returned otherwise
  • The leaseTenantID must belong to the specified leaseID; a 400 is returned if the lease tenant is not found
  • The lease must have at least one active tenant; a 400 is returned if the lease has no active tenants
  • GET /leases/{leaseID}/tenants - List all tenants on the lease
  • GET /leases/{leaseID}/tenants/{leaseTenantID} - Get a single tenant detail
  • POST /leases/{leaseID}/tenants - Add a tenant to the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
leaseTenantID
required
integer
Example: 3391

The leaseTenantID of the tenant record to remove.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 (1 = yes, 0 = no).

isCosigner
required
string
Enum: "0" "1"

Whether this tenant was a co-signer (1 = yes, 0 = no).

isActive
required
string
Enum: "0" "1"

Active status at time of deletion (1 = active, 0 = inactive).

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.

Response samples

Content type
application/json
{
  • "leaseTenantID": "3391",
  • "leaseID": "2213",
  • "contactID": "5246",
  • "isPrimary": "0",
  • "isCosigner": "0",
  • "isActive": "1",
  • "moveInDate": "2026-05-01",
  • "moveOutDate": null,
  • "orderIndex": "4"
}

List Recurring Charges

Returns a paginated list of recurring charges for a lease. Each item includes the recurringCharge record and the associated account (chart-of-accounts entry). The account is always included — no additional includes parameter is needed.

Use Cases

  • Displaying all recurring charges on a lease detail page

Business Rules

  • The lease must be within the user's accessible portfolios; a 400 is returned otherwise
  • The account is always present in each list item — it cannot be excluded
  • recurringStatusID is not included in list items — use GET /leases/{leaseID}/recurring-charges/{chargeID} to get the computed status for a specific charge
  • GET /leases/{leaseID}/recurring-charges/{chargeID} - Get a single recurring charge with computed status
  • POST /leases/{leaseID}/recurring-charges - Create a new recurring charge
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

The lease whose recurring charges to list.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Recurring Charge

Creates a new recurring charge on a lease. On success the endpoint internally forwards to GET /leases/{leaseID}/recurring-charges/{chargeID} and returns the full charge detail along with the previous charge on the lease.

Use Cases

  • Adding a new monthly rent charge to a lease
  • Setting up recurring fees (e.g. pet fees, parking) that begin on a future date
  • Creating a time-bounded charge that expires before the lease ends

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease must exist and be within the user's accessible portfolios; a 400 is returned otherwise
  • accountID must reference a valid chart-of-account entry of a charge type
  • startDate is the date the charge appears on reports such as the Rent Roll; accepted as MM/DD/YYYY
  • dayDue is the day of the month (1–31) on which recurring charge transactions are generated
  • frequency is the number of months between charge occurrences; defaults to 1 (monthly)
  • endDate is optional — leaving it blank causes the charge to continue until the lease reaches a Primary Closed Status
  • GET /leases/{leaseID}/recurring-charges - List all recurring charges for the lease
  • GET /leases/{leaseID}/recurring-charges/{chargeID} - Get a single recurring charge (same response shape returned here)
  • POST /leases/{leaseID}/recurring-charges/{chargeID} - Update an existing recurring charge
  • DELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete a recurring charge
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
Request Body schema: application/json
required
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 1 for monthly, 3 for quarterly, etc.

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 MM/DD/YYYY.

endDate
string or null

Date the charge stops being generated. Accepted format is MM/DD/YYYY. Leave blank (omit) to continue the charge until the lease reaches a Primary Closed Status.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 recurringStatusID.

Request samples

Content type
application/json
Example
{
  • "dayDue": 1,
  • "frequency": 1,
  • "accountID": "16",
  • "amount": "1500.00",
  • "description": "Monthly Rent",
  • "startDate": "04/20/2027",
  • "endDate": "04/12/2028"
}

Response samples

Content type
application/json
{
  • "recurringCharge": {
    },
  • "previousCharge": {
    }
}

Get Recurring Charge

Returns a single recurring charge with its computed recurringStatusID and the previous charge on the lease (if one exists).

Use Cases

  • Displaying full detail for a specific recurring charge
  • Checking whether a charge is currently active, future, or past
  • Reviewing the prior charge that this one superseded

Business Rules

  • The lease must be within the user's accessible portfolios; a 400 is returned otherwise
  • If the recurring charge does not belong to the specified lease, a 400 is returned
  • account is only included when includes=account is passed
  • GET /leases/{leaseID}/recurring-charges - List all recurring charges for the lease
  • POST /leases/{leaseID}/recurring-charges/{chargeID} - Update this recurring charge
  • DELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
chargeID
required
integer
Example: 11546

The leaseRecurringChargeID of the recurring charge to retrieve.

query Parameters
includes
string
Example: includes=account

Comma-separated list of related data to include in the response.

  • account - the full chart-of-accounts entry for the account this charge posts against

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object
required
object or null

The previous recurring charge on this lease (highest leaseRecurringChargeID below this one), or null if this is the first charge. Does not include recurringStatusID.

object (account-2)

The chart-of-accounts entry for this charge (if includes=account).

Response samples

Content type
application/json
{
  • "recurringCharge": {
    },
  • "previousCharge": null
}

Update Recurring Charge

Updates an existing recurring charge on a lease. Only include the fields you want to change — fields omitted from the request body retain their current values. Fields cannot be set to null via this endpoint.

On success the endpoint internally forwards to GET /leases/{leaseID}/recurring-charges/{chargeID} and returns the full charge detail along with the previous charge on the lease.

Use Cases

  • Adjusting the amount on an existing rent charge
  • Changing the end date of a time-bounded charge
  • Updating the chart-of-account a charge posts against

Business Rules

  • Requires Update Lease permission under the Leasing component
  • The lease and recurring charge must both exist; a 400 is returned if either is not found
  • Portfolio restrictions apply — users can only update charges on leases within their accessible portfolios
  • Fields cannot be explicitly set to null; omit a field to leave it unchanged
  • startDate and endDate are accepted as MM/DD/YYYY in the request
  • POST /leases/{leaseID}/recurring-charges - Create a new recurring charge (use this to get the chargeID)
  • GET /leases/{leaseID}/recurring-charges - List all recurring charges for the lease
  • DELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
chargeID
required
integer
Example: 12012

The leaseRecurringChargeID of the recurring charge to update. Obtain this from POST /leases/{leaseID}/recurring-charges or GET /leases/{leaseID}/recurring-charges.

Request Body schema: application/json
required
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 1 for monthly, 3 for quarterly, etc.

startDate
string

Date the charge begins appearing on reports such as the Rent Roll. Accepted format is MM/DD/YYYY.

endDate
string

Date the charge stops being generated. Accepted format is MM/DD/YYYY. To keep the charge open-ended, omit this field rather than sending null.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 recurringStatusID.

Request samples

Content type
application/json
Example
{
  • "amount": "120.00"
}

Response samples

Content type
application/json
{
  • "recurringCharge": {
    },
  • "previousCharge": {
    }
}

Delete Recurring Charge

Permanently deletes a recurring charge from a lease. On success, returns the deleted recurring charge record as it existed at time of deletion.

Use Cases

  • Removing a charge that was added in error
  • Deleting a charge whose schedule has been superseded by a new one

Business Rules

  • Requires Update Lease permission under the Leasing component
  • Portfolio restrictions apply — users can only delete recurring charges on leases within their accessible portfolios
  • The recurring charge must exist and belong to the specified lease; a 400 is returned if not found
  • This operation is permanent — use POST /leases/{leaseID}/recurring-charges/{chargeID} to set an endDate instead if you want to stop future postings while preserving history
  • GET /leases/{leaseID}/recurring-charges/{chargeID} - Get the charge detail before deleting
  • GET /leases/{leaseID}/recurring-charges - List all recurring charges for the lease
  • POST /leases/{leaseID}/recurring-charges/{chargeID} - Update the charge (e.g. set an end date)
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213
chargeID
required
integer
Example: 12012

The leaseRecurringChargeID of the recurring charge to delete.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 (1 = yes, 0 = no).

isFromImport
required
string
Enum: "0" "1"

Whether this charge was created via import (1 = yes, 0 = no).

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.

Response samples

Content type
application/json
{
  • "leaseRecurringChargeID": "12012",
  • "leaseID": "2213",
  • "rentIncreaseID": null,
  • "accountID": "16",
  • "amount": "120.00",
  • "description": "More Rent",
  • "dayDue": "1",
  • "frequency": "1",
  • "startDate": "2027-04-20",
  • "endDate": "2028-04-12",
  • "nextChargeDate": "2027-05-01",
  • "isMoveInCharge": "0",
  • "isFromImport": "0",
  • "importSourceKey": null
}

List Lease Pets

Lists the pets on one lease, sorted by name, one page at a time. Each item wraps the pet under pet, beside a token the search adds.

Use Cases

  • Show the animals living at a lease's unit
  • Find a lease's pet by part of its name before updating or removing it

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets a 403 Lease {leaseID}: Access Denied for a lease whose property is outside those groups' portfolios.
  • A well-formed leaseID with no lease answers 200 with an empty list (a restricted key gets the 403 above instead); a value that isn't a number answers the stock 404. leaseID 0 is the exception: for a key with no portfolio restrictions it isn't read as a filter, so it lists every pet on the account.
  • search matches any part of the pet's name (not its type); without it every pet of the lease is listed. The value is HTML-escaped before matching, so a name holding ', ", &, < or > can't be found, and % and _ act as wildcards.
  • Pets with the same name have no tie-breaker, so across pages they can repeat or be skipped.
  • Sorted by name, pets with no name first.
  • GET /leases/{leaseID}/pets/{leasePetID} - get one pet
  • POST /leases/{leaseID}/pets - add a pet to the lease
  • GET /leases/{leaseID} - the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 60

The lease, from GET /leases.

query Parameters
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). 0 or a value that isn't a number is read as 1. A negative page returns the first page's items, but the pagination headers count from the page asked for (page=-2 answers current page -2, next -1, previous -3).

pageSize
integer >= 1
Default: 15
Example: pageSize=15

Items per page (default 15). Values above 5000 are served at 5000. 0, a negative value or one that isn't a number fails with a 500.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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 0; a negative page is sent back as is)

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 1 (yes), 0 (no) or null (not answered).

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.

Response samples

Content type
application/json
[
  • {
    }
]

Add Lease Pet

Adds a pet to the lease and returns it as GET /leases/{leaseID}/pets/{leasePetID} does, including any includes the request asks for.

Use Cases

  • Record an animal a tenant brings to the unit
  • Note whether a pet is a service or emotional support animal

Business Rules

  • Requires the Update Lease permission (Leasing › UpdateLease); without it the request is refused with {"error": "Permission Denied"}.
  • A user restricted to portfolio groups gets a 403 Lease {leaseID}: Access Denied for a lease whose property is outside those groups' portfolios.
  • An empty body or {} answers 400 {"error": "invalid input."}.
  • type is required and can't be empty or only spaces ({"type": ["Type is required"]}). type, name, weight, color and gender take up to 100 characters, and age digits only; each failure is a message under its field, all of them in one response.
  • A well-formed leaseID with no lease answers 400 {"leaseID": ["Lease does not exist."]} (a restricted key gets a 403 Lease {leaseID}: Access Denied instead); a value that isn't a number answers the stock 404.

Side Effects

  • Adds a Pet Added entry, naming the pet's type and name, to the lease's history log.
  • Stamps the lease's modified date in GET /leases/export (its lease.dateTimeModified, which that export reports and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID} and the lease include send it, doesn't change.
  • GET /leases/{leaseID}/pets - list the lease's pets
  • POST /leases/{leaseID}/pets/{leasePetID} - update a pet
  • GET /leases - find the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 60

The lease to add the pet to, from GET /leases.

query Parameters
includes
string
Example: includes=lease

lease adds the pet's lease to the response, as on GET /leases/{leaseID}/pets/{leasePetID}. Any other name is ignored.

Request Body schema: application/json
required
non-empty
type
required
string [ 1 .. 100 ] characters

Kind of animal, free text (Dog, Cat). Required on a create; can't be empty or only spaces.

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 (3.5 and -1 are refused). The column holds 0 to 65535: a larger number passes validation, and what the database then does with it (store 65535, or refuse it as a 400) depends on its SQL mode, so keep to that range.

weight
string or null <= 100 characters

Weight, free text with its unit (45 lbs).

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: 2 is stored and sent back as "2". The column holds 0 to 255; a larger number is clamped or refused by the database, as for age.

isTrained
string 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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 1 (yes), 0 (no) or null (not answered).

object (included_lease)

The pet's lease, every column of the lease row. Sent only with the lease include.

Request samples

Content type
application/json
{
  • "type": "Dog",
  • "name": "Maple",
  • "age": 3,
  • "weight": "52 lbs",
  • "color": "Golden",
  • "gender": "Female",
  • "hasShots": 1,
  • "isTrained": 1,
  • "isNeutered": 1,
  • "isDeclawed": 0,
  • "isEmotionalSupportAnimal": 0,
  • "isServiceAnimal": 0
}

Response samples

Content type
application/json
{
  • "pet": {
    }
}

Get Lease Pet

Returns one of the lease's pets under pet, plus the lease under lease when the lease include is asked for.

Use Cases

  • Show a pet's details on the lease
  • Load a pet before editing it

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets a 403 Lease {leaseID}: Access Denied for a lease whose property is outside those groups' portfolios.
  • A well-formed leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet {leasePetID} not found"}; a value that isn't a number answers the stock 404.

Available Includes (1)

  • lease - the pet's lease, every column of the lease row
  • GET /leases/{leaseID}/pets - list the lease's pets
  • POST /leases/{leaseID}/pets/{leasePetID} - update the pet
  • DELETE /leases/{leaseID}/pets/{leasePetID} - remove the pet
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 60

The pet's lease, from GET /leases.

leasePetID
required
integer
Example: 66

The pet, from GET /leases/{leaseID}/pets.

query Parameters
includes
string
Example: includes=lease

lease adds the pet's lease. Any other name is ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 1 (yes), 0 (no) or null (not answered).

object (included_lease)

The pet's lease, every column of the lease row. Sent only with the lease include.

Response samples

Content type
application/json
{
  • "pet": {
    }
}

Update Lease Pet

Updates one of the lease's pets and returns it as GET /leases/{leaseID}/pets/{leasePetID} does, including any includes the request asks for. Only the keys sent are changed.

Use Cases

  • Correct a pet's details
  • Record that a pet's vaccinations are now current

Business Rules

  • Requires the Update Lease permission (Leasing › UpdateLease); without it the request is refused with {"error": "Permission Denied"}.
  • A user restricted to portfolio groups gets a 403 Lease {leaseID}: Access Denied for a lease whose property is outside those groups' portfolios.
  • An empty body or {} answers 400 {"error": "invalid input."}.
  • A body holding only keys the API doesn't read ({"extraKey": "x"}) is accepted: 200, nothing changes.
  • A well-formed leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet not found"} (without the ID, unlike the GET); a value that isn't a number answers the stock 404.
  • type can't be set to null, empty or only spaces ({"type": ["Type is required"]}). The other limits are those of POST /leases/{leaseID}/pets, each failure a message under its field.

Side Effects

  • When a field changes, adds a Pet Modified entry, listing the changes, to the lease's history log.
  • Stamps the lease's modified date in GET /leases/export (its lease.dateTimeModified, which that export reports and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID} and the lease include send it, doesn't change.
  • GET /leases/{leaseID}/pets/{leasePetID} - get the pet
  • DELETE /leases/{leaseID}/pets/{leasePetID} - remove the pet
  • POST /leases/{leaseID}/pets - add a pet
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 60

The pet's lease, from GET /leases.

leasePetID
required
integer
Example: 66

The pet, from GET /leases/{leaseID}/pets.

query Parameters
includes
string
Example: includes=lease

lease adds the pet's lease to the response. Any other name is ignored.

Request Body schema: application/json
required
non-empty
type
string [ 1 .. 100 ] characters

Kind of animal, free text (Dog, Cat). Required on a create; can't be empty or only spaces.

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 (3.5 and -1 are refused). The column holds 0 to 65535: a larger number passes validation, and what the database then does with it (store 65535, or refuse it as a 400) depends on its SQL mode, so keep to that range.

weight
string or null <= 100 characters

Weight, free text with its unit (45 lbs).

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: 2 is stored and sent back as "2". The column holds 0 to 255; a larger number is clamped or refused by the database, as for age.

isTrained
string 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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 1 (yes), 0 (no) or null (not answered).

object (included_lease)

The pet's lease, every column of the lease row. Sent only with the lease include.

Request samples

Content type
application/json
{
  • "weight": "48 lbs",
  • "isTrained": 0
}

Response samples

Content type
application/json
{
  • "pet": {
    }
}

Remove Lease Pet

Removes a pet from the lease for good and returns the removed pet as it was, without the pet wrapper the GET uses.

Use Cases

  • Remove an animal that no longer lives at the unit
  • Correct a pet added by mistake

Business Rules

  • Requires the Update Lease permission (Leasing › UpdateLease); without it the request is refused with {"error": "Permission Denied"}.
  • A user restricted to portfolio groups gets a 403 Lease {leaseID}: Access Denied for a lease whose property is outside those groups' portfolios.
  • A well-formed leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet {leasePetID} not found"}; a value that isn't a number answers the stock 404.

Side Effects

  • Deletes the pet's row; it no longer appears in GET /leases/{leaseID}/pets.
  • Deletes the pet's photo attachments; the photo files themselves are kept.
  • Adds a Pet Removed entry, naming the pet's type and name, to the lease's history log.
  • Stamps the lease's modified date in GET /leases/export (its lease.dateTimeModified, which that export reports and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID} and the lease include send it, doesn't change.
  • GET /leases/{leaseID}/pets - list the lease's remaining pets
  • POST /leases/{leaseID}/pets - add a pet
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 60

The pet's lease, from GET /leases.

leasePetID
required
integer
Example: 66

The pet to remove, from GET /leases/{leaseID}/pets.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 (Dog, Cat).

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 (45 lbs).

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: 1 yes, 0 no. Unlike the other flags, the API doesn't refuse another number on a write, so a pet saved with one (2) sends it back here.

isNeutered
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 YYYY-MM-DD HH:MM:SS.

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; null otherwise. The pet operations can't set it.

Response samples

Content type
application/json
{
  • "leasePetID": "110",
  • "leaseID": "99",
  • "type": "Dog",
  • "name": "Biscuit",
  • "age": "4",
  • "weight": "45 lbs",
  • "isTrained": "1",
  • "color": "Brown",
  • "hasShots": "1",
  • "isNeutered": "1",
  • "isDeclawed": "0",
  • "isEmotionalSupportAnimal": "0",
  • "isServiceAnimal": "1",
  • "gender": "Male",
  • "dateTimeCreated": "2026-11-12 07:38:07",
  • "petScreeningAnimalID": "88123"
}

Resident Packages

A lease's REP package enrollment (lease_resident_packages) — at most one per lease, located by leaseID. View it, or enroll/update via POST. The package catalog lives under Resident Experience.

Get Lease Resident Package

Returns the lease's single REP (Resident Experience Package) enrollment, joined to its catalog package. A lease has at most one package, so this is a singleton (not a list) located by leaseID — there is no enrollment id in the path.

Business Rules

  • The lease must be within the user's accessible portfolios; a 400/Access Denied is returned otherwise.
  • A lease that isn't enrolled returns 200 with both leaseResidentPackage and residentPackage set to null (not a 404).
  • POST /leases/{leaseID}/resident-package — enroll the lease, or update its enrollment
  • GET /leases/{leaseID}/resident-services — the lease's service entitlements
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
{
  • "leaseResidentPackage": {
    },
  • "residentPackage": {
    }
}

Create or Update Lease Resident Package

Creates or updates the lease's one package enrollment in a single call — located by leaseID, no enrollment id in the path. Not enrolled yet → enrolls the lease (opening the bundled recurring charge and snapshotting the package's services as member entitlements); already enrolled → updates the same row in place.

Status transitions (driven by leaseResidentPackageStatusID)

The enrollment is never deleted — it's turned off and back on via its status:

  • Enroll (no enrollment yet) → status defaults to Active; opens the bundled charge + member services.
  • Switch package (change residentPackageID on an active enrollment) → re-prices the same bundled charge to the new package and reconciles members: services in the new package are kept/added, services dropped from the old package are cancelled (converted to cancelled à la carte).
  • Cancel (leaseResidentPackageStatusID = 2) → stops the bundled recurring charge and cancels the member services.
  • Reactivate (leaseResidentPackageStatusID = 1 on a cancelled enrollment) → resumes the bundled charge and reactivates the members.

Business Rules

  • Requires the Update Lease permission under the Leasing component.
  • The lease must exist (400 otherwise) and be within the user's accessible portfolios.
  • residentPackageID is always required (even for a status-only change) and must reference an existing, active catalog package with at least one active service.
  • leaseResidentPackageStatusID is optional — omit it to leave the current status unchanged.
  • On success the endpoint forwards to GET /leases/{leaseID}/resident-package and returns that shape.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995
Request Body schema: application/json
required
residentPackageID
required
string or integer^-?[0-9]+$

The catalog package (resident_packages) to enroll the lease in. On an existing enrollment, changing this to a different package switches the lease to it (re-prices the bundled charge + reconciles members).

leaseResidentPackageStatusID
string or integer
Enum: "1" "2" 1 2

Enrollment status — 1 Active, 2 Cancelled. Omit to leave the current status unchanged. 2 cancels (stops the bundled charge + cancels members); 1 on a cancelled enrollment reactivates it. Defaults to Active on first enrollment.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
object

A lease's REP (Resident Experience Package) enrollment — a row in lease_resident_packages. A lease has at most one; it's never deleted, only turned off/back on via its status. leaseRecurringChargeID bridges to the resident's single bundled recurring charge.

object

A REP (Resident Experience Package) package — a PM-built bundle in resident_packages. A package groups services (see packageServices) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource).

Request samples

Content type
application/json
{
  • "residentPackageID": "1",
  • "leaseResidentPackageStatusID": "2"
}

Response samples

Content type
application/json
{
  • "leaseResidentPackage": {
    },
  • "residentPackage": {
    }
}

Resident Services

A lease's REP service entitlements (lease_resident_services) — the services active on a lease, each joined to its catalog service. The service catalog lives under Resident Experience.

List Lease Resident Services

Returns the lease's REP service entitlements (lease_resident_services), each joined to its catalog service. Includes both package-member entitlements (covered by the bundled package charge) and à la carte services (each with its own recurring charge). Not paginated — the full set is returned.

Business Rules

  • The lease must be within the user's accessible portfolios; a 400/Access Denied is returned otherwise.
  • POST /leases/{leaseID}/resident-services — add an à la carte service to the lease
  • GET /leases/{leaseID}/resident-services/{id} — a single entitlement
  • GET /leases/{leaseID}/resident-package — the lease's package enrollment
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (lease_resident_service)

A lease's REP service entitlement — a row in lease_resident_services. Either a package member (residentPackageID set, covered by the bundled charge) or à la carte (its own leaseRecurringChargeID). Never deleted, only turned off/back on via its status.

object (service)

A REP (Resident Experience Package) service definition — a per-account catalog entry in resident_services. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge.

Response samples

Content type
application/json
[
  • {
    }
]

Add À La Carte Service

Adds a single à la carte REP service to the lease (lease_resident_services) — a standalone service with its own recurring charge, separate from any package. This endpoint manages à la carte services only; services provided by the lease's package are managed through the package.

Business Rules

  • Requires the Update Lease permission under the Leasing component.
  • The lease must exist (404 otherwise) and be within the user's accessible portfolios.
  • residentServiceID must reference an active catalog service (resident_services).
  • A service the lease already gets through its package cannot be added à la carte — returns 400 ("provided by the lease's package… cannot be added separately"). Manage it through the package instead.
  • The service's own recurring charge is opened on create (starting the first of next month).
  • On success the endpoint forwards to GET /leases/{leaseID}/resident-services/{id} and returns that shape.
  • 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)
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995
Request Body schema: application/json
required
residentServiceID
required
string or integer^-?[0-9]+$

ID of the catalog service (resident_services) to add to the lease.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease_resident_service)

A lease's REP service entitlement — a row in lease_resident_services. Either a package member (residentPackageID set, covered by the bundled charge) or à la carte (its own leaseRecurringChargeID). Never deleted, only turned off/back on via its status.

required
object (service)

A REP (Resident Experience Package) service definition — a per-account catalog entry in resident_services. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge.

Request samples

Content type
application/json
{
  • "residentServiceID": "3"
}

Response samples

Content type
application/json
{
  • "leaseResidentService": {
    },
  • "residentService": {
    }
}

Get Lease Resident Service

Returns a single REP service entitlement on the lease (lease_resident_services), joined to its catalog service. Constrained to the lease — an entitlement id from another lease returns 404.

Business Rules

  • The lease must be within the user's accessible portfolios; a 400/Access Denied is returned otherwise.
  • 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
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995
id
required
integer
Example: 7

The lease resident service (entitlement) id.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease_resident_service)

A lease's REP service entitlement — a row in lease_resident_services. Either a package member (residentPackageID set, covered by the bundled charge) or à la carte (its own leaseRecurringChargeID). Never deleted, only turned off/back on via its status.

required
object (service)

A REP (Resident Experience Package) service definition — a per-account catalog entry in resident_services. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge.

Response samples

Content type
application/json
{
  • "leaseResidentService": {
    },
  • "residentService": {
    }
}

Update À La Carte Service

Updates an à la carte service entitlement. The only mutable field is its status — setting it to Cancelled turns the service off, setting it back to Active turns it on. The service reacts to the transition by adjusting the à la carte recurring charge.

Status transitions (leaseResidentServiceStatusID)

  • Cancel (2) → stops the service's recurring charge. A charge that has already started billing is end-dated as of today (history kept); a charge that hasn't started yet is deleted.
  • Reactivate (1) → resumes the charge (or mints a fresh one if the prior charge was deleted).

Business Rules

  • Requires the Update Lease permission under the Leasing component.
  • The lease must exist, and the entitlement must exist on that lease (404 otherwise).
  • A package-member entitlement (one carrying a residentPackageID) cannot be modified here — returns 400 ("part of a package and cannot be modified directly"). Manage it through the package.
  • On success the endpoint forwards to GET /leases/{leaseID}/resident-services/{id} and returns that shape.
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 995
id
required
integer
Example: 7

The lease resident service (entitlement) id.

Request Body schema: application/json
required
leaseResidentServiceStatusID
required
string or integer
Enum: "1" "2" 1 2

New status — 1 Active, 2 Cancelled.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (lease_resident_service)

A lease's REP service entitlement — a row in lease_resident_services. Either a package member (residentPackageID set, covered by the bundled charge) or à la carte (its own leaseRecurringChargeID). Never deleted, only turned off/back on via its status.

required
object (service)

A REP (Resident Experience Package) service definition — a per-account catalog entry in resident_services. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge.

Request samples

Content type
application/json
{
  • "leaseResidentServiceStatusID": "2"
}

Response samples

Content type
application/json
{
  • "leaseResidentService": {
    },
  • "residentService": {
    }
}

Work Orders

Create Work Order

Create a new work order. Requires the Manage Work Orders permission. On success, returns the full work order detail (same shape as GET /maintenance/work-orders/{workOrderID}).

Use Cases

  • Submit a new maintenance request for a property or unit
  • Create a work order from a template via workOrderTemplateID
  • Assign a vendor and send a vendor notification email in one step

Business Rules

  • Requires Manage Work Orders permission
  • propertyID is required; unitID and leaseID are optional
  • technicianContactIDs assigns one or more technician contacts to the work order
  • When sendVendorNotification is true and a vendor is assigned, a notification email is dispatched
  • workOrderTemplateID pre-populates fields from an existing template when supplied
  • Dates accept MM/DD/YYYY or ISO 8601 YYYY-MM-DD format
  • GET /maintenance/work-orders/{workOrderID} - Get the created work order
  • GET /maintenance/work-orders - List all work orders
  • POST /maintenance/work-orders/{workOrderID} - Update a work order
Authorizations:
basicAuth
Request Body schema: application/json
required
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]+$
  • 1 - Low
  • 2 - Medium
  • 3 - High
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

1 to share with the Resident Portal, 0 to hide

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

1 = internal (not shared with tenant or owner), 0 = standard

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. "500.00")

scheduledStartDate
string or null

Scheduled start date (MM/DD/YYYY or YYYY-MM-DD)

scheduledEndDate
string or null

Scheduled end date (MM/DD/YYYY or YYYY-MM-DD)

actualStartDate
string or null <date>
actualEndDate
string or null <date>
dateDue
string or null

Due date (MM/DD/YYYY or YYYY-MM-DD)

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]+$
  • 1 - Permission Required
  • 2 - Permission Not Required
  • 3 - Do Not Enter
appointmentWindowStartDateTime
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

appointmentWindowEndDateTime
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

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

1 when the tenant is responsible for the cost

sendVendorNotification
boolean
Default: true

Whether to send a notification email to the assigned vendor

sendEmail
boolean 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)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (work_order)
schedulingStatusID
required
integer or null

Request samples

Content type
application/json
Example
{
  • "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": [
    ],
  • "sendVendorNotification": true,
  • "vendorAccessTypeID": "1",
  • "attachments": [ ],
  • "issueImages": [ ]
}

Response samples

Content type
application/json
{
  • "workOrder": {
    },
  • "schedulingStatusID": 1
}

List Work Orders

Retrieve a paginated list of work orders with their assigned vendor contact. Supports filtering by property, unit, status, vendor, date range, and more.

Use Cases

  • Filter open work orders by property or unit
  • Find work orders assigned to a specific vendor
  • Show newly submitted (unacknowledged) work orders
  • Review work orders within a specific date range

Business Rules

  • Results are scoped to the authenticated user's accessible portfolios
  • Default page size is 15
  • GET /maintenance/work-orders/{workOrderID} - Get full work order details with includes
  • POST /maintenance/work-orders - Create a work order
  • GET /maintenance/work-order/statuses - Get available work order statuses
Authorizations:
basicAuth
query Parameters
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 (0 = pending, 1 = approved)

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 (YYYY-MM-DD)

endDate
string <date>
Example: endDate=2024-12-31

Filter work orders created on or before this date (YYYY-MM-DD)

leaseID
integer
Example: leaseID=1500

Filter by associated lease ID

isNew
integer
Enum: 0 1
Example: isNew=1

Filter to only unacknowledged (1) or acknowledged (0) work orders

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (work_order)
required
contact (object) or null

Vendor contact assigned to the work order. All fields are null when no vendor is assigned.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Search Work Orders

Returns a filtered page of work orders, each row denormalized: the workOrder (with its days open and overdue, the amounts billed and paid on its bills, its image counts and its technicians), its workOrderStatus, workOrderType, portfolio, property and unit, its vendorContact and requestedByContact, its vendorTrade and its propertyGroup names.

Unlike GET /maintenance/work-orders, it filters on when a work order last changed (dateTimeModifiedMin, dateTimeModifiedMax), which is how an integration pulls only the work orders that changed since its last sync.

This reference covers paging, sorting, the modified-date filters and the filters documented below, which GET /maintenance/work-orders also takes. The endpoint reads more filters and an include that aren't documented here yet.

Use Cases

  • Pull the work orders that changed since the last sync: note the time the sync starts, send the UTC date the previous sync started as dateTimeModifiedMin (YYYY-MM-DD), sort by workOrder.dateTimeModified|desc, and ask for page 1, 2, 3 and so on until a page comes back with fewer rows than pageSize. Keep each work order once, by workOrderID, then store the start time for the next sync.
  • Power a work order list with property, unit, vendor and status context, no extra lookups
  • Find a property's, unit's, lease's or vendor's work orders, or the new or owner-approved ones

Business Rules

  • Requires only authentication; no permission is checked.
  • With the parameters documented here, a user restricted to portfolio groups only gets work orders whose portfolio is in those groups (a filtered 200, never a 403).
  • Saving a work order sets its dateTimeModified to the current UTC time. Changes stored in other records don't, although this search returns their values: a bill on the work order changes amountBilled and a rename of its vendor changes vendorContact.name while dateTimeModified stays put, and the same goes for the joined property, unit, requester, status, type and trade records and the image counts. A sync keyed on dateTimeModified misses those until the work order itself is next saved.
  • Paging is by offset, and each request moves on by one page, so a sync that pages until a short page ends however many work orders share one dateTimeModified. Sorted by workOrder.dateTimeModified|desc, a work order saved while you page moves to the front, ahead of the rows you haven't read: the rows behind it shift back, so you may read one twice but never skip one, and the saved work order comes back in the next sync, whose dateTimeModifiedMin covers the time it was saved. Sorted any other way, a save can move a row you've read behind you and push one you haven't across a page boundary, where you skip it. A work order deleted while you page shifts the rows behind it forward and can do the same.
  • dateTimeModifiedMin and dateTimeModifiedMax take a date (YYYY-MM-DD), read as midnight UTC. A sync bounded by the date of its last run gets back the work orders changed earlier that day too; keep each once by workOrderID.
  • Filters combine: a work order must match every one sent.
  • workOrderStatusID, startDate and endDate, which GET /maintenance/work-orders takes, aren't read here: sent to this endpoint they're ignored and the list isn't filtered by them.
  • A filter value the API can't read is ignored rather than refused: the request still answers 200, unfiltered by that value (a boolean other than 1/0/true/false/yes/no in any letter case, an ID that isn't a number).
  • The page size defaults to 25 and has no cap today. A cap is planned, so don't build a sync on one large page. When some work orders match, pagination-page-size reports the page size or the number that match, whichever is smaller. A pageSize of 0 or below, or one with no digit in it, is read as 15.
  • When nothing matches, or the page is past the last one, the body is an empty array; when nothing matches, pagination-total-items is 0.
  • page and pageSize keep only their digits: 10abc is read as 10, 3.4 as 34 and 1e2 as 12. Send whole numbers.
  • Sorted by orderBy (default workOrder.dateTimeCreated|desc, newest first), then workOrderID ascending.
  • The joined objects are always present. When a work order has no unit, type, vendor, requester or trade, or the record it points to no longer exists, that object comes back with every key null.
  • A modified-date filter sent as a list (dateTimeModifiedMin[]=2026-01-01) fails with a 500.
  • GET /maintenance/work-orders - the plain work order list, without the modified-date filters
  • GET /maintenance/work-orders/{workOrderID} - one work order, with includes
  • GET /properties - property IDs for propertyID
  • GET /leases - lease IDs for leaseID
  • GET /vendors - vendor contact IDs for vendorContactID
Authorizations:
basicAuth
query Parameters
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. 0, a negative value or a value with no digit in it is read as 15; any other character is dropped (10abc is 10, 3.4 is 34).

orderBy
string
Example: orderBy=workOrder.dateTimeModified|desc

Sort column, optionally followed by |asc or |desc (any letter case); anything else after the |, or nothing, sorts ascending. Several are separated by commas. Each must be one of the columns below. workOrderID always breaks ties, ascending.

Columns: workOrder.dateTimeCreated (the default, desc), workOrder.dateTimeModified, workOrder.workOrderNumber, workOrder.workOrderStatusID, workOrder.vendorWorkOrderStatusID, workOrder.portalVendorWorkOrderStatusID, workOrder.isOwnerApproved, workOrder.description, workOrder.dateClosed, workOrder.daysOpen, workOrder.daysOverdue, workOrder.daysOverdueVendor, workOrder.priorityID, workOrder.workOrderTypeID, workOrder.orderIndex, workOrder.scheduledStartDate, workOrder.actualStartDate, workOrder.scheduledEndDate, workOrder.actualEndDate, workOrder.dateDue, workOrder.isSharedWithTenant, workOrder.isSharedWithOwner, workOrder.isNew, workOrder.appointmentWindowStartDateTime, workOrder.appointmentWindowEndDateTime (both sort by the work order's own window, so an internal work order, which returns its technicians' window, can sort out of step with the value it returns), workOrder.isInternal, workOrder.incidentLocation, workOrder.isResolvedByRequestor, workOrder.assignedToUserName (first name, then last name; a System User - <id> name sorts with the unassigned rows), workOrderStatus.name, workOrderType.name, portfolio.name, property.property (street name, street number, address 2, city, state), property.name, property.address, property.address2, property.city, property.postalCode, unit.unit (street name, street number, address 2, city, state), unit.name, unit.address, unit.address2, unit.city, unit.postalCode, vendorContact.name, smartActions.dateTimeCreated (the newest pending smart action, a value this response doesn't return).

dateTimeModifiedMin
string <date>
Example: dateTimeModifiedMin=2026-01-01

Only work orders last modified on or after midnight UTC of this date (YYYY-MM-DD).

dateTimeModifiedMax
string <date>
Example: dateTimeModifiedMax=2026-01-31

Only work orders last modified on or before midnight UTC of this date (YYYY-MM-DD), so it leaves out the rest of that day.

search
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 GET /properties).

unitID
integer
Example: unitID=15

Only this unit's work orders (unit IDs from GET /properties/{propertyID}/units).

leaseID
integer
Example: leaseID=9

Only the work orders linked to this lease (from GET /leases).

vendorContactID
integer
Example: vendorContactID=18

Only the work orders assigned to this vendor (from GET /vendors).

isOwnerApproved
string
Example: isOwnerApproved=1

1 (or true, yes, in any letter case) only owner-approved work orders, 0 (or false, no) only those not approved; omitted returns both.

isNew
string
Example: isNew=1

1 (or true, yes, in any letter case) only work orders flagged new, 0 (or false, no) only those not; omitted returns both. A work order is flagged new when it is created and again when it is assigned to a different vendor.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

When some work orders match, the requested pageSize (default 25) or the number that match, whichever is smaller

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 page below 1 is read as 1)

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 null for an older work order with no type.

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 null when the work order is for the whole property.

required
object (work_order_search_contact)

A contact on a work order search row, its vendor (vendorContact) or the person who asked for the work (requestedByContact). Every key is null when the work order has none.

required
object (work_order_search_contact)

A contact on a work order search row, its vendor (vendorContact) or the person who asked for the work (requestedByContact). Every key is null when the work order has none.

required
object

The work order's vendor trade (maintenance category). Every key is null when it has none.

required
object

The property groups the work order's property is in.

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Work Order

Retrieve detailed information about a specific work order by ID, including computed overdue status and assigned technician data.

Use Cases

  • View complete work order details
  • Check work order status and progress
  • Review assigned technicians and scheduling status

Business Rules

  • Returns 400 with "Work Order {id} not found" if the work order does not exist
  • Access is verified against portfolio restrictions; unauthorized requests receive 403 "Work Order Access Not Allowed"
  • daysOverdue and isOverdue are calculated dynamically from dateDue and today's date
  • GET /maintenance/work-orders - List work orders
  • POST /maintenance/work-orders/{workOrderID} - Update work order
  • DELETE /maintenance/work-orders/{workOrderID} - Delete work order
  • GET /maintenance/work-orders/{workOrderID}/print - Print work order PDF
Authorizations:
basicAuth
path Parameters
workOrderID
required
integer
Example: 2314

The unique work order ID

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object
schedulingStatusID
required
integer or null

Response samples

Content type
application/json
{
  • "workOrder": {
    },
  • "schedulingStatusID": 1
}

Update Work Order

Update an existing work order. Supports updating all work order fields including status, assignment, scheduling, and shared visibility settings.

Use Cases

  • Update work order status
  • Assign/reassign vendor
  • Change priority level
  • Update schedule dates
  • Modify description and instructions
  • Change owner/tenant visibility
  • Set appointment windows

Business Rules

  • Access controlled by portfolio restrictions
  • Changing status may trigger notifications
  • Owner approval may be required for certain changes
  • Vendor assignment triggers vendor notification (if sendVendorNotification=true)
  • Status changes to completed status can trigger review requests
  • Requires Manage Work Orders permission

Workflow Changes

  • Status Updates - May trigger workflow automations
  • Owner Sharing - Controls visibility in owner portal
  • Tenant Sharing - Controls visibility in resident portal
  • GET /maintenance/work-orders/{workOrderID} - View work order
  • DELETE /maintenance/work-orders/{workOrderID} - Delete work order
Authorizations:
basicAuth
path Parameters
workOrderID
required
integer
Example: 12345

The unique work order ID to update

Request Body schema: application/json
required
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 YYYY-MM-DD HH:MM:SS.

appointmentWindowEndDateTime
string or null

Appointment window end. UTC, formatted YYYY-MM-DD HH:MM:SS.

sendVendorNotification
boolean
Default: true

Send notification to vendor on changes

sendReview
boolean
Default: false

Send review request on completion

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
workOrder
object

Updated work order details (same structure as GET response)

Request samples

Content type
application/json
Example
{
  • "workOrderStatusID": 2,
  • "sendVendorNotification": false
}

Response samples

Content type
application/json
{
  • "workOrder": {
    }
}

Delete Work Order

Delete a work order. This operation removes the work order and all associated data including attachments, messages, and timeline events.

Use Cases

  • Remove duplicate work orders
  • Delete cancelled work orders
  • Clean up test/invalid work orders

Business Rules

  • Access controlled by portfolio restrictions
  • Cannot delete if associated bills exist
  • Deletes all attachments and messages
  • Requires Manage Work Orders permission

Data Cleanup

  • Removes work order record
  • Deletes file attachments
  • Removes work order messages
  • Removes from projects
  • GET /maintenance/work-orders/{workOrderID} - View work order
  • GET /maintenance/work-orders - View work orders
Authorizations:
basicAuth
path Parameters
workOrderID
required
string
Example: 12345

The unique work order ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
workOrderID
string^-?[0-9]+$
workOrderNumber
string^-?[0-9]+$
description
string
dateTimeCreated
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "workOrderID": "12345",
  • "workOrderNumber": "WO-2024-12345",
  • "description": "Kitchen sink is leaking under the cabinet",
  • "dateTimeCreated": "2024-10-23 08:30:00",
  • "dateTimeModified": "2024-10-23 09:15:00"
}

Print Work Order PDF

Generate and download a PDF version of the specified work order. The response is a binary PDF document suitable for printing or archiving.

Use Cases

  • Print a work order to hand to a technician or vendor
  • Archive a completed work order as a PDF
  • Attach a work order PDF to an email or document management system

Business Rules

  • Returns 400 with "Work Order not found" if the work order does not exist
  • Access is verified against portfolio restrictions; unauthorized requests are rejected
  • GET /maintenance/work-orders/{workOrderID} - Get work order details as JSON
Authorizations:
basicAuth
path Parameters
workOrderID
required
integer
Example: 2314

The unique work order ID to print

Responses

Response Headers
Cache-Control
string
Example: "no-cache"

Cache directive (always no-cache)

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "error": "Work Order not found"
}

Work Order Statuses

Create

Authorizations:
basicAuth
Request Body schema: application/json
primaryWorkOrderStatusID
required
string or integer (primary_statuses_request)
Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
  • 5 - Cancelled
name
required
string

The name of the status

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
primaryWorkOrderStatusID
required
string or integer (primary_statuses_request)
Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
  • 5 - Cancelled
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 (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected). Statuses created by user will not be a system status.

orderIndex
string^-?[0-9]+$

Request samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": "1",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": "1",
  • "name": "string",
  • "workOrderStatusID": "string",
  • "isSystemStatus": "0",
  • "orderIndex": "string"
}

List Work Order Statuses

Retrieve all work order statuses available in the account, including both system statuses and any custom statuses created by the account.

Use Cases

  • Display a list of available statuses in a settings page

Business Rules

  • Returns both system statuses (isSystemStatus = 1) and custom account statuses (isSystemStatus = 0)
  • System statuses cannot be renamed or deleted, only custom statuses can be managed
  • The 7 built-in system statuses are: Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected
  • GET /maintenance/work-order/statuses/{workOrderStatusID} - Get a specific status by ID
  • POST /maintenance/work-order/statuses - Create or update a custom status
Authorizations:
basicAuth
query Parameters
search
string
Example: search=open

Free-text search on status name

isSystemStatus
integer
Enum: 0 1
Example: isSystemStatus=1

Filter to system statuses only (1) or custom statuses only (0)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (work_order_status)

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Work Order Status

Retrieve a single work order status by its ID. Returns both system statuses and custom account statuses.

Use Cases

  • Look up the name and primary status group for a specific status ID
  • Validate that a status ID exists before assigning it to a work order
  • Check whether a given status is a system status or a custom one

Business Rules

  • Returns 400 with "Work Order Status {id} not found" if the status does not exist
  • Both system statuses and custom account statuses are accessible by ID
  • GET /maintenance/work-order/statuses - List all work order statuses
  • POST /maintenance/work-order/statuses/{workOrderStatusID} - Update a custom status
  • DELETE /maintenance/work-order/statuses/{workOrderStatusID} - Delete a custom status
Authorizations:
basicAuth
path Parameters
workOrderStatusID
required
integer
Example: 5

The unique work order status ID

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (work_order_status)

Response samples

Content type
application/json
Example
{
  • "workOrderStatus": {
    }
}

Delete Work Order Status

Delete a custom work order status. Only custom statuses (those with isSystemStatus = 0) can be deleted; system statuses are protected.

Use Cases

  • Remove an outdated or duplicate custom status
  • Clean up statuses that are no longer used in the account's workflow

Business Rules

  • Requires Manage Work Order Statuses permission
  • Returns 400 with "Work Order Status {id} not found" if the status does not exist
  • System statuses (isSystemStatus = 1) cannot be deleted via this endpoint
  • Any work orders that currently have this status may need to be reassigned manually
  • GET /maintenance/work-order/statuses - List all statuses
  • GET /maintenance/work-order/statuses/{workOrderStatusID} - Get a status by ID
Authorizations:
basicAuth
path Parameters
workOrderStatusID
required
integer
Example: 9

The unique work order status ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
workOrderStatusID
required
string^-?[0-9]+$
primaryWorkOrderStatusID
required
string^-?[0-9]+$
isSystemStatus
required
string
Enum: "0" "1"
name
required
string
orderIndex
required
string^-?[0-9]+$

Response samples

Content type
application/json
{
  • "workOrderStatusID": "9",
  • "primaryWorkOrderStatusID": "2",
  • "isSystemStatus": "0",
  • "name": "Tech Completed",
  • "orderIndex": "1"
}

Update Work Order Status

Update an existing custom work order status by ID.

Use Cases

  • Rename a custom status

Business Rules

  • Requires Manage Work Order Statuses permission
  • Returns 400 with "Work Order Status {id} not found" if the status does not exist
  • On success, forwards to the GET detail endpoint and returns the updated status wrapped in workOrderStatus
  • primaryWorkOrderStatusID cannot be modified
  • GET /maintenance/work-order/statuses/{workOrderStatusID} - Get status by ID
  • DELETE /maintenance/work-order/statuses/{workOrderStatusID} - Delete a custom status
  • GET /maintenance/work-order/statuses - List all statuses
Authorizations:
basicAuth
path Parameters
workOrderStatusID
required
integer
Example: 9

The unique work order status ID to update

Request Body schema: application/json
required
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.

  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
  • 5 - Cancelled

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (work_order_status)

Request samples

Content type
application/json
{
  • "name": "Tech Completed",
  • "primaryWorkOrderStatusID": 2
}

Response samples

Content type
application/json
{
  • "workOrderStatus": {
    }
}

Vendor Trades

Create

Authorizations:
basicAuth
Request Body schema: application/json
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
{
  • "name": "string",
  • "isVisibleTenantPortal": "0"
}

Response samples

Content type
application/json
{
  • "vendorTradeID": "string",
  • "name": "string",
  • "isVisibleTenantPortal": "0"
}

List

List vendor trades

Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

Get Vendor Trade

Retrieve a single vendor trade (maintenance category) by ID.

Use Cases

  • Fetch the list of vendors associated with a trade via the vendors include

Available Includes (1)

  • vendors - Contacts assigned to this vendor trade (each with their contact)
  • GET /maintenance/vendor-trades - List all vendor trades
  • POST /maintenance/vendor-trades/{vendorTradeID} - Update a vendor trade
Authorizations:
basicAuth
path Parameters
vendorTradeID
required
integer
Example: 5

The unique vendor trade ID

query Parameters
includes
string
Example: includes=vendors

Comma-separated list of related objects. Available values: vendors.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (vendor_trade)
vendors
Array of objects

Vendor contacts assigned to this trade (if includes=vendors). Each item includes the contact sub-object.

Response samples

Content type
application/json
{
  • "vendorTrade": {
    }
}

Update Vendor Trade

Update an existing vendor trade (maintenance category). Requires the ManageMaintenanceCategories permission.

Use Cases

  • Rename a vendor trade
  • Toggle resident portal visibility for a trade

Business Rules

  • Requires Manage Maintenance Categories permission
  • Returns 400 with "Maintenance Category {id} not found" if the trade does not exist
  • On success, forwards to the GET detail endpoint and returns the updated trade wrapped in vendorTrade
  • GET /maintenance/vendor-trades/{vendorTradeID} - Get vendor trade details
  • DELETE /maintenance/vendor-trades/{vendorTradeID} - Delete a vendor trade
  • GET /maintenance/vendor-trades - List all vendor trades
Authorizations:
basicAuth
path Parameters
vendorTradeID
required
integer
Example: 5

The unique vendor trade ID to update

Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (vendor_trade)

Request samples

Content type
application/json
{
  • "name": "Plumbing",
  • "isVisibleTenantPortal": "1"
}

Response samples

Content type
application/json
{
  • "vendorTrade": {
    }
}

Inspections

Create

Authorizations:
basicAuth
Request Body schema: application/json
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
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
string or integer (inspection_statuses_request)
Enum: "1" "2" "3" "4" 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
description
string or null
scheduledDate
string or null <date>
inspectionDate
string or null <date>

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
string or integer (inspection_statuses_request)
Enum: "1" "2" "3" "4" 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
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>

Request samples

Content type
application/json
{
  • "unitID": "string",
  • "inspectionTypeID": "1",
  • "inspectionStatusID": "1",
  • "description": "string",
  • "scheduledDate": "2019-08-24",
  • "inspectionDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "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

List of inspections

Authorizations:
basicAuth
query Parameters
page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 15

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
string or integer (inspection_statuses_request)
Enum: "1" "2" "3" "4" 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
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>

Response samples

Content type
application/json
[
  • {
    }
]

View

View inspection

Authorizations:
basicAuth
path Parameters
inspectionID
required
integer

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
string or integer (inspection_statuses_request)
Enum: "1" "2" "3" "4" 1 2 3 4
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
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>

Response samples

Content type
application/json
{
  • "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"
}

Materials

List Materials

Returns a paginated list of inventory materials available for use on work orders.

Use Cases

  • Search for a specific material by name, description, or UPC

Business Rules

  • search matches against name, description, and upc fields
  • isActive defaults to all active materials when omitted
  • GET /maintenance/materials/{materialID} — retrieve a single material with file detail
  • POST /maintenance/materials — create a new material
  • POST /maintenance/materials/{materialID} — update an existing material
  • DELETE /maintenance/materials/{materialID} — delete a material
Authorizations:
basicAuth
query Parameters
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. 1 = active, 0 = inactive

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 - for descending order. Available values: material.name, material.description, material.isActive, material.upc, material.purchasePrice, material.sellPrice

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (material)

Fields accepted when creating or updating a maintenance material (inventory item). Only name and sellPrice are required on create; all other fields are optional. For updates, send only the fields being changed.

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Create Material

Creates a new maintenance material in the inventory catalog. On success, returns the full material detail (same shape as GET /maintenance/materials/{materialID}).

Use Cases

  • Add a new item to the materials catalog for use on work orders
  • Import materials from an external catalog by name and price

Business Rules

  • name and sellPrice are the only required fields
  • isActive defaults to 1 (active) when not supplied
  • name must be unique among non-deleted materials (max 200 characters)
  • purchasePrice and sellPrice must be valid decimal amounts
  • GET /maintenance/materials — list all materials
  • GET /maintenance/materials/{materialID} — retrieve the created material
  • POST /maintenance/materials/{materialID} — update an existing material
Authorizations:
basicAuth
Request Body schema: application/json
required
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. 1 = active, 0 = inactive

upc
string or null

Universal Product Code

purchasePrice
string or number or null <decimal>

Cost to purchase the material (decimal as string)

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (material)

Fields accepted when creating or updating a maintenance material (inventory item). Only name and sellPrice are required on create; all other fields are optional. For updates, send only the fields being changed.

Request samples

Content type
application/json
Example
{
  • "name": "New Item Name",
  • "sellPrice": "12.00"
}

Response samples

Content type
application/json
{
  • "material": {
    }
}

Get Material

Retrieves a single maintenance material by ID

Use Cases

  • Display full material detail in a management UI
  • Verify material data after creation or update

Business Rules

  • Returns 400 with "Material {id} not found" if the material does not exist or has been deleted
  • GET /maintenance/materials — list all materials
  • POST /maintenance/materials/{materialID} — update this material
  • DELETE /maintenance/materials/{materialID} — delete this material
Authorizations:
basicAuth
path Parameters
materialID
required
integer
Example: 8

The unique material ID

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (material)

Fields accepted when creating or updating a maintenance material (inventory item). Only name and sellPrice are required on create; all other fields are optional. For updates, send only the fields being changed.

required
object

Image file associated with the material, if any

Response samples

Content type
application/json
{
  • "material": {
    },
  • "file": {
    }
}

Update Material

Updates an existing maintenance material. Only send the fields you want to change — omitted fields are left unchanged. On success, returns the full updated material detail.

Use Cases

  • Adjust the sell price of a material after a supplier price change
  • Update the description or UPC of an existing item

Business Rules

  • Returns 400 with "Material {id} not found" if the material does not exist
  • name must remain unique among non-deleted materials if changed
  • purchasePrice and sellPrice must be valid decimal amounts when supplied
  • GET /maintenance/materials/{materialID} — retrieve current material state
  • GET /maintenance/materials — list all materials
  • DELETE /maintenance/materials/{materialID} — delete this material
Authorizations:
basicAuth
path Parameters
materialID
required
integer
Example: 13

The unique material ID

Request Body schema: application/json
required
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. 1 = active, 0 = inactive

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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object (material)

Fields accepted when creating or updating a maintenance material (inventory item). Only name and sellPrice are required on create; all other fields are optional. For updates, send only the fields being changed.

Request samples

Content type
application/json
Example
{
  • "sellPrice": "10.00"
}

Response samples

Content type
application/json
{
  • "material": {
    }
}

Delete Material

Deletes a maintenance material by setting isDeleted = 1. The record is retained in the database and the response includes the final state of the material.

Use Cases

  • Remove a discontinued item from the active material catalog
  • Clean up test or duplicate materials

Business Rules

  • Returns 400 with "Material {id} not found" if the material does not exist\
  • Deleted materials no longer appear in GET /maintenance/materials list results
  • Deletion is a permanent delete: the record is removed from the database
  • GET /maintenance/materials — list active materials
  • POST /maintenance/materials — create a replacement material
Authorizations:
basicAuth
path Parameters
materialID
required
integer
Example: 13

The unique material ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 1 in this response, sent as the JSON integer 1: the delete sets it in memory and the response is built from the model without re-reading it. Every other material response, including POST /maintenance/materials, sends it as the string '0' or '1'.

dateTimeCreated
required
string

Timestamp when the material was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Timestamp of the delete operation. UTC, formatted YYYY-MM-DD HH:MM:SS.

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

Response samples

Content type
application/json
{
  • "materialID": "13",
  • "name": "New Item Name",
  • "description": null,
  • "isActive": "1",
  • "upc": null,
  • "purchasePrice": null,
  • "sellPrice": "10.00",
  • "imageFileID": null,
  • "dateTimeCreated": "2026-04-24 22:41:08",
  • "dateTimeModified": "2026-04-24 22:46:20",
  • "isDeleted": 1
}

Labor Rates

List Labor Rates

Returns a paginated list of maintenance labor rates. Supports full-text search and rate-range filtering. Results exclude soft-deleted records by default.

Use Cases

  • Search for a specific rate by name

Business Rules

  • search matches against the name field
  • GET /maintenance/labor-rates/{laborRateID} — retrieve a single labor rate
  • POST /maintenance/labor-rates — create a new labor rate
  • POST /maintenance/labor-rates/{laborRateID} — update an existing labor rate
  • DELETE /maintenance/labor-rates/{laborRateID} — delete a labor rate
Authorizations:
basicAuth
query Parameters
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 0 (active only). Pass 1 to include deleted records.

orderBy
string
Example: orderBy=laborRate.name

Sort field in dot-notation. Prefix with - for descending order. Available values: laborRate.name, laborRate.rate, laborRate.hourlyRate

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object (labor_rate)

Fields accepted when creating or updating a maintenance labor rate. name and rate are required; all other fields are optional. For updates, send only the fields being changed.

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

Create Labor Rate

Creates a new maintenance labor rate. On success, returns the created labor rate as a flat object.

Use Cases

  • Add a new labor rate to the catalog for use on work order line items

Business Rules

  • name, rate, and hourlyRate are required; description is optional
  • name must be unique among non-deleted labor rates
  • rate and hourlyRate must be non-negative decimal amounts; zero is allowed
  • GET /maintenance/labor-rates — list all labor rates
  • GET /maintenance/labor-rates/{laborRateID} — retrieve the created labor rate
  • POST /maintenance/labor-rates/{laborRateID} — update an existing labor rate
Authorizations:
basicAuth
Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Timestamp when the labor rate was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

description
string or null

Optional description of the labor rate

isDeleted
string
Enum: "0" "1"

Makes the labor rate Non-Billable

Request samples

Content type
application/json
Example
{
  • "name": "New Labor Item",
  • "rate": "5.00"
}

Response samples

Content type
application/json
{
  • "laborRateID": "8",
  • "name": "New Labor Item",
  • "description": null,
  • "rate": "5.00",
  • "hourlyRate": "10.00",
  • "isDeleted": "0",
  • "dateTimeCreated": "2026-04-24 23:04:24",
  • "dateTimeModified": "2026-04-24 23:04:24"
}

Get Labor Rate

Retrieves a single maintenance labor rate by ID. Returns a flat object (no wrapper key).

Use Cases

  • Display full labor rate detail in a management UI
  • Verify labor rate data after creation or update

Business Rules

  • Returns 400 with "Labor Rate {id} not found" if the labor rate does not exist
  • GET /maintenance/labor-rates — list all labor rates
  • POST /maintenance/labor-rates/{laborRateID} — update this labor rate
  • DELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate
Authorizations:
basicAuth
path Parameters
laborRateID
required
integer
Example: 7

The unique labor rate ID

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Timestamp when the labor rate was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

description
string or null

Optional description of the labor rate

isDeleted
string
Enum: "0" "1"

Makes the labor rate Non-Billable

Response samples

Content type
application/json
{
  • "laborRateID": "7",
  • "name": "Jake Internal Maintenance Tech",
  • "description": "Test",
  • "rate": "25.00",
  • "hourlyRate": "20.00",
  • "isDeleted": "0",
  • "dateTimeCreated": "2026-02-27 16:18:41",
  • "dateTimeModified": "2026-02-27 16:18:41"
}

Update Labor Rate

Updates an existing maintenance labor rate. Only send the fields you want to change — omitted fields are left unchanged. Returns the updated labor rate as a flat object.

Use Cases

  • Adjust the rate for a labor type after a cost review
  • Update the name or description of an existing rate
  • Set the hourly rate on a labor item that previously had none

Business Rules

  • Returns 400 with "Labor Rate {id} not found" if the labor rate does not exist
  • name must remain unique among non-deleted labor rates if changed
  • rate and hourlyRate must be non-negative decimal amounts when supplied; zero is allowed
  • laborRateID, dateTimeCreated, and dateTimeModified in the request body are accepted but ignored
  • GET /maintenance/labor-rates/{laborRateID} — retrieve current labor rate state
  • GET /maintenance/labor-rates — list all labor rates
  • DELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate
Authorizations:
basicAuth
path Parameters
laborRateID
required
integer
Example: 7

The unique labor rate ID

Request Body schema: application/json
required
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Timestamp when the labor rate was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

description
string or null

Optional description of the labor rate

isDeleted
string
Enum: "0" "1"

Makes the labor rate Non-Billable

Request samples

Content type
application/json
Example
{
  • "rate": "0.00"
}

Response samples

Content type
application/json
{
  • "laborRateID": "7",
  • "name": "Jake Internal Maintenance Tech",
  • "description": "Test",
  • "rate": "0.00",
  • "hourlyRate": "20.00",
  • "isDeleted": "0",
  • "dateTimeCreated": "2026-02-27 16:18:41",
  • "dateTimeModified": "2026-02-27 16:18:41"
}

Delete Labor Rate

Deletes a labor rate from the catalog. The record is removed from the database. Returns a success confirmation.

Use Cases

  • Remove a discontinued labor rate from the active catalog
  • Clean up duplicate or test labor rates

Business Rules

  • Returns 400 with "Labor Rate {id} not found" if the labor rate does not exist
  • Deleted labor rates no longer appear in GET /maintenance/labor-rates by default
  • GET /maintenance/labor-rates — list active labor rates
  • POST /maintenance/labor-rates — create a replacement labor rate
Authorizations:
basicAuth
path Parameters
laborRateID
required
integer
Example: 7

The unique labor rate ID to delete

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
success
required
boolean

Always true on successful deletion

message
required
string or null

Confirmation message

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Labor rate deleted successfully"
}

Portfolios

List Portfolios

Returns a paginated list of portfolios with their associated statement settings. Each result item wraps the portfolio and its statement setting in keyed properties. Use /portfolios/search for advanced filtering by reserve amount, hold distributions, tags, portfolio groups, and assigned users.

Use Cases

  • Display a paginated list of all portfolios in the account
  • Filter to active or inactive portfolios
  • Filter to portfolios that send statements
  • Exclude a specific portfolio from results (e.g., for a reassignment UI)

Business Rules

  • Results are scoped to the authenticated account; cross-account data is never returned
  • Portfolio access is restricted based on the user's portfolio group assignments
  • isActive defaults to 1 — only active portfolios are returned unless explicitly set to 0
  • GET /portfolios/search - Advanced filtered search with denormalized columns and additional filters
  • GET /portfolios/{portfolioID} - Full portfolio detail with optional includes
Authorizations:
basicAuth
query Parameters
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 (1) or disabled (0).

excludePortfolioID
integer
Example: excludePortfolioID=150

Exclude a specific portfolio from results by its ID.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

Create Portfolio

Creates a new portfolio with the provided name, financial settings, owner assignments, and optional group memberships. On success the newly created portfolio is returned in the same shape as GET /portfolios/{portfolioID}.

Use Cases

  • Create a new owner portfolio when onboarding a property owner
  • Programmatically provision portfolios with pre-configured reserve and distribution rules
  • Bulk-create portfolios during a data migration by supplying attachments file IDs

Business Rules

  • Requires the UpdatePortfolio permission
  • owners must be supplied as an array; each entry requires contactID, percentOwned, and percentDistributed
  • isLiveLedgerEnabled accepts -1 to reset the value to null (account default); any other value is stored as-is
  • portfolioGroupIDs assigns the new portfolio to one or more portfolio groups
  • attachments is an array of existing file IDs to attach to the portfolio on creation
  • GET /portfolios/{portfolioID} - Retrieve the created portfolio
  • POST /portfolios/{portfolioID} - Update portfolio settings
  • POST /portfolios/{portfolioID}/owners - Sync owner list after creation
Authorizations:
basicAuth
Request Body schema: application/json
required
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. 1 = enabled, 0 = disabled.

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. 1 = held, 0 = normal.

isLiveLedgerEnabled
string or integer or null
Enum: "0" "1" 0 1 null

Real-time ledger updates. Pass -1 to reset to account default (stored as null).

isBalanceNoticeDisabled
string or integer
Enum: "0" "1" 0 1

Whether to suppress balance notice emails. 1 = disabled, 0 = enabled.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
Example
{
  • "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": [
    ]
}

Response samples

Content type
application/json
{
  • "portfolio": {
    }
}

Search Portfolios

Performs an advanced, paginated search across portfolios. Returns denormalized rows combining portfolio data, statement setting details, derived property counts, owner contact names, and the most recent statement — ideal for list views and reporting dashboards.

Use Cases

  • Power the portfolio list UI with rich filter controls (reserve range, hold status, tags, assigned users)
  • Find portfolios by portfolio group, property group, or payout batch membership
  • Retrieve portfolios modified within a date range for sync/integration workflows

Business Rules

  • Results are scoped to the authenticated account; cross-account data is never returned
  • Portfolio access is restricted based on the user's portfolio group assignments
  • propertyCount is a derived column counting properties currently assigned to the portfolio
  • contactNames is a derived comma-separated string of owner contact names
  • GET /portfolios - Basic paginated list (fewer filters, lighter payload)
  • GET /portfolios/{portfolioID} - Full portfolio detail with optional includes
Authorizations:
basicAuth
query Parameters
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 1 for active, 0 for inactive.

portfolioIDs[]
Array of integers
Example: portfolioIDs[]=150

Filter to specific portfolios by ID. Pass multiple values as portfolioIDs[0]=150&portfolioIDs[1]=200.

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. 1 returns portfolios with distributions on hold.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object
required
object or null

Most recent statement for this portfolio, or null if none exists.

Response samples

Content type
application/json
[
  • {
    }
]

Get Portfolio

Returns the full detail for a single portfolio by its ID. The response always includes the core portfolio object; additional related data can be requested via the includes query parameter.

Use Cases

  • Load a portfolio detail page in the manager UI
  • Fetch owner and ledger context for distribution or accounting workflows

Business Rules

  • Access is restricted to portfolios the authenticated user's portfolio group assignments permit
  • isLiveLedgerEnabled of null means the account-level default applies; -1 is used by the update endpoint to reset to null, but the GET response always returns null or a boolean

Available Includes (4)

  • owners — List of portfolio owners, each with contact data included
  • ledger — The portfolio's accounting ledger record
  • posting — The posting setting template assigned to the portfolio
  • statementSetting — The statement setting template assigned to the portfolio
  • GET /portfolios - Paginated portfolio list
  • GET /portfolios/{portfolioID}/owners - List owners for the portfolio
  • GET /portfolios/{portfolioID}/statements - List statements for the portfolio
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 150

The ID of the portfolio to retrieve.

query Parameters
includes
string
Example: includes=owners,statementSetting

Comma-separated list of related data to include in the response. Available values: owners, ledger, posting, statementSetting

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
{
  • "portfolio": {
    }
}

Update Portfolio

Updates the settings for an existing portfolio. Only the fields present in the request body are written; omitted fields retain their current values. On success the updated portfolio is returned in the same shape as GET /portfolios/{portfolioID}.

Use Cases

  • Edit reserve amounts, distribution thresholds, or posting/statement settings
  • Reassign the portfolio to a different user (assignedToUserID)
  • Close a portfolio by setting dateClosed
  • Toggle live ledger, balance notices, or distribution hold

Business Rules

  • Requires the UpdatePortfolio permission
  • The caller must be permitted to access this portfolio via portfolio group restrictions
  • isLiveLedgerEnabled accepts -1 to reset the value to null (account default)
  • dateClosed accepts an ISO date string (YYYY-MM-DD); set to null to reopen
  • GET /portfolios/{portfolioID} - Retrieve current portfolio state
  • POST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolio
  • POST /portfolios/{portfolioID}/deactivate - Deactivate a portfolio
  • POST /portfolios/{portfolioID}/owners - Sync the owner list independently
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio to update.

Request Body schema: application/json
required
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 -1 to reset to account default (stored as null).

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 null to reopen.

assignedToUserID
string or integer or null^-?[0-9]+$

ID of the user assigned to manage this portfolio.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
{
  • "name": "456 Oak Ave - Johnson (Updated)",
  • "reserveAmount": "750.00",
  • "maximumDistributionAmount": "6000.00",
  • "assignedToUserID": 491061,
  • "holdDistributions": 0
}

Response samples

Content type
application/json
{
  • "portfolio": {
    }
}

Activate Portfolio

Reactivates a previously deactivated portfolio. On success the updated portfolio is returned in the same shape as GET /portfolios/{portfolioID}.

Use Cases

  • Reactivate a portfolio that was deactivated in error
  • Restore a portfolio after a temporary hold period

Business Rules

  • Requires the UpdatePortfolio permission
  • The caller must be permitted to access this portfolio via portfolio group restrictions
  • No request body is required; the action takes no input fields
  • Sets isActive to "1" and clears dateTimeDeactivated
  • POST /portfolios/{portfolioID}/deactivate - Deactivate a portfolio
  • GET /portfolios/{portfolioID} - Retrieve current portfolio state
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio to activate.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
{
  • "portfolio": {
    }
}

Deactivate Portfolio

Deactivates an active portfolio, optionally recording a closure date. On success the updated portfolio is returned in the same shape as GET /portfolios/{portfolioID}.

Use Cases

  • Mark a portfolio as inactive when the management agreement ends
  • Close a portfolio and record the official closure date for accounting purposes

Business Rules

  • Requires the UpdatePortfolio permission
  • The caller must be permitted to access this portfolio via portfolio group restrictions
  • dateClosed is optional; when supplied it must be a valid date string (YYYY-MM-DD)
  • Sets isActive to "0" and records dateTimeDeactivated
  • POST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolio
  • GET /portfolios/{portfolioID} - Retrieve current portfolio state
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio to deactivate.

Request Body schema: application/json
optional
dateClosed
string or null <date>

Date the portfolio was officially closed (YYYY-MM-DD).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Request samples

Content type
application/json
{
  • "dateClosed": "2026-04-30"
}

Response samples

Content type
application/json
{
  • "portfolio": {
    }
}

List Portfolio Owners

Returns a list of owners for a specific portfolio. Each item contains an owner object with the ownership and payout configuration, plus a token value used for cache validation. Use the includes parameter to attach the full contact record for each owner.

Use Cases

  • Display the owner list on a portfolio detail page
  • Build owner distribution summaries or payout previews
  • Fetch owner data for ACH / check payout workflows

Business Rules

  • The caller must have access to the specified portfolio (enforced via portfolio group restrictions)
  • Results are not paginated at the model level when includes are used; the search returns all owners for the portfolio

Available Includes (1)

  • contact — The full contact record for the owner (name, email, address, phone numbers)
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Single owner detail with includes
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details - Decrypted ACH bank account info
  • GET /portfolios/{portfolioID} - Portfolio detail (also supports owners include)
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio whose owners to retrieve.

query Parameters
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: contact

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Sync Portfolio Owners

Replaces the full owner list for a portfolio in a single operation. All existing owners are removed and the supplied owners array is set as the new authoritative list. On success the updated owner list is returned in the same paginated shape as GET /portfolios/{portfolioID}/owners.

Use Cases

  • Set or completely replace the owner roster after a portfolio change-of-ownership
  • Programmatically sync owner data from an external system

Business Rules

  • Requires the UpdatePortfolio permission
  • The caller must be permitted to access this portfolio via portfolio group restrictions
  • owners is required and must be a non-empty array; each entry requires contactID, percentOwned, and percentDistributed
  • This is a full replace, not a merge — owners not present in the payload will be removed
  • GET /portfolios/{portfolioID}/owners - List current owners
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Single owner detail
  • POST /portfolios/{portfolioID} - Update portfolio settings (owners can also be set on create)
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio whose owners to replace.

Request Body schema: application/json
required
required
Array of objects

Full replacement owner list. Each entry must include contactID, percentOwned, and percentDistributed.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Request samples

Content type
application/json
Example
{
  • "owners": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Portfolio Owner

Returns the detail for a single portfolio owner record. Use the includes parameter to attach the full portfolio or contact record.

Use Cases

  • Load an owner detail panel to display ownership percentage and payout configuration
  • Retrieve contact info for an owner without a separate contacts API call

Business Rules

  • The caller must have access to the specified portfolio (enforced via portfolio group restrictions)
  • Returns a 400 error if the portfolioOwnerID does not belong to the specified portfolioID

Available Includes (2)

  • portfolio — The portfolio this owner belongs to
  • contact — The full contact record for the owner (name, email, address, phone numbers)
  • GET /portfolios/{portfolioID}/owners - List all owners for the portfolio
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID}/ach-details - Decrypted ACH bank account info
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 150

The ID of the portfolio.

portfolioOwnerID
required
integer
Example: 201

The ID of the portfolio owner record.

query Parameters
includes
string
Example: includes=contact

Comma-separated list of related data to include in the response. Available values: portfolio, contact

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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).

Response samples

Content type
application/json
{
  • "portfolioOwner": {
    }
}

Get Owner ACH Details

Returns the decrypted ACH bank account details for a specific portfolio owner. The account number and routing number are stored encrypted; this endpoint decrypts and returns the plain-text values.

Use Cases

  • Pre-populate an ACH payout settings form for editing
  • Verify bank account details before initiating a payout

Business Rules

  • The caller must have access to the specified portfolio (enforced via portfolio group restrictions)
  • Returns a 400 error if the portfolioOwnerID does not belong to the specified portfolioID
  • If no ACH details have been saved, all fields in achDetails are returned as empty strings
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Owner detail (includes truncated account number)
  • GET /portfolios/{portfolioID}/owners - List all portfolio owners
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 150

The ID of the portfolio.

portfolioOwnerID
required
integer
Example: 201

The ID of the portfolio owner record.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "achDetails": {
    }
}

Search Statements

Performs an advanced, paginated search across all owner statements. Returns denormalized rows combining statement data, the associated portfolio, statement setting details, and derived file/attachment counts. Suitable for account-wide statement dashboards and batch management workflows.

Use Cases

  • List all statements in a specific batch (filter by statementBatchID)
  • Find statements in a specific status (e.g., all statements in Review)
  • Query statements for a set of portfolios within a date range

Business Rules

  • Results are scoped to the authenticated account; cross-account data is never returned
  • Statement access respects portfolio group restrictions for the authenticated user
  • statementFileCount and statementAttachmentCount are derived counts, not arrays
  • GET /portfolios/{portfolioID}/statements - Statements for a single portfolio
  • GET /portfolios/statements/{statementID} - Single statement detail with includes
  • GET /portfolios/statements/batches/search - Search statement batches
Authorizations:
basicAuth
query Parameters
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.

  • 1 - Processing
  • 2 - Published
  • 3 - Failed
  • 4 - Review
  • 5 - Publishing
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

List Portfolio Statements

Returns a paginated list of owner statements for a specific portfolio. Use /portfolios/statements/search for cross-portfolio queries with additional filters.

Use Cases

  • Display the statement history on a portfolio detail page
  • Check for a portfolio's most recent published statement

Business Rules

  • The caller must have access to the specified portfolio (enforced via portfolio group restrictions)
  • GET /portfolios/statements/search - Account-wide statement search with advanced filters
  • GET /portfolios/statements/{statementID} - Single statement detail with includes
  • GET /portfolios/statements/{statementID}/download - Download statement as a ZIP archive
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 150

The ID of the portfolio whose statements to list.

query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

Get Statement

Returns the full detail for a single owner statement by its ID. Additional related data can be requested via the includes query parameter, including the statement files (generated PDFs/HTML), file attachments, and the parent portfolio.

Use Cases

  • Load a statement detail view showing financial summary and status
  • Retrieve statement files to display or link for download
  • Check public sharing settings (UUID, expiry) for a published statement

Business Rules

  • Access is restricted to statements whose portfolio the authenticated user's group permits
  • Public statement sharing uses publicUUID and publicVerificationCode — these are unrelated to API auth

Available Includes (3)

  • portfolio — The portfolio this statement belongs to
  • statementFiles — List of generated statement files (PDFs, HTML exports) attached to the statement
  • fileAttachments — File attachments manually added to the statement
  • GET /portfolios/statements/{statementID}/download - Download the statement as a ZIP archive
  • GET /portfolios/{portfolioID}/statements - All statements for the portfolio
  • GET /portfolios/statements/search - Account-wide statement search
Authorizations:
basicAuth
path Parameters
statementID
required
integer
Example: 4501

The ID of the statement to retrieve.

query Parameters
includes
string
Example: includes=portfolio,statementFiles

Comma-separated list of related data to include in the response. Available values: portfolio, statementFiles, fileAttachments

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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).

Response samples

Content type
application/json
{
  • "statement": {
    }
}

Download Statement

Downloads the statement as a ZIP archive containing all generated statement files (PDFs, HTML). The response streams the binary ZIP content with a Content-Disposition: attachment header.

Use Cases

  • Provide a download button for owners or managers to save the statement package locally
  • Programmatically retrieve the statement ZIP for archival or third-party distribution

Business Rules

  • Access is restricted to statements whose portfolio the authenticated user's group permits
  • Returns a 400 error if the statement has no generated files to include in the ZIP
  • GET /portfolios/statements/{statementID} - Statement detail and metadata (includes statementFiles)
  • GET /portfolios/{portfolioID}/statements - All statements for the portfolio
Authorizations:
basicAuth
path Parameters
statementID
required
integer
Example: 4501

The ID of the statement to download.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/zip
string <binary>

Response samples

Content type
application/json
Example
{
  • "error": "Statement 4501 not found"
}

Search Statement Batches

Performs an advanced, paginated search across statement batches. Returns denormalized rows combining batch data, the associated statement setting, and a derived statement count. The response shape is a search projection — it includes only the fields from portfolio_statement_batches joined to portfolio_statement_settings, not the full batch entity.

Use Cases

  • Display a paginated list of all statement batches with status and statement count
  • Filter batches by status to find all batches in Review or Processing
  • Query batches created within a specific time range
  • Filter to batches that include statements for specific portfolios

Business Rules

  • Results are scoped to the authenticated account; cross-account data is never returned
  • statementCount is a derived count of statements in the batch (subquery)
  • statementSetting fields are nullable — a batch may not have an associated setting template
  • When startFromLastStatement is 1, each portfolio's start date is calculated from its most recent statement end date, so startDate will be null
  • GET /portfolios/statements/batches/{statementBatchID} - Single batch detail with optional statement list
  • GET /portfolios/statements/search - Search individual statements across all batches
Authorizations:
basicAuth
query Parameters
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.

  • 1 - Processing
  • 2 - Published
  • 3 - Failed
  • 4 - Review
  • 5 - Publishing
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object

Batch summary fields projected by the search query.

required
object

Statement setting template linked to this batch, if any.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Get Statement Batch

Returns the full detail for a single statement batch by its ID. Use the includes parameter to attach the complete list of statements in the batch (each with its portfolio) and access restriction flags.

Use Cases

  • Load a batch detail page showing status, date range, and file generation progress
  • Retrieve all statements in a batch to display a per-portfolio status table
  • Check whether the authenticated user has full or restricted access to the batch

Business Rules

  • Access is enforced via verifyAccessToPortfolioBatch; users with restricted portfolio access see the batch but individual statements may be flagged restricted: 1
  • When includes=statements, each statement item includes a restricted flag (0 or 1) indicating whether the authenticated user can access that statement's portfolio

Available Includes (2)

  • statements — All statements in the batch, each with portfolio data and a restricted access flag
  • restrictions — Adds a fullAccess boolean indicating whether the user has unrestricted batch access
  • GET /portfolios/statements/batches/search - Paginated batch list with advanced filters
  • GET /portfolios/statements/{statementID} - Single statement detail
  • GET /portfolios/statements/search - Account-wide statement search (filter by statementBatchID)
Authorizations:
basicAuth
path Parameters
statementBatchID
required
integer
Example: 88

The ID of the statement batch to retrieve.

query Parameters
includes
string
Example: includes=statements,restrictions

Comma-separated list of related data to include in the response. Available values: statements, restrictions

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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. true if the user has unrestricted access to all portfolios in the batch; false if some statements are restricted.

Array of objects

All statements in the batch (if includes=statements).

Response samples

Content type
application/json
{
  • "statementBatch": {
    }
}

Properties

A property is a building or lot the account manages, owned by one portfolio at a time. A single-family property has exactly one unit, which carries the property's name and address; a multi-unit property has any number of units. List, search, create, read, update, activate, deactivate and delete properties here; one create makes the property and its units together, and returns the property alone: read the units back with GET /properties/{propertyID}?includes=unit (single-family) or GET /properties/{propertyID}/units.

List Properties

Returns a page of properties, sorted by name. Each item is keyed by entity: property, plus image and portfolio when included. Use GET /properties/search for more filters and a denormalized row with portfolio, lease and group data.

Use Cases

  • Page through every active (or inactive) property on the account
  • Look up properties by name or address text
  • Load each property's image and portfolio records in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups only gets properties in those groups' portfolios (a filtered 200, never a 403).
  • isActive defaults to 1: only active properties. 0 returns only inactive ones; any other value (all, both) returns both.
  • search is a substring match on name, address, address2, city, stateID and postalCode.
  • The page size defaults to 15 and is capped at 5000. Send a pageSize of at least 1.
  • To page through every property, stop once pagination-current-page is at or past pagination-last-page.
  • Sorted by name, then propertyID.
  • The image and portfolio includes are inner joins: a property whose image or portfolio row is missing drops out of the page.

Available Includes (2)

  • image - the property's primary image record
  • portfolio - the portfolio record that owns the property
  • GET /properties/search - filtered search with portfolio, lease and group data per row
  • GET /properties/{propertyID} - one property, with more includes
  • POST /properties - create a property
Authorizations:
basicAuth
query Parameters
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 name, address, address2, city, stateID and postalCode.

isActive
string
Default: "1"
Example: isActive=0

1 (the default) returns active properties, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

managementFeeSettingID
integer
Example: managementFeeSettingID=2

Only properties that use this management fee setting, from GET /settings/management-fees (undocumented). A value that isn't a number is ignored.

includes
string
Example: includes=image,portfolio

Comma-separated related records to add to each item: image, portfolio. Other values are ignored.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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, null when empty.

token
string^[0-9]+$

The current Unix time. Sent only when neither image nor portfolio is included; carries no meaning for clients.

object (property_image)

The property's primary image. Requires the image include.

object (included_portfolio)

The portfolio that owns the property. Requires the portfolio include.

Response samples

Content type
application/json
[
  • {
    }
]

Create Property

Creates a property and its units in one request, and returns the property in the GET /properties/{propertyID} shape (without includes). A single-family property (isMultiUnit 0 or omitted) takes one unit; a multi-unit property takes a units array and an attachments array ([] when there are none).

Use Cases

  • Onboard a single-family home with its one unit
  • Onboard an apartment building with all of its units

Business Rules

  • Requires the Create Property permission (Properties › CreateProperty).
  • The body is refused with invalid input. when it is empty or {}.
  • Only the keys of the property and unit schemas below are read; any other key is ignored.
  • The request is checked in this order, each step answering a 400 on its own: the property type allows multi-unit (when isMultiUnit is 1), the portfolio exists and is inside the API user's portfolio groups, then the property's validators (keyed property.<field>), then each unit's validators (keyed unitContract.unit.<field>).
  • The property's errors come in two rounds. The field validators (lengths, formats, yearBuilt, money fields) and the must-exist checks of every ID field (countryID, the stateID-countryID pair, managementFeeSettingID, salesTaxSettingID, withholdingTaxAgencyID, applicationTemplateID, propertyShowingProviderID, assignedToUserID, defaultMonthToMonthPremiumSettingID, defaultResidentPackageID) are reported together, an unknown managementFeeSettingID as {"property.managementFeeSettingID": ["Management Fee does not exist."]}; the pair's error is keyed property.stateID, countryID, with a space (State does not exist., for a missing stateID as well as an unknown one; runtimes on Phalcon older than 5.21 send the key without the space, so match property.stateID,countryID with or without it). Only once those must-exist checks pass are missing required fields (property.address, property.city and the other … is required messages) reported, so fixing a body can take two round trips.
  • Unit errors carry no index: every unit's are keyed unitContract.unit.<field>, and checking stops at the first unit that fails, so the later units' errors aren't reported.
  • Every type except Single Family Home (1) and Mobile Home (8) allows isMultiUnit 1: Apartment, Condo, Townhouse, Duplex, Multiplex, Loft, Commercial, Garage and Lot (2-7, 9-11).
  • A single-family property needs unit with at least rent: without it the request is refused with {"unitContract.unit.rent": ["Rent is required"]}.
  • A single-family property's unit takes the property's name, address, address2, city, stateID and postalCode, whatever the unit sends. The unit's limits then apply to those values: a city longer than 50 characters is refused with {"unitContract.unit.city": ["Cannot exceed 50 characters"]}, although the property alone would take 100.
  • Money fields (rent, deposit, reserveAmount, maintenanceLimitAmount, the markup amounts, leaseReturnChargeAmount, requiredRentersInsuranceLiabilityAmount) take at most two decimal places.
  • latitude and longitude are geocoded from the address; when geocoding finds nothing they are stored as 0.00000000.
  • reserveAmount defaults to 0.00; requiredRentersInsuranceLiabilityAmount to the account's insurance setting, or 100000.00.

Side Effects

  • Creates the units, each with its own ledger and an inactive listing, and a current property-portfolio record for the owning portfolio. A multi-unit property also gets a property ledger.
  • Geocodes each unit of a multi-unit property and queues an address validation for it.
  • Recalculates the owning portfolio's reserve amount.
  • Queues an address validation for the property; addressValidationStatusID starts at 1 (Not Validated).
  • The property's address is geocoded before its validators run, so a request refused with a property.<field> or unitContract.unit.<field> error has still sent that address to the geocoding service.
  • With assignedToUserID set, sends that user the Property Assigned To User notification.
  • Fires the property::property::created webhook event, and unit::unit::created for each unit; a request with the Suppress-Webhooks: 1 header fires none.
  • GET /properties/{propertyID} - read the property back with includes
  • POST /properties/{propertyID}/units - add units later
  • GET /portfolios - portfolio IDs for portfolioID
  • GET /properties - every row's property carries the portfolioID, managementFeeSettingID, countryID and stateID an existing property uses
  • GET /properties/{propertyID}?includes=portfolio,managementFeeSetting - until GET /settings/management-fees (undocumented), GET /countries (undocumented) and GET /states (undocumented) are documented, the valid portfolioID, managementFeeSettingID, countryID and stateID of an existing property
Authorizations:
basicAuth
Request Body schema: application/json
required
non-empty
One of
non-empty
required
object

The property object of a create request. Only these keys are read (the controller's assign() whitelist); any other key is ignored. Dates are parsed loosely: YYYY-MM-DD and MM/DD/YYYY are both accepted, and are returned as YYYY-MM-DD.

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 [] when there are none.

object (unit_for_property_create)

The one unit of a single-family property, needed with at least rent (leaving it out answers 400 unitContract.unit.rent). Ignored when isMultiUnit is 1.

Array of objects

The units of a multi-unit property, each with at least address, city, stateID and rent. Ignored for a single-family property.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
Example
{
  • "property": {
    },
  • "unit": {
    }
}

Response samples

Content type
application/json
Example
{
  • "property": {
    }
}

Search Properties

Returns a filtered page of properties, each row denormalized: the property (with unit counts and vacancy), its portfolio, the current lease of a single-family property's unit, its propertyGroup names and its primaryImage.

Use Cases

  • Power a property list view with portfolio, tenant and group context, no extra lookups
  • Filter by status, vacancy, type, portfolio, portfolio group, property group, assignee, tag or location
  • Pull the properties modified in a time window for a sync

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups only gets properties in those groups' portfolios (a filtered 200, never a 403).
  • With no isActive, active and inactive properties are both returned.
  • A filter value the API can't read is ignored rather than refused: the request still answers 200 (a boolean other than 1/0/true/false/yes/no, a date it can't parse).
  • List filters (propertyIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.
  • The page size defaults to 25; send at most 5000. On a page that holds items, pagination-page-size reports the page size or the number of matching items, whichever is smaller. A pageSize of 0 or below is read as 15.
  • To page through every match, stop once pagination-current-page is at or past pagination-last-page.
  • Sorted by orderBy (default property.property: street name, street number, address 2, city, state), then propertyID. orderBy takes only the columns listed under it.
  • dateTimeModifiedMin and dateTimeModifiedMax are compared in UTC: send them in UTC.
  • lease is set only for a single-family property whose unit has a current lease; it is {leaseID: null, tenants: null} otherwise, and always for a multi-unit property.
  • property.isVacant is 1 when a single-family property's unit has no current lease, 0 when it has one, and null for a multi-unit property.
  • GET /properties - the plain property list
  • GET /properties/{propertyID} - one property, with includes
  • GET /portfolios - portfolio IDs for portfolioIDs[]
Authorizations:
basicAuth
query Parameters
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). 0 or a negative value is read as 15.

orderBy
string
Example: orderBy=property.name|desc

Sort column, optionally followed by |asc or |desc (default asc; any other direction is read as asc); several are separated by commas. Use only the columns below. propertyID always breaks ties. Columns: property.property (the default: street name, street number, address 2, city, state), property.isActive, property.name, property.address, property.address2, property.city, property.postalCode, property.streetNumber, property.streetName, property.propertyTypeID, property.isMultiUnit, property.unitCount, property.activeUnitCount, property.isVacant, property.dateTimeCreated, portfolio.name, lease.tenants (the current lease's stored tenant list, which sorts by the number of tenants rather than by name).

search
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 (FL).

isActive
string
Example: isActive=1

1 active only, 0 inactive only; omitted returns both.

isMultiUnit
string
Example: isMultiUnit=0

1 multi-unit only, 0 single-family only.

isVacant
string
Example: isVacant=1

1 single-family properties with no current lease, 0 single-family properties with one. Either value leaves out every multi-unit property.

isNonRevenue
string
Example: isNonRevenue=0

1 properties with at least one non-revenue unit, 0 properties with none.

propertyIDs[]
Array of integers
Example: propertyIDs[]=101&propertyIDs[]=102

Only these properties. One propertyIDs[]= per value.

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 propertyTypeIDs[]= per value.

  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - Mobile Home
  • 9 - Commercial
  • 10 - Garage
  • 11 - Lot
portfolioIDs[]
Array of integers
Example: portfolioIDs[]=12

Only properties owned by these portfolios (from GET /portfolios). One portfolioIDs[]= per value.

portfolioGroupIDs[]
Array of integers
Example: portfolioGroupIDs[]=3

Only properties whose portfolio belongs to one of these portfolio groups. One portfolioGroupIDs[]= per value.

propertyGroupIDs[]
Array of integers
Example: propertyGroupIDs[]=1

Only properties in one of these property groups. One propertyGroupIDs[]= per value.

assignedToUserIDs[]
Array of integers
Example: assignedToUserIDs[]=2

Only properties assigned to one of these users. One assignedToUserIDs[]= per value.

propertyManagerIDs[]
Array of integers
Deprecated
Example: propertyManagerIDs[]=1

Deprecated: only single-family properties whose unit has one of these property manager records. Use assignedToUserIDs[].

tagIDs[]
Array of integers
Example: tagIDs[]=4

Only properties tagged with one of these tags. One tagIDs[]= per value.

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 YYYY-MM-DD HH:MM:SS, ISO 8601 in UTC (2026-01-01T00:00:00Z) or MM/DD/YYYY. A value it can't parse is ignored.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2026-12-31 23:59:59

Only properties modified at or before this time. Same forms as dateTimeModifiedMin; a date alone means midnight at the start of that day, so send a time to include the whole day.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

On a page that holds items, the requested pageSize (default 25) or the number of matching items, whichever is smaller.

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 page below 1 is read as 1)

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object
required
object
required
object
required
object

Response samples

Content type
application/json
Example
[
  • {
    }
]

Get Property

Returns one property under property, plus one top-level key per requested include.

Use Cases

  • Show a property's details, with its unit, current lease and owners, in one request
  • Load a multi-unit property's units, work orders and ledger
  • Read the portfolio's balances or the current lease's balances for an accounting view

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets a 403 Access Denied for a property outside those groups' portfolios.
  • A well-formed ID with no property answers 400 Property {propertyID} not found; a value that isn't a number answers the stock 404.
  • Some includes apply only to one kind of property and are silently left out for the other:
    • multi-unit only: units, and property-level workOrders and ledger;
    • single-family only: unit and everything that hangs off it (lease, leaseBalances, pastLeases, futureLeases, listing, appliances, filters, filterDeliveryConfiguration, filterDeliveryAddress, filterDeliverySchedule, propertyManager), and unit-level workOrders and ledger.
  • On a single-family property every include of that second group needs unit as well; without it, none is sent. With unit, a property that has no unit row answers 400 Unit not found.
  • leaseBalances needs lease (and so unit) and is sent only when the unit has a current lease; portfolioBalances needs portfolio.
  • lease adds two keys, lease and leaseStatus; listing adds listing and listingFiles.
  • The portfolios include also reads the search, isCurrent, portfolioID and orderBy query parameters (below) to filter and sort the ownership history; they do nothing without it.
  • The includes list is split on commas without trimming: image, portfolio reads portfolio (with the space) and silently drops it.

Available Includes (25)

  • image - the property's primary image
  • units - the units of a multi-unit property
  • workOrders - work orders with their vendor contact: the property's own (no unit) on a multi-unit property, the unit's on a single-family one
  • ledger - the property's ledger (multi-unit) or the unit's ledger (single-family), or null
  • unit - the unit of a single-family property
  • lease - the unit's current lease (or null) and its status as leaseStatus
  • leaseBalances - balances of the current lease
  • pastLeases - the unit's closed leases, newest first
  • futureLeases - the unit's pending leases
  • listing - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFiles
  • appliances - the unit's appliances
  • filters - the unit's air filters
  • filterDeliveryConfiguration - whether the unit's air-filter delivery is set up
  • filterDeliveryAddress - the unit's custom filter delivery address, or false
  • filterDeliverySchedule - the unit's filter delivery schedule, or false
  • propertyManager - the unit's property manager record, or false
  • portfolio - the owning portfolio
  • portfolioBalances - balances of the owning portfolio's ledger
  • portfolios - the property's ownership history
  • owners - the owning portfolio's owners, with their contacts
  • managementFeeSetting - the property's management fee setting
  • inspections - the property's inspections
  • associations - the property's homeowners' associations, with their contacts
  • applicationTemplate - the property's application template, or null
  • propertyShowingProvider - the property's showing provider, or null
  • GET /properties - list properties
  • GET /properties/search - search properties
  • POST /properties/{propertyID} - update the property
  • DELETE /properties/{propertyID} - delete the property
  • GET /properties/{propertyID}/units/{unitID} - a unit, with its own includes
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 732

The property's ID.

query Parameters
includes
string
Example: includes=unit,lease,portfolio,owners

Comma-separated related records to add: image, units, workOrders, ledger, unit, lease, leaseBalances, pastLeases, futureLeases, listing, appliances, filters, filterDeliveryConfiguration, filterDeliveryAddress, filterDeliverySchedule, propertyManager, portfolio, portfolioBalances, portfolios, owners, managementFeeSetting, inspections, associations, applicationTemplate, propertyShowingProvider. An unknown name is ignored.

search
string
Example: search=Example

With includes=portfolios only. Substring match on the property's name, address, address 2, city and postal code, the portfolio's name and its owners' contact names; matches stateID exactly.

isCurrent
integer
Enum: 0 1
Example: isCurrent=1

With includes=portfolios only. 1 the current ownership row only, 0 the past ones only; any other value is ignored.

portfolioID
integer
Example: portfolioID=6

With includes=portfolios only. The ownership rows of this portfolio.

orderBy
string
Example: orderBy=propertyPortfolio.isCurrent|desc

With includes=portfolios only. Sort column, optionally followed by |asc or |desc (default asc); several are separated by commas. Without it, or when every column sent is unknown, rows come newest first (propertyPortfolio.propertyPortfolioID|desc). Columns: propertyPortfolio.propertyPortfolioID, propertyPortfolio.isCurrent, property.property (street name, street number, address 2, city, state), property.name, property.address, property.address2, property.city, property.postalCode, property.streetNumber, property.streetName, property.propertyTypeID, property.isMultiUnit, portfolio.name.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

object (property_image)

Requires the image include.

Array of objects

Multi-unit property only; requires the units include.

Array of objects (work_order_row)

Requires the workOrders include (and unit on a single-family property).

included_ledger (object) or null

Requires the ledger include (and unit on a single-family property). Null when no ledger exists.

object (unit)

Single-family property only; requires the unit include.

included_lease (object) or null

The unit's current lease, or null. Requires the unit and lease includes.

object or null

The current lease's status, or null. Sent with lease.

object (lease_balances)

Requires the unit, lease and leaseBalances includes, and a current lease.

Array of objects (included_lease)

Closed leases, newest first. Requires the unit and pastLeases includes.

Array of objects (included_lease)

Pending leases. Requires the unit and futureLeases includes.

object (listing)

Requires the unit and listing includes.

Array of objects (listing_file)

The listing's files plus the account-wide listing files (null propertyListingID). Sent with listing.

Array of objects (appliance)

Requires the unit and appliances includes.

Array of objects (filter)

Requires the unit and filters includes.

object (filter_delivery_configuration)

Requires the unit and filterDeliveryConfiguration includes.

filter_delivery_address (object) or false (any)

The unit's custom delivery address, or false (not null) when the unit has none. Requires the unit and filterDeliveryAddress includes.

filter_delivery_schedule (object) or false (any)

The unit's delivery schedule, or false (not null) when the unit has none. Requires the unit and filterDeliverySchedule includes.

property_manager (object) or false (any)

The unit's property manager record, or false (not null) when the unit has none. Requires the unit and propertyManager includes.

object (included_portfolio)

Requires the portfolio include.

object (portfolio_balances)

Requires the portfolio and portfolioBalances includes.

Array of objects (property_portfolio_row)

Ownership history. Requires the portfolios include.

Array of objects (owner_row)

Requires the owners include.

object (included_management_fee_setting)

Requires the managementFeeSetting include.

Array of objects (inspection_row)

Requires the inspections include.

Array of objects (association_row)

Requires the associations include.

included_template (object) or null

Null when the property has no application template. Requires the applicationTemplate include.

showing_provider (object) or null

Null when the property has no showing provider. Requires the propertyShowingProvider include.

Response samples

Content type
application/json
Example
{
  • "property": {
    }
}

Update Property

Updates the fields sent and returns the property in the GET /properties/{propertyID} shape (without includes). Updates take POST only: PUT on this route answers the stock 404.

Use Cases

  • Correct a property's address, name or type
  • Set insurance, warranty, markup or contract details
  • Reassign the property to another user

Business Rules

  • Requires the Update Property permission (Properties › UpdateProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a property outside those groups' portfolios.
  • The body is refused with invalid input. when it is empty or {}; then a well-formed ID with no property answers 400 Property {propertyID} not found.
  • Only the keys in the schema below are read; others are ignored, so portfolioID, isActive and isMultiUnit can't be changed here.
  • Validation errors come back as a map of field to messages ({"name": ["Name cannot exceed 100 characters"]}).
  • On a single-family property the new values are then copied onto the unit, and the unit's own validators apply to them, keyed unit.<field>: a city longer than 50 characters is refused with {"unit.city": ["Cannot exceed 50 characters"]}.
  • A single-family property whose unit has been deleted (DELETE /properties/{propertyID}/units/{unitID} allows it) can't be updated: every update answers 400 {"unit": ["No unit found for single family property: "]}.
  • A multi-unit property can't be switched to a type that doesn't allow multiple units (Single Family Home 1 and Mobile Home 8).
  • markupPercent and markupAmount can't both be set.
  • deactivationReasonID and deactivationNotes are kept only while the property is inactive: on an active property they are cleared, whatever is sent.

Side Effects

  • On a single-family property, the unit's name, address, address2, city, stateID and postalCode are overwritten from the property.
  • A changed address (address, address2, city, stateID, postalCode) is geocoded again, resets addressValidationStatusID to 1 (Not Validated), clears addressValidationData and queues a new validation.
  • A changed reserveAmount recalculates the owning portfolio's reserve amount.
  • On a single-family property, switching propertyTypeID to Commercial (9) clears the unit's beds, fullBaths and halfBaths; switching away from Commercial clears its commercialSpaceTypeID.
  • A changed assignedToUserID sends the new user the Property Assigned To User notification and records a User Assigned activity.
  • Fires the property::property::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.
  • GET /properties/{propertyID} - read the property with includes
  • POST /properties/{propertyID}/activate and POST /properties/{propertyID}/deactivate - change its status
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 728

The property's ID.

Request Body schema: application/json
required
non-empty
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.

  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - Mobile Home
  • 9 - Commercial
  • 10 - Garage
  • 11 - Lot
managementFeeSettingID
string or integer^-?[0-9]+$

The management fee setting, from GET /settings/management-fees (undocumented).

name
string or null <= 100 characters

Display name.

countryID
string <= 2 characters

Two-letter country code, from GET /countries (undocumented).

address
string [ 1 .. 100 ] characters

Street address. A changed address (or address2, city, stateID, postalCode) is geocoded again and resets address validation.

address2
string or null <= 100 characters

Second address line (suite, unit).

stateID
string <= 3 characters

State or province code of countryID, from GET /states (undocumented).

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

YYYY-MM-DD or MM/DD/YYYY; normalized to YYYY-MM-DD.

dateWarrantyExpires
string or null

YYYY-MM-DD or MM/DD/YYYY; normalized to YYYY-MM-DD.

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 0.00.

markupPercent
string or number or null <decimal>

Maintenance markup percent, 0.1 to 99. Can't be sent together with a non-empty markupAmount. 0 is stored as null.

markupAmount
string or number or null <decimal> >= 0

Maintenance markup as a fixed amount. Can't be sent together with a non-empty markupPercent. 0 is stored as null.

markupAmountMin
string or number or null <decimal> >= 0

0 is stored as null.

markupAmountMax
string or number or null <decimal> >= 0

0 is stored as null.

dateContractBegins
string or null

YYYY-MM-DD or MM/DD/YYYY; normalized to YYYY-MM-DD.

dateContractEnds
string or null

YYYY-MM-DD or MM/DD/YYYY; normalized to YYYY-MM-DD.

commercialClassTypeID
string or integer or null
Enum: "1" "2" "3" "4" 1 2 3 4 null

Stored only for a Commercial property (propertyTypeID 9); cleared for any other type.

  • 1 - A
  • 2 - B
  • 3 - C
  • 4 - D
salesTaxSettingID
string 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 0 is stored as null.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
{
  • "name": "APITEST Cedar House",
  • "address": "123 Main St",
  • "maintenanceLimitAmount": "400.00",
  • "yearBuilt": 1998,
  • "dateWarrantyExpires": "12/31/2029",
  • "insuranceCompany": "Example Mutual"
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Delete Property

Permanently deletes a property with its units and everything attached to them, and returns the deleted property as it was (a bare property object, not wrapped in property). Refused while any accounting, inspection, lease or application history references the property or one of its units; deactivate it instead.

Use Cases

  • Remove a property created by mistake, before it has any history

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a property outside those groups' portfolios.
  • A well-formed ID with no property answers 400 Property {propertyID} not found.
  • Refused with a 400 keyed by the first blocker found, checked in this order: accounting transactions (transactions), transaction entries (transactionEntries), archived transaction entries (transactionEntryArchives), bills (bills), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases). Voided transactions still count.
  • Then each unit is deleted as DELETE /properties/{propertyID}/units/{unitID} deletes it, and its blockers answer the same 400 with a unit. prefix: unit.transactions, unit.transactionEntries, unit.inspections, unit.inspectionAreas, unit.leases, unit.applications, unit.applicants. A unit with no ledger answers {"unit.ledger": ["Unit ledger not found"]}.

Side Effects

  • Deletes the property row (a hard delete: it no longer appears anywhere).
  • Deletes each unit with everything DELETE /properties/{propertyID}/units/{unitID} removes (its ledger, work orders, recurring work orders, appliances, access points, features, images, listings and leads).
  • Deletes the property's ledger (multi-unit), listings, ownership history rows, images, features, homeowners' associations, appliances, access points, work orders, recurring work orders, budgets and syndicated (warehouse) listings.
  • Deletes the property's emails, activities, notes, alerts, file attachments, reminders, watchers, object dates and custom field values.
  • Recalculates the owning portfolio's reserve amount and writes a Property Deleted log entry.
  • Fires the property::property::deleted webhook event, and unit::unit::deleted for each unit; a request with the Suppress-Webhooks: 1 header fires none.
  • POST /properties/{propertyID}/deactivate - deactivate the property instead
  • DELETE /properties/{propertyID}/units/{unitID} - delete one unit
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 728

The property's ID.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
propertyID
required
string^-?[0-9]+$

Unique identifier.

propertyImageID
required
string^-?[0-9]+$

The property's primary image (1 is the shared no-image placeholder).

propertyTypeID
required
string (property_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11"
  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - Mobile Home
  • 9 - Commercial
  • 10 - Garage
  • 11 - Lot
isMultiUnit
required
string
Enum: "0" "1"

1 for a multi-unit property, 0 for single-family. Set on create and never changed.

isActive
required
string
Enum: "0" "1"

1 active, 0 deactivated.

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 address, or null when the address doesn't start with one.

streetName
required
string or null <= 100 characters

address with the leading street number removed.

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; 0.00000000 when geocoding found nothing.

longitude
required
string <decimal>

Geocoded on create and when the address changes; 0.00000000 when geocoding found nothing.

addressValidationStatusID
required
string (address_validation_statuses)
Enum: "1" "2" "3" "4"

Result of the last address validation. Reset to 1 on create, on an address change and by the revalidate route; resolved in the background.

  • 1 - Not Validated
  • 2 - Valid
  • 3 - Invalid
  • 4 - Incomplete
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.

markupAmount
required
string or null <decimal>

Maintenance markup as a fixed amount. Never set together with markupPercent.

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 (9).

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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

UTC, formatted YYYY-MM-DD HH:MM:SS.

required
deactivation_reasons (string) or null

Why the property was deactivated. Null while active. 99 (Unknown) is the default when a deactivation sends no reason.

deactivationNotes
required
string or null
isFromImport
required
string
Enum: "0" "1"

1 when the property was created by an import.

importSourceKey
required
string or null <= 100 characters

The import's key for the row, or null.

Response samples

Content type
application/json
{
  • "propertyID": "75",
  • "propertyImageID": "1",
  • "propertyTypeID": "1",
  • "isMultiUnit": "0",
  • "isActive": "1",
  • "portfolioID": "86",
  • "managementFeeSettingID": "75",
  • "name": "APITEST Maple House",
  • "countryID": "US",
  • "address": "123 Main St",
  • "streetNumber": "123",
  • "streetName": "Main St",
  • "address2": "Apt 4",
  • "stateID": "FL",
  • "city": "Springfield",
  • "postalCode": "12345",
  • "latitude": "40.71280000",
  • "longitude": "-74.00600000",
  • "addressValidationStatusID": "1",
  • "addressValidationData": null,
  • "county": "Example County",
  • "assignedToUserID": "2",
  • "legalDescription": "Lot 4, Block 2, Example Subdivision",
  • "maintenanceLimitAmount": "375.00",
  • "yearBuilt": "2001",
  • "dateInsuranceExpires": "2027-06-30",
  • "dateWarrantyExpires": "2028-12-31",
  • "maintenanceNotes": "Example note.",
  • "applicationTemplateID": null,
  • "reserveAmount": "500.00",
  • "markupPercent": "5.0000",
  • "markupAmount": null,
  • "markupAmountMin": "25.00",
  • "markupAmountMax": "150.00",
  • "dateContractBegins": "2026-01-01",
  • "dateContractEnds": "2027-12-31",
  • "commercialClassTypeID": null,
  • "salesTaxSettingID": null,
  • "withholdingTaxAgencyID": null,
  • "insuranceCompany": "Example Insurance Co",
  • "insuranceAgent": "Pat Example",
  • "insurancePolicyNumber": "POL-0001",
  • "requiredRentersInsuranceLiabilityAmount": "100000.00",
  • "insuranceContactDetails": "555-0100",
  • "leaseReturnChargeAmount": "15.00",
  • "defaultMonthToMonthPremiumSettingID": null,
  • "defaultResidentPackageID": null,
  • "propertyShowingProviderID": null,
  • "dateTimeCreated": "2026-11-08 07:40:47",
  • "dateTimeModified": "2026-11-08 07:40:47",
  • "dateTimeDeactivated": null,
  • "deactivationReasonID": null,
  • "deactivationNotes": null,
  • "isFromImport": "0",
  • "importSourceKey": null
}

Deactivate Property

Sets the property inactive, with a reason, and returns it in the GET /properties/{propertyID} shape (without includes). Its units are deactivated with it.

Use Cases

  • Take a property out of management (sold, owner moved in, management ended) while keeping its history

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a property outside those groups' portfolios.
  • The body must not be empty: an empty body or {} is refused with invalid input., even though both fields are optional. Then a well-formed ID with no property answers 400 Property {propertyID} not found.
  • With no deactivationReasonID, the reason is stored as 99 (Unknown).
  • A single-family property whose unit has been deleted answers 400 {"unit": ["No unit found for single family property: "]}.
  • Refused when a unit has a current lease: {"unit.leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}. Close the lease first.

Side Effects

  • Deactivates every unit (single-family: its one unit), each with the unit deactivation side effects: its active listing and active recurring work orders are deactivated.
  • Deactivates the property's active recurring work orders.
  • Sets dateTimeDeactivated and recalculates the owning portfolio's reserve amount.
  • Fires the property::property::updated webhook event, and unit::unit::updated for each unit whose status changes; a request with the Suppress-Webhooks: 1 header fires none.
  • POST /properties/{propertyID}/activate - reactivate the property
  • DELETE /properties/{propertyID} - delete a property that has no history
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

The property's ID.

Request Body schema: application/json
required
non-empty
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 99 (Unknown).

  • 1 - Property Sold
  • 2 - Owner Moved In
  • 3 - Property Uninhabitable / Demolished
  • 4 - Owner Self-Managing
  • 5 - Switched to Competitor
  • 6 - Price / Fees
  • 7 - Service Quality
  • 8 - Management Terminated by Us
  • 10 - Foreclosure / Bank Repossession
  • 11 - Owner Deceased / Estate Closed
  • 12 - Entered in Error / Duplicate
  • 13 - Lease Only
  • 14 - Maintenance Handling
  • 15 - Accounting / Financial Errors
  • 16 - Leasing Performance
  • 17 - Communication Breakdown
  • 18 - Relationship / Staffing Issues
  • 19 - Owner Terminated Management
  • 20 - Portfolio Consolidation
  • 21 - Relationship Change / Divorce
  • 98 - Other
  • 99 - Unknown
deactivationNotes
string or null <= 65535 characters

Free-text notes about the deactivation.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
{
  • "deactivationReasonID": 1,
  • "deactivationNotes": "Example note."
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Activate Property

Sets the property active and returns it in the GET /properties/{propertyID} shape (without includes). Takes no body.

Use Cases

  • Bring a deactivated property back into service, with or without its units

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a property outside those groups' portfolios.
  • A well-formed ID with no property answers 400 Property {propertyID} not found.
  • Activating an already active property still answers 200.
  • A single-family property whose unit has been deleted answers 400 {"unit": ["No unit found for single family property: "]}.

Side Effects

  • Multi-unit property: with activateUnit=1 every unit is activated too, but only when the property was inactive; on an already active property the units keep their status. Without it the units keep their status.
  • Single-family property: its unit is activated with it, whatever activateUnit says, but only when the property was inactive.
  • Clears dateTimeDeactivated, deactivationReasonID and deactivationNotes.
  • Recalculates the owning portfolio's reserve amount.
  • Fires the property::property::updated webhook event, and unit::unit::updated for each unit whose status changes; a request with the Suppress-Webhooks: 1 header fires none.
  • POST /properties/{propertyID}/deactivate - deactivate the property
  • POST /properties/units/{unitID}/activate - activate one unit
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

The property's ID.

query Parameters
activateUnit
integer
Default: 0
Enum: 0 1
Example: activateUnit=1

1 also activates every unit of a multi-unit property that was inactive (no effect when the property is already active); 0 or omitted leaves the units as they are. No effect on a single-family property, whose unit is activated with it.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Response samples

Content type
application/json
{
  • "property": {
    }
}

Units

A unit is one rentable space of a property, with its market rent, deposit and layout, and the lease currently on it. List, create, read, update, activate, deactivate and delete a property's units here.

List Units

Returns a page of the property's units. Each item is keyed by entity: unit, plus property, image, propertyImage and propertyManager when included.

Use Cases

  • List a multi-unit property's units
  • Load each unit with its image and property records in one request

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups only gets units of properties in those groups' portfolios (a filtered 200, never a 403).
  • A propertyID with no property answers 200 with an empty list, not an error.
  • isActive defaults to 1: only active units. 0 returns only inactive ones; any other value returns both.
  • search is a substring match on the unit's name, address and address2.
  • Rows come sorted by street number, street name, address 2, then unitID, a stable order for paging; no other order can be asked for.
  • The page size defaults to 20 and is capped at 5000. A pageSize of 0 or below fails with a 500.
  • propertyImage needs property as well; asked for without property it fails with a 500, except for a user restricted to portfolio groups, for whom the property is joined anyway.

Available Includes (4)

  • property - the unit's property
  • image - the unit's primary image
  • propertyImage - the property's primary image (needs property; without it the request fails with a 500)
  • propertyManager - the unit's property manager record (every field null when it has none)
  • GET /properties/{propertyID}/units/{unitID} - one unit, with more includes
  • POST /properties/{propertyID}/units - add a unit
  • GET /properties/{propertyID} - the property
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

The property's ID.

query Parameters
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. 0 or a negative value fails with a 500 and no body.

search
string
Example: search=Unit 1

Substring match on the unit's name, address and address2.

isActive
string
Default: "1"
Example: isActive=0

1 (the default) returns active units, 0 inactive ones. true/false and yes/no are read the same way; any other value returns both.

includes
string
Example: includes=property,image

Comma-separated related records to add to each item: property, image, propertyImage (needs property), propertyManager.

Responses

Response Headers
pagination-page-size
integer
Example: "20"

Page size used -- the requested pageSize (default 20), capped at 5000. Not reduced when fewer items match.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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, null when empty.

token
string^[0-9]+$

The current Unix time. Sent only when no include is requested; carries no meaning for clients.

object (property)

Requires the property include.

object (property_image)

The unit's primary image. Requires the image include.

object (property_image)

The property's primary image. Requires the property and propertyImage includes.

object

The unit's property manager record; every field is null when the unit has none. Requires the propertyManager include.

Response samples

Content type
application/json
[
  • {
    }
]

Create Unit

Adds a unit to the property and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes).

Use Cases

  • Add a unit to a multi-unit property

Business Rules

  • Requires the Update Property permission (Properties › UpdateProperty).
  • The body is refused with invalid input. when it is empty or {}.
  • The unit belongs to the property in the URL; a propertyID in the body is ignored, as is any key not in the schema below.
  • address, city, stateID and rent are required.
  • An empty size is stored as null.
  • A single-family property already has its one unit: adding another is refused with 400 {"propertyID": ["Unit already exists on property"]}.
  • When the property doesn't exist, or is outside the API user's portfolio groups, nothing is created and the API answers 400 with an empty array [] as the body.

Side Effects

  • Creates the unit's ledger and an inactive listing for it.
  • On a multi-unit property, geocodes the unit's address and queues an address validation (addressValidationStatusID starts at 1).
  • Fires the unit::unit::created webhook event; a request with the Suppress-Webhooks: 1 header doesn't.
  • GET /properties/{propertyID}/units - list the property's units
  • GET /properties/{propertyID}/units/{unitID} - read the unit with includes
  • DELETE /properties/{propertyID}/units/{unitID} - delete a unit
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 548

The property to add the unit to.

Request Body schema: application/json
required
non-empty
address
required
string <= 100 characters

Street address; the leading number is split into streetNumber.

stateID
required
string <= 3 characters

State or province code, from GET /states (undocumented).

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 address on save.

streetName
string or null

Overwritten from address on save.

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 ("" or 0) is normalized to null.

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

1 marks the unit non-revenue (needs nonRevenueTypeID).

nonRevenueTypeID
string or integer or null
Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null

Required when isNonRevenue is 1; cleared otherwise. Labels as on the unit response.

nonRevenueStartDate
string or null

YYYY-MM-DD or MM/DD/YYYY, normalized to YYYY-MM-DD; cleared unless isNonRevenue is 1.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
{
  • "name": "Unit 1A",
  • "address": "123 Main St",
  • "address2": "Apt 4",
  • "city": "Springfield",
  • "stateID": "FL",
  • "postalCode": "12345",
  • "rent": "1500.00",
  • "deposit": "800.00",
  • "size": 1200,
  • "beds": 3,
  • "fullBaths": 2,
  • "halfBaths": 1,
  • "entryInstructions": "Use the side gate"
}

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Get Unit

Returns one unit under unit, plus one top-level key per requested include.

Use Cases

  • Show a unit with its current lease, listing and appliances
  • Load the unit's property, portfolio and owners in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups gets a 403 Access Denied for a unit of a property outside those groups' portfolios.
  • A well-formed unitID with no unit, or a unit that belongs to another property, answers 400 Unit {unitID} not found; a value that isn't a number answers the stock 404.
  • propertyImage, portfolio, associations and owners need property as well; portfolioBalances needs property and portfolio; leaseBalances needs lease and a current lease. Without what they need they are not sent.
  • managementFeeSetting is read from the property: without the property include it comes back as false.
  • listing adds two keys, listing and listingFiles.

Available Includes (22)

  • property - the unit's property
  • propertyImage - the property's primary image
  • portfolio - the property's owning portfolio
  • portfolioBalances - balances of the portfolio's ledger
  • owners - the portfolio's owners, with their contacts
  • associations - the property's homeowners' associations, with their contacts
  • image - the unit's primary image
  • lease - the unit's current lease, or null
  • leaseBalances - balances of the current lease
  • pastLeases - the unit's closed leases
  • futureLeases - the unit's pending leases
  • listing - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFiles
  • appliances - the unit's appliances
  • filters - the unit's air filters
  • filterDeliveryConfiguration - whether the unit's air-filter delivery is set up
  • filterDeliveryAddress - the unit's custom filter delivery address, or false
  • filterDeliverySchedule - the unit's filter delivery schedule, or false
  • managementFeeSetting - the property's management fee setting (false without property)
  • workOrders - the unit's work orders, with their vendor contact
  • inspections - the unit's inspections
  • propertyManager - the unit's property manager record, or false
  • ledger - the unit's ledger, or null
  • GET /properties/{propertyID}/units - list the property's units
  • POST /properties/{propertyID}/units/{unitID} - update the unit
  • DELETE /properties/{propertyID}/units/{unitID} - delete the unit
  • GET /properties/{propertyID} - the property
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 707

The unit's property.

unitID
required
integer
Example: 585

The unit's ID.

query Parameters
includes
string
Example: includes=property,lease,listing

Comma-separated related records to add: property, propertyImage, portfolio, portfolioBalances, owners, associations, image, lease, leaseBalances, pastLeases, futureLeases, listing, appliances, filters, filterDeliveryConfiguration, filterDeliveryAddress, filterDeliverySchedule, managementFeeSetting, workOrders, inspections, propertyManager, ledger. An unknown name is ignored.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

object (property)

Requires the property include.

object (property_image)

Requires the property and propertyImage includes.

object (included_portfolio)

Requires the property and portfolio includes.

object (portfolio_balances)

Requires the property, portfolio and portfolioBalances includes.

Array of objects (owner_row)

Requires the property and owners includes.

Array of objects (association_row)

Requires the property and associations includes.

object (property_image)

The unit's primary image. Requires the image include.

included_lease (object) or null

The unit's current lease, or null. Requires the lease include.

object (lease_balances)

Requires the lease and leaseBalances includes, and a current lease.

object (filter_delivery_configuration)

Requires the filterDeliveryConfiguration include.

Array of objects (included_lease)

Closed leases. Requires the pastLeases include.

Array of objects (included_lease)

Pending leases. Requires the futureLeases include.

object (listing)

Requires the listing include.

Array of objects (listing_file)

The listing's files plus the account-wide listing files (null propertyListingID). Sent with listing.

Array of objects (appliance)

Requires the appliances include.

Array of objects (filter)

Requires the filters include.

filter_delivery_address (object) or false (any)

The unit's custom delivery address, or false (not null) when it has none. Requires the filterDeliveryAddress include.

filter_delivery_schedule (object) or false (any)

The unit's delivery schedule, or false (not null) when it has none. Requires the filterDeliverySchedule include.

included_management_fee_setting (object) or false (any)

The property's management fee setting; false when property isn't included. Requires the managementFeeSetting include.

Array of objects (work_order_row)

Requires the workOrders include.

Array of objects (inspection_row)

Requires the inspections include.

property_manager (object) or false (any)

The unit's property manager record, or false (not null) when it has none. Requires the propertyManager include.

included_ledger (object) or null

The unit's ledger, or null. Requires the ledger include.

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Update Unit

Updates the fields sent and returns the unit in the GET /properties/{propertyID}/units/{unitID} shape (without includes). PUT on the same route does exactly the same (updateUnitPut).

Use Cases

  • Change a unit's rent, deposit, layout or address
  • Mark a unit non-revenue (renovation, model unit)
  • Set up air-filter delivery for the unit

Business Rules

  • Requires the Update Property permission (Properties › UpdateProperty).
  • The body is refused with invalid input. when it is empty or {}; then a well-formed unitID with no unit answers 400 Unit {unitID} not found.
  • The unit is looked up by unitID alone: the propertyID in the path isn't checked against it.
  • A user restricted to portfolio groups gets a 403 Access Denied for a unit of a property outside those groups' portfolios.
  • Only the keys in the schema below are read; others are ignored.
  • propertyManagerID can't be changed: a non-empty value other than the stored one is refused with a 400, and that check runs before every other, so it comes back alone ({"propertyManagerID": ["Deprecated Field: …"]}) whatever else the body gets wrong. An empty or null value clears the stored one.
  • nonRevenueTypeID is required when isNonRevenue is 1; nonRevenueTypeID and nonRevenueStartDate are cleared when it is 0.
  • An empty size ("" or 0) is stored as null.
  • Dates accept YYYY-MM-DD or MM/DD/YYYY and are returned as YYYY-MM-DD.

Side Effects

  • On a single-family property, the unit's name, address, address2, city, stateID and postalCode are written to the property too.
  • A changed address is geocoded again and resets the unit's address validation (and, on a single-family property, the property's).
  • A changed filterDeliveryScheduleID, filterDeliveryAddressTypeID or filterDeliveryAddressID re-syncs the active lease's Filter Delivery subscriptions: a pending one may start, and a live one gets the new address or schedule.
  • Fires the unit::unit::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.
  • GET /properties/{propertyID}/units/{unitID} - read the unit with includes
  • POST /properties/units/{unitID}/activate and POST /properties/units/{unitID}/deactivate - change its status
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 548

The unit's property (not checked against the unit).

unitID
required
integer
Example: 716

The unit's ID.

Request Body schema: application/json
required
non-empty
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 GET /states (undocumented).

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 ("" or 0) is normalized to null.

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 assignedToUserID instead.

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

1 marks the unit non-revenue (needs nonRevenueTypeID).

nonRevenueTypeID
string or integer or null
Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null

Required when isNonRevenue is 1; cleared otherwise. Labels as on the unit response.

nonRevenueStartDate
string or null

YYYY-MM-DD or MM/DD/YYYY, normalized to YYYY-MM-DD; cleared unless isNonRevenue is 1.

isUtilityBillingEnabled
string or integer
Enum: "0" "1" 0 1

1 turns utility billing on for the unit.

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
  • 1 - Deliver to the Unit
  • 2 - Deliver to a Custom Address (needs filterDeliveryAddressID)
filterDeliveryAddressID
string or integer or null^-?[0-9]+$

Required when filterDeliveryAddressTypeID is 2; cleared for any other type. Must exist.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
{
  • "name": "Unit 1B",
  • "rent": "1650.00",
  • "size": "",
  • "isNonRevenue": 1,
  • "nonRevenueTypeID": 1,
  • "nonRevenueStartDate": "04/23/2026",
  • "isUtilityBillingEnabled": 0
}

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Update Unit (PUT)

The same update as POST /properties/{propertyID}/units/{unitID}, sent with PUT: the same partial body, rules, side effects and responses. It is not a full replacement: keys left out keep their values.

Business Rules

  • Requires the Update Property permission (Properties › UpdateProperty).
  • Every rule of POST /properties/{propertyID}/units/{unitID} applies.
  • POST /properties/{propertyID}/units/{unitID} - the same update with POST
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 548

The unit's property (not checked against the unit).

unitID
required
integer
Example: 716

The unit's ID.

Request Body schema: application/json
required
non-empty
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 GET /states (undocumented).

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 ("" or 0) is normalized to null.

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 assignedToUserID instead.

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

1 marks the unit non-revenue (needs nonRevenueTypeID).

nonRevenueTypeID
string or integer or null
Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null

Required when isNonRevenue is 1; cleared otherwise. Labels as on the unit response.

nonRevenueStartDate
string or null

YYYY-MM-DD or MM/DD/YYYY, normalized to YYYY-MM-DD; cleared unless isNonRevenue is 1.

isUtilityBillingEnabled
string or integer
Enum: "0" "1" 0 1

1 turns utility billing on for the unit.

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
  • 1 - Deliver to the Unit
  • 2 - Deliver to a Custom Address (needs filterDeliveryAddressID)
filterDeliveryAddressID
string or integer or null^-?[0-9]+$

Required when filterDeliveryAddressTypeID is 2; cleared for any other type. Must exist.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Request samples

Content type
application/json
{
  • "name": "Unit 1B",
  • "rent": "1650.00",
  • "size": "",
  • "isNonRevenue": 1,
  • "nonRevenueTypeID": 1,
  • "nonRevenueStartDate": "04/23/2026",
  • "isUtilityBillingEnabled": 0
}

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Delete Unit

Permanently deletes a unit and everything attached to it, and returns the deleted unit as it was (a bare unit object, not wrapped in unit). Refused while any accounting, lease, application or inspection history references the unit; deactivate it instead. Deleting the only unit of a single-family property is allowed, and leaves a property that can no longer be updated, activated or deactivated (400 {"unit": ["No unit found for single family property: "]}) and whose GET with includes=unit answers 400 Unit not found: delete the property instead.

Use Cases

  • Remove a unit created by mistake, before it has any history

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A well-formed unitID with no unit, or a unit of another property, answers 400 Unit {unitID} not found.
  • A user restricted to portfolio groups gets a 403 Access Denied for a unit of a property outside those groups' portfolios.
  • Refused with a 400 keyed by the first blocker found, checked in this order: accounting transactions (transactions), transaction entries (transactionEntries), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases), applications (applications), applicants (applicants). Voided and closed records still count.

Side Effects

  • Deletes the unit row (a hard delete).
  • Deletes the unit's ledger, work orders, recurring work orders, appliances, access points (with their credentials), features, images, listings, leads and syndicated (warehouse) listings.
  • Deletes the unit's emails, activities, notes, alerts, file attachments, reminders, watchers, object dates and custom field values, and writes a Unit Deleted log entry.
  • Fires the unit::unit::deleted webhook event; a request with the Suppress-Webhooks: 1 header doesn't.
  • POST /properties/units/{unitID}/deactivate - deactivate the unit instead
  • DELETE /properties/{propertyID} - delete the whole property
Authorizations:
basicAuth
path Parameters
propertyID
required
integer
Example: 548

The unit's property; must match the unit.

unitID
required
integer
Example: 716

The unit's ID.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 (1 is the shared no-image placeholder).

isActive
required
string
Enum: "0" "1"

1 active, 0 deactivated.

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 address, or null when the address doesn't start with one.

streetName
required
string or null <= 100 characters

address with the leading street number removed.

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; 0.00000000 when unknown.

longitude
required
string <decimal>

Geocoded on create (multi-unit property) or copied from the property; 0.00000000 when unknown.

addressValidationStatusID
required
string (address_validation_statuses)
Enum: "1" "2" "3" "4"

Result of the last address validation. Reset to 1 on create and on an address change; resolved in the background.

  • 1 - Not Validated
  • 2 - Valid
  • 3 - Invalid
  • 4 - Incomplete
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 (0 is a studio). Null on a Commercial property.

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 assignedToUserID).

required
commercial_space_types (string) or null

Commercial space type; always null unless the property type is Commercial (9).

  • 1 - Office
  • 2 - Industrial
  • 3 - Retail
  • 4 - Restaurant
  • 5 - Medical
  • 6 - Special Purpose
  • 7 - Storage
  • 8 - Warehouse
  • 9 - Multi-use
isNonRevenue
required
string
Enum: "0" "1"

1 when the unit is non-revenue.

required
non_revenue_types (string) or null

Why the unit is non-revenue; null unless isNonRevenue is 1.

  • 1 - Renovation
  • 2 - Employee
  • 3 - Model
  • 4 - Other
  • 5 - For Sale
  • 6 - Lease Only
nonRevenueStartDate
required
string or null <date>

When the unit became non-revenue; null unless isNonRevenue is 1.

isUtilityBillingEnabled
required
string
Enum: "0" "1"

1 when utility billing is on for the unit.

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.

  • 1 - Deliver to the Unit
  • 2 - Deliver to a Custom Address
filterDeliveryAddressID
required
string or null^-?[0-9]+$

The custom filter delivery address; null unless filterDeliveryAddressTypeID is 2.

dateTimeCreated
required
string

UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

UTC, formatted YYYY-MM-DD HH:MM:SS.

isFromImport
required
string
Enum: "0" "1"

1 when the unit was created by an import.

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

Response samples

Content type
application/json
{
  • "unitID": "92",
  • "propertyID": "112",
  • "propertyImageID": "1",
  • "isActive": "1",
  • "name": "Unit 1A",
  • "address": "123 Main St",
  • "streetNumber": "123",
  • "streetName": "Main St",
  • "address2": "Apt 4",
  • "stateID": "FL",
  • "city": "Springfield",
  • "postalCode": "12345",
  • "latitude": "40.71280000",
  • "longitude": "-74.00600000",
  • "addressValidationStatusID": "1",
  • "addressValidationData": null,
  • "rent": "1500.00",
  • "deposit": "800.00",
  • "size": "1200",
  • "beds": "3",
  • "fullBaths": "2",
  • "halfBaths": "1",
  • "leaseID": null,
  • "propertyManagerID": null,
  • "commercialSpaceTypeID": null,
  • "isNonRevenue": "0",
  • "nonRevenueTypeID": null,
  • "nonRevenueStartDate": null,
  • "isUtilityBillingEnabled": "1",
  • "filterDeliveryScheduleID": null,
  • "filterDeliveryAddressTypeID": null,
  • "filterDeliveryAddressID": null,
  • "dateTimeCreated": "2026-11-08 07:44:22",
  • "dateTimeModified": "2026-11-08 07:44:22",
  • "dateTimeDeactivated": null,
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "leaseNotes": "Example note.",
  • "entryInstructions": "Use the side gate",
  • "vendorEntryInstructions": "Call ahead",
  • "maintenanceNotes": "Example note."
}

Activate Unit

Sets the unit active and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes). Takes no body.

Use Cases

  • Bring a unit back after a renovation or seasonal closure

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a unit of a property outside those groups' portfolios.
  • A well-formed ID with no unit answers 400 Unit {unitID} not found.
  • On a multi-unit property the property must be active first; otherwise 400 {"property": ["Property is not active"]}.

Side Effects

  • On a single-family property, the property is activated with its unit.
  • Clears the unit's dateTimeDeactivated.
  • Fires the unit::unit::updated webhook event (and property::property::updated when the property's status changes with it); a request with the Suppress-Webhooks: 1 header fires none.
  • POST /properties/units/{unitID}/deactivate - deactivate the unit
  • POST /properties/{propertyID}/activate - activate the property (and optionally all its units)
  • GET /properties/{propertyID}/units/{unitID} - read the unit
Authorizations:
basicAuth
path Parameters
unitID
required
integer
Example: 528

The unit's ID.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Deactivate Unit

Sets the unit inactive and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes), with isActive 0 and dateTimeDeactivated set. Takes no body.

Use Cases

  • Take a unit offline for a renovation or seasonal closure

Business Rules

  • Requires the Change Property Status permission (Properties › ChangeStatusProperty).
  • A user restricted to portfolio groups gets a 403 Access Denied for a unit of a property outside those groups' portfolios.
  • A well-formed ID with no unit answers 400 Unit {unitID} not found.
  • Refused while the unit has a current lease: 400 {"leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}.

Side Effects

  • Deactivates the unit's active listing and its active recurring work orders.
  • On a single-family property, the property is deactivated with its unit (reason 99, Unknown), and so are the property's own active recurring work orders.
  • Fires the unit::unit::updated webhook event (and property::property::updated when the property's status changes with it); a request with the Suppress-Webhooks: 1 header fires none.
  • POST /properties/units/{unitID}/activate - reactivate the unit
  • POST /properties/{propertyID}/deactivate - deactivate the whole property
  • DELETE /properties/{propertyID}/units/{unitID} - delete a unit that has no history
Authorizations:
basicAuth
path Parameters
unitID
required
integer
Example: 528

The unit's ID.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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, null when empty.

Response samples

Content type
application/json
{
  • "unit": {
    }
}

Resident Services

The account's REP (Resident Experience Package) service catalog. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service, and can be offered à la carte or bundled into a package. Per-account config — no portfolio scoping.

List Resident Services

Returns the account's REP service catalog (resident_services).

Business Rules

  • Per-account config — no portfolio scoping.
  • isActive is omitted by default (returns active and inactive). Pass isActive=1 for active only, isActive=0 for inactive.
  • search matches against the service name.
  • Not paginated — the full catalog is returned as a flat array.
  • POST /resident/services — create a service
  • GET /resident/services/{residentServiceID} — retrieve a single service
  • GET /resident/packages — the packages these services can be bundled into
Authorizations:
basicAuth
query Parameters
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 1 for active only, 0 for inactive. Omit for all.

serviceTypeID
integer
Example: serviceTypeID=3

Filter by service type (e.g. 3 = Pest Control).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (service)

A REP (Resident Experience Package) service definition — a per-account catalog entry in resident_services. A service is either a system type (seeded from the service-type enum, e.g. Pest Control) or a PM-defined Custom service. Services are offered on their own (à la carte) or bundled into a package. The recurring-charge fields drive the resident's monthly charge.

Response samples

Content type
application/json
[
  • {
    }
]

Create Resident Service

Creates a REP service in the account catalog.

Business Rules

  • Requires the Manage Account Settings permission.
  • name is required for a Custom service (serviceTypeID = 1); a system service may omit it.
  • defaultRecurringChargeAmount must be greater than 0.00.
  • recurringChargeAccountID must reference a charge-type GL account.
Authorizations:
basicAuth
Request Body schema: application/json
required
serviceTypeID
required
string or integer^-?[0-9]+$

Service type: 1 Custom, 2 Filter Delivery, 3 Pest Control, 4 ID Protection & Rewards, 5 Positive Credit Reporting, 6 Utility Connection, 7 Group Internet.

name
string

Display name (required for Custom; optional for system types).

description
string

Optional resident-facing description.

recurringChargeDescription
string

Ledger-line text for the recurring charge.

recurringChargeAccountID
string 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 1.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
residentServiceID
required
string^-?[0-9]+$

Unique identifier for the service.

serviceTypeID
required
string^-?[0-9]+$

Service type. System types are seeded; 1 (Custom) is a fully PM-defined service. 1 Custom, 2 Filter Delivery, 3 Pest Control, 4 ID Protection & Rewards, 5 Positive Credit Reporting, 6 Utility Connection, 7 Group Internet.

name
string 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 (1 = active, 0 = inactive).

dateTimeCreated
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string or null

Timestamp when the service was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Request samples

Content type
application/json
{
  • "serviceTypeID": "1",
  • "name": "Premium Lawn Care",
  • "description": "Weekly lawn service.",
  • "recurringChargeDescription": "Lawn Care",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "30.00",
  • "isActive": "1"
}

Response samples

Content type
application/json
{
  • "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"
}

Get Resident Service

Retrieves a single REP service from the account catalog.

Authorizations:
basicAuth
path Parameters
residentServiceID
required
integer
Example: 3

ID of the resident service.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
residentServiceID
required
string^-?[0-9]+$

Unique identifier for the service.

serviceTypeID
required
string^-?[0-9]+$

Service type. System types are seeded; 1 (Custom) is a fully PM-defined service. 1 Custom, 2 Filter Delivery, 3 Pest Control, 4 ID Protection & Rewards, 5 Positive Credit Reporting, 6 Utility Connection, 7 Group Internet.

name
string 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 (1 = active, 0 = inactive).

dateTimeCreated
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string or null

Timestamp when the service was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "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"
}

Update Resident Service

Updates a REP service.

Business Rules

  • Requires the Manage Account Settings permission.
  • serviceTypeID is immutable — it cannot be changed once the service exists.
  • name remains required for a Custom service.
Authorizations:
basicAuth
path Parameters
residentServiceID
required
integer
Example: 3

ID of the resident service.

Request Body schema: application/json
required
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

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
residentServiceID
required
string^-?[0-9]+$

Unique identifier for the service.

serviceTypeID
required
string^-?[0-9]+$

Service type. System types are seeded; 1 (Custom) is a fully PM-defined service. 1 Custom, 2 Filter Delivery, 3 Pest Control, 4 ID Protection & Rewards, 5 Positive Credit Reporting, 6 Utility Connection, 7 Group Internet.

name
string 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 (1 = active, 0 = inactive).

dateTimeCreated
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string or null

Timestamp when the service was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Request samples

Content type
application/json
{
  • "name": "Premium Lawn Care",
  • "description": "Weekly lawn service.",
  • "recurringChargeDescription": "Lawn Care",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "30.00",
  • "isActive": "1"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete Resident Service

Deletes a REP service from the catalog.

Business Rules

  • Requires the Manage Account Settings permission.
  • A system service cannot be deleted — deactivate it instead (isActive = 0).
  • A service in use cannot be deleted: it is rejected (400) when any lease references it or it belongs to a package. Remove it from those first.
Authorizations:
basicAuth
path Parameters
residentServiceID
required
integer
Example: 3

ID of the resident service.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
residentServiceID
required
string^-?[0-9]+$

Unique identifier for the service.

serviceTypeID
required
string^-?[0-9]+$

Service type. System types are seeded; 1 (Custom) is a fully PM-defined service. 1 Custom, 2 Filter Delivery, 3 Pest Control, 4 ID Protection & Rewards, 5 Positive Credit Reporting, 6 Utility Connection, 7 Group Internet.

name
string 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 (1 = active, 0 = inactive).

dateTimeCreated
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string or null

Timestamp when the service was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "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"
}

Resident Packages

The account's REP package catalog. A package bundles services and bills the resident a single recurring charge. Per-account config — no portfolio scoping.

List Resident Packages

Returns the account's REP package catalog (resident_packages).

Business Rules

  • Per-account config — no portfolio scoping.
  • isActive is omitted by default (returns active and inactive). Pass isActive=1 for active only, isActive=0 for inactive.
  • search matches against the package name.
  • Not paginated — the full catalog is returned as a flat array. The member services are not embedded here; fetch a single package with ?includes=packageServices for those.
  • POST /resident/packages — create a package
  • GET /resident/packages/{residentPackageID} — retrieve a single package (with packageServices)
  • GET /resident/services — the services a package bundles
Authorizations:
basicAuth
query Parameters
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 1 for active only, 0 for inactive. Omit for all.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
object (package)

A REP (Resident Experience Package) package — a PM-built bundle in resident_packages. A package groups services (see packageServices) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource).

Response samples

Content type
application/json
[
  • {
    }
]

Create Resident Package

Creates a REP package and its service membership in one call.

Business Rules

  • Requires the Manage Account Settings permission.
  • services is the bundle's membership — an array of { residentServiceID }. At least one service is required.
  • Every residentServiceID must reference an existing, active service in the account catalog.
  • defaultRecurringChargeAmount is the single bundled retail amount billed to the resident (greater than 0.00); it is independent of the member services' à la carte amounts.
Authorizations:
basicAuth
Request Body schema: application/json
required
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 1.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
object (package)

A REP (Resident Experience Package) package — a PM-built bundle in resident_packages. A package groups services (see packageServices) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource).

Request samples

Content type
application/json
{
  • "name": "Resident Essentials",
  • "recurringChargeDescription": "Resident Experience Package",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "25.00",
  • "isActive": "1",
  • "services": [
    ]
}

Response samples

Content type
application/json
{
  • "package": {
    }
}

Get Resident Package

Retrieves a single REP package from the account catalog.

Pass includes=packageServices to embed the bundle's membership rows alongside their joined service definitions.

Authorizations:
basicAuth
path Parameters
residentPackageID
required
integer
Example: 1

ID of the resident package.

query Parameters
includes
string
Example: includes=packageServices

Comma-separated related data to embed. Supported — packageServices.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
object (package)

A REP (Resident Experience Package) package — a PM-built bundle in resident_packages. A package groups services (see packageServices) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource).

Array of objects

Present only when requested via includes=packageServices. Each entry pairs the membership row with its joined service.

Response samples

Content type
application/json
{
  • "package": {
    },
  • "packageServices": [
    ]
}

Update Resident Package

Updates a REP package, including its service membership.

Business Rules

  • Requires the Manage Account Settings permission.
  • When services is supplied it replaces the package's membership: services not in the array are removed and new ones are added. At least one service must remain.
  • Every residentServiceID must reference an existing, active service in the account catalog.
Authorizations:
basicAuth
path Parameters
residentPackageID
required
integer
Example: 1

ID of the resident package.

Request Body schema: application/json
required
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
object (package)

A REP (Resident Experience Package) package — a PM-built bundle in resident_packages. A package groups services (see packageServices) and bills the resident a single bundled recurring charge. Per-account config; a lease opts in separately (the lease enrollment is a different resource).

Request samples

Content type
application/json
{
  • "name": "Resident Essentials",
  • "recurringChargeDescription": "Resident Experience Package",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "25.00",
  • "isActive": "1",
  • "services": [
    ]
}

Response samples

Content type
application/json
{
  • "package": {
    }
}

Delete Resident Package

Deletes a REP package from the catalog.

Business Rules

  • Requires the Manage Account Settings permission.
  • A package in use cannot be deleted: it is rejected (400) when any lease is enrolled in it. The membership rows (resident_package_services) are removed with the package.
Authorizations:
basicAuth
path Parameters
residentPackageID
required
integer
Example: 1

ID of the resident package.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 (1 = active, 0 = inactive).

dateTimeCreated
string

Timestamp when the package was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
string or null

Timestamp when the package was last modified. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

Content type
application/json
{
  • "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"
}

Listings

A listing advertises one unit for rent: headline, description, pet and utility details, and the syndication flags for each listing site. Search the account's listings, with each unit's property, portfolio and primary image, and fetch property images from the CDN here.

Search Listings

Returns a filtered page of unit listings, each row denormalized: the listing, its unit, the property, the property's groups, its portfolio, the unit's property manager, and the unit's primary image as CDN URLs.

Use Cases

  • Build a vacancy board or a public listings page filtered by rent, beds, baths, pets and location
  • Feed a syndication partner the listings marked active for it (isZillowActive, isZumperActive, …)
  • Search a map area with a latitude/longitude box
  • Pull the listings changed in a time window for a sync

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups only gets listings of properties in those groups' portfolios (a filtered 200, never a 403).
  • Only listings of active units on active properties are ever returned, whatever the filters say. With no isActive, active and inactive listings are both returned.
  • A filter value the API can't read is ignored rather than refused (a boolean other than 1/0/true/false/yes/no, a date it can't parse, an unknown orderBy).
  • The latitude/longitude box applies only when all four of latitudeMin, latitudeMax, longitudeMin and longitudeMax are sent.
  • Exclude property types with notPropertyTypeID[] (singular); notPropertyTypeIDs[] is not read and excludes nothing.
  • List filters (propertyTypeIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.
  • The page size defaults to 25 and has no cap. pagination-page-size reports the page size or the number of matching items, whichever is smaller, and 15 when nothing matches.
  • Sorted by orderBy (default unit.address), then propertyListingID.
  • The listing's syndication flags (isWebsiteActive, isZillowActive, …) can be filtered on but are not part of the row.
  • GET /properties/listings (undocumented) - the plain listing list
  • GET /properties/{propertyID}/units/{unitID}/listing (undocumented) - one listing, with its syndication flags
  • GET /listings/{propertyListingID}/files (undocumented) - the photos and documents of a listing
  • GET /properties/{propertyID}/units/{unitID} - the unit, with the listing include
Authorizations:
basicAuth
query Parameters
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 |asc or |desc (default asc); several are separated by commas. An unknown column is ignored; when every column sent is unknown, the default sort is skipped too and rows come by propertyListingID alone. propertyListingID always breaks ties. Columns: unit.address (the default), unit.address2, unit.beds, listing.propertyListingID, availabilityDate, date (advertised date), amount (rent), beds, baths (full + half), area (size).

search
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

1 active listings only, 0 inactive ones; omitted returns both.

isWebsiteActive
string
Example: isWebsiteActive=1

1 or 0: listings published, or not, to the website.

isZillowActive
string
Example: isZillowActive=1

1 or 0: listings syndicated, or not, to Zillow.

isRentalSourceActive
string
Example: isRentalSourceActive=1

1 or 0: listings syndicated, or not, to RentalSource.

isRentalscomActive
string
Example: isRentalscomActive=1

1 or 0: listings syndicated, or not, to Rentals.com.

isZumperActive
string
Example: isZumperActive=1

1 or 0: listings syndicated, or not, to Zumper.

isApartmentsActive
string
Example: isApartmentsActive=1

1 or 0: listings syndicated, or not, to Apartments.com.

isVacant
string
Example: isVacant=1

1 units with no current lease, 0 units with one.

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 (fullBaths + halfBaths).

bathsMax
integer
Example: bathsMax=3

Maximum bathrooms, inclusive, counted the same way.

petFilterOptionID
integer
Enum: 1 2 3 4
Example: petFilterOptionID=3
  • 1 - Dogs allowed
  • 2 - Cats allowed
  • 3 - Dogs and cats allowed
  • 4 - No pets (neither dogs nor cats)
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 propertyTypeIDs[]= per value.

  • 1 - Single Family Home
  • 2 - Apartment
  • 3 - Condo
  • 4 - Townhouse
  • 5 - Duplex
  • 6 - Multiplex
  • 7 - Loft
  • 8 - Mobile Home
  • 9 - Commercial
  • 10 - Garage
  • 11 - Lot
notPropertyTypeID[]
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 propertyTypeIDs[]). One notPropertyTypeID[]= per value. The name is singular.

portfolioIDs[]
Array of integers
Example: portfolioIDs[]=12

Only listings of properties owned by these portfolios (from GET /portfolios).

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.

  • 2 - Tenant Turner
  • 3 - Rently
  • 4 - ShowMojo
  • 5 - ShowingHero
dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2026-01-01 00:00:00

Only listings modified at or after this time. Accepts YYYY-MM-DD HH:MM:SS, ISO 8601 or MM/DD/YYYY; the time is read as UTC (any offset is dropped). A value it can't parse is ignored.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2026-12-31 23:59:59

Only listings modified at or before this time. Same forms as dateTimeModifiedMin.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

The requested pageSize (default 25) or the number of matching items, whichever is smaller; 15 when nothing matches.

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 page below 1 is read as 1)

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

Get Property Image

Fetches a resized property image directly from the Rentvine CDN. The URL components are provided by the image.small and image.large fields returned from GET /properties/listings/search and similar listing endpoints — no separate lookup is required.

This endpoint does not use the /api/manager base URL and requires no authentication. Images are publicly accessible once you have the CDN URL.

Constructing the URL

The image object in each listing search result contains pre-built absolute URLs:

{
  "image": {
    "propertyImageID": "1664",
    "small": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/small.jpeg",
    "large": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/large.jpeg"
  }
}

You can use image.small and image.large directly without constructing the URL manually. Both values are null when no image has been uploaded for the property.

Size Variants

{size} Dimensions Use Case
small Thumbnail List views, vacancy boards, map pins
large Full size Detail pages, syndication feeds, lightboxes

Listing Photos

To retrieve all uploaded photos and media files attached to a specific listing (not just the primary property image), use:

  • GET /listings/{propertyListingID}/files (undocumented) — lists all files (photos, documents) attached to the listing
  • GET /listings/files/{id}/preview (undocumented) — returns a file inline (for browser display)
  • GET /listings/files/{id}/download (undocumented) — downloads a file as an attachment
  • GET /properties/listings/search - Returns image.small and image.large for each result
  • GET /listings/{propertyListingID}/files (undocumented) - All uploaded listing photos and media
path Parameters
propertyID
required
integer
Example: 707

The propertyID from the listing search result.

imageHash
required
string
Example: e66a65f69d53ff3a19265b69efe9

The image hash component from the image.small or image.large URL (the segment between /images/ and /small.jpeg or /large.jpeg).

size
required
string
Enum: "small" "large"
Example: small

small for the thumbnail version, large for the full-size version.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: image/jpeg
string <binary>

Response samples

Content type
application/json
{
  • "error": "Not found"
}

Email Conversations

List Email Conversations

Returns a paginated list of email conversations for a specific object (e.g. a lease, property, or contact). Each item includes metadata about the conversation thread and a count of its messages.

Use Cases

  • Display a list of email threads associated with a lease or property in the manager portal
  • Show inbox-style conversation history for a contact or vendor
  • Sync email conversations to an external CRM or ticketing system

Business Rules

  • Both objectTypeID and objectID are required. The request will return 400 if either is missing.
  • Access is restricted via verifyAccessToObjectType — the authenticated account must have access to the given object.
  • Results are ordered by dateTimeUpdated descending (most recently active conversations first).
  • Default page size is 25.
  • GET /contacts/conversations/{id} — retrieve a single conversation with its messages
  • POST /contacts/conversations — send a new email message (creates or extends a conversation)
Authorizations:
basicAuth
query Parameters
objectTypeID
required
integer
Example: objectTypeID=4

The object type the conversations belong to. See the Object Types reference for valid values.

Common values:

  • 3 - Contact
  • 4 - Lease
  • 6 - Property
  • 7 - Unit
objectID
required
integer
Example: objectID=1050

The primary key of the object identified by objectTypeID.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Number of items per page

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 YYYY-MM-DD HH:MM:SS.

dateTimeUpdated
required
string

When the conversation was last updated (e.g. a new message was sent or received). UTC, formatted YYYY-MM-DD HH:MM:SS.

emailMessageCount
required
integer

Number of email messages within the conversation thread.

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Send Email

Sends an outbound email message, creating a new conversation thread or adding a reply to an existing one. On success, the response is the created or updated conversation record (identical to GET /contacts/conversations/{id} without includes).

Supply objectTypeID + objectID to start a new conversation, or emailConversationID to reply within an existing thread.

Use Cases

  • Send a move-in welcome email to all tenants on a lease
  • Reply to an existing email thread with additional documentation
  • Send a templated email to an owner using an email template

Business Rules

  • Requires the Contacts: Send Messages permission.
  • At least one entry in recipients is required. Addresses matching the system mail domain or noreply are silently filtered out.
  • When creating a new conversation, both objectTypeID and objectID are required. Omitting either returns a 400.
  • emailTemplateID (in the email object) causes the system to look up the template and populate templateObjectTypeID automatically.
  • copySender: "1" sends a copy of the email to the authenticated user.
  • File IDs supplied in attachments must already exist in the system.
  • GET /contacts/conversations — list conversations for an object
  • GET /contacts/conversations/{id} — retrieve a conversation with its message history
Authorizations:
basicAuth
Request Body schema: application/json
required
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:

  • 3 - Contact
  • 4 - Lease
  • 6 - Property
  • 7 - Unit
objectID
required
string or integer^-?[0-9]+$

Primary key of the object identified by objectTypeID. Required when creating a new conversation.

additionalRecipients
Array of strings <email> [ items <email > ]

Additional To recipients to include alongside recipients.

bcc
Array of strings <email> [ items <email > ]

BCC recipients — array of email address strings.

object

Email template options. emailTemplateID causes the system to resolve templateObjectTypeID automatically.

attachments
Array of integers

Array of fileID integers for files to attach to the email.

copySender
string or integer
Enum: "0" "1" 0 1

Pass "1" to send a copy of the email to the authenticated manager user.

inputs
object

Optional key/value pairs passed to template rendering.

templateObjectTypeID
string 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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Request samples

Content type
application/json
{
  • "additionalRecipients": [
    ],
  • "bcc": [
    ],
  • "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": {
    },
  • "attachments": [ ],
  • "copySender": "1",
  • "inputs": { },
  • "recipients": [
    ],
  • "templateObjectTypeID": 2,
  • "objectTypeID": 4,
  • "objectID": "2982"
}

Response samples

Content type
application/json
{
  • "emailConversation": {
    }
}

Get Email Conversation

Retrieves a single email conversation by its ID. When the messages include is requested, the response also contains the full message history, all recipients, and any file attachments on each message.

Use Cases

  • Render a full email thread view in the manager portal for a lease or property
  • Export a conversation with attachments for compliance or record-keeping
  • Load recipient list and message history before composing a reply

Business Rules

  • Returns 400 if the conversation is not found.
  • Access is restricted via verifyAccessToObjectType using the conversation's objectTypeID and objectID — the authenticated account must have access to the associated object.
  • Without the messages include, only the base conversation record is returned.
  • With messages, all email messages in the thread are returned in descending order (most recent first). Each message includes an isPrimary flag (true for the first/latest message).

Available Includes (1)

  • messages — full message history with sender recipient details and file attachments per message. Also adds recipients (all conversation participants) to the response.
  • GET /contacts/conversations — list all conversations for an object
  • POST /contacts/conversations — send a new email message / create a conversation
Authorizations:
basicAuth
path Parameters
id
required
integer
Example: 301

The unique identifier of the email conversation (emailConversationID).

query Parameters
includes
string
Example: includes=messages

Comma-separated list of related data to include in the response.

Available values: messages

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

Response samples

Content type
application/json
Example
{
  • "emailConversation": {
    }
}

Chat Messages

List Chat Messages

Returns a paginated list of chat messages. Messages are returned in descending order (most recent first) and are automatically marked as read by the manager role upon retrieval.

Chat messages are associated with a specific object via chatObjectTypeID and objectID. The chatObjectTypeID identifies the type of object the chat thread belongs to (e.g. a Work Order, Lease, Portfolio, or Vendor).

Use Cases

  • Render the chat thread for a specific lease or work order in the manager portal
  • List all recent messages across a portfolio for an owner communication view
  • Filter messages shared with a specific party (tenant, vendor, owner) for audit or compliance purposes

Business Rules

  • For accounts with access restrictions, both chatObjectTypeID and objectID are required. Restricted accounts that omit these will receive a 400 error.
  • Unrestricted accounts may omit chatObjectTypeID and objectID to retrieve messages across all objects.
  • Messages are marked as read by the manager role automatically upon retrieval.
  • Default page size is 20.
  • search performs a full-text match against the message body.
  • Each result row is structured as a flat dot-notation object with message.*, user.*, and contact.* keys.

chatObjectTypeID Values

  • 1 - Work Order
  • 2 - Lease
  • 3 - Portfolio
  • 4 - Vendor
  • 5 - Applicant
  • GET /chat/messages/{id} — retrieve a single message with file attachments
  • POST /chat/messages — create a new chat message
  • GET /chat/messages/stats — get unread message count for a specific object
Authorizations:
basicAuth
query Parameters
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.

  • 1 - Work Order
  • 2 - Lease
  • 3 - Portfolio
  • 4 - Vendor
  • 5 - Applicant
objectID
integer
Example: objectID=1050

Primary key of the object identified by chatObjectTypeID. Required for restricted accounts.

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 1 for shared, 0 for not shared.

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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 1 for manager after this endpoint is called (messages are marked read on retrieval).

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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Chat Message

Creates a new chat message on a specific object (lease, work order, portfolio, vendor, or applicant). On success, the response is identical to GET /chat/messages/{id} — the full message record with file attachments.

Use Cases

  • Post a manager note on a lease that the tenant can see in the resident portal
  • Send an internal-only note on a work order
  • Attach a file to a chat thread for a vendor

Business Rules

  • roleTypeID is always set to Manager (1) server-side and cannot be overridden by the client.
  • The authenticated account must have access to the object identified by chatObjectTypeID and objectID.
  • attachments is an array of fileID integers referencing files that already exist in the system.
  • Sharing flags (isSharedWithTenant, isSharedWithVendor, isSharedWithOwner, isSharedWithCosigner) default to 0 if omitted.
  • GET /chat/messages — list messages for an object
  • GET /chat/messages/{id} — retrieve a single message
Authorizations:
basicAuth
Request Body schema: application/json
required
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.

  • 1 - Work Order
  • 2 - Lease
  • 3 - Portfolio
  • 4 - Vendor
  • 5 - Applicant
objectID
required
string or integer^-?[0-9]+$

Primary key of the object identified by chatObjectTypeID.

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 fileID integers for files to attach to the message.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object
required
Array of objects

File attachments on the created message (empty if none were supplied).

Request samples

Content type
application/json
{
  • "attachments": [ ],
  • "message": "<p>test</p>",
  • "chatObjectTypeID": 2,
  • "objectID": 2982,
  • "isSharedWithTenant": "1",
  • "isSharedWithCosigner": "1"
}

Response samples

Content type
application/json
{
  • "message": {
    },
  • "fileAttachments": [ ]
}

Text Messages

Send Text Message

Sends an outbound SMS text message to a phone number. On success, the response returns the created text message record (identical to GET /messages/texts/{id}).

Use Cases

  • Send a reminder text to a tenant about an upcoming payment
  • Notify a vendor of a new work order via SMS
  • Send a quick update to a contact from the manager portal

Business Rules

  • Requires the Contacts: Send Messages permission.
  • to must be a valid phone number in E.164 format (e.g. +14436420607).
  • attachments is an optional array of fileID integers referencing files that already exist in the system (MMS attachments).
  • contactID is accepted in the payload but is not stored on the text message record — it is used for UI context only.
  • GET /messages/texts/phone/{phoneNumber} — list the full thread for a phone number
  • GET /messages/texts/{id} — retrieve a single text message
Authorizations:
basicAuth
Request Body schema: application/json
required
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 fileID integers for MMS file attachments.

contactID
string or integer^-?[0-9]+$

Optional contact ID for UI context. Not stored on the text message record.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Request samples

Content type
application/json
{
  • "contactID": "3816",
  • "to": "+14436420607",
  • "message": "test"
}

Response samples

Content type
application/json
{
  • "textMessage": {
    }
}

List Text Messages by Phone

Returns a paginated list of text messages (both inbound and outbound) for a given phone number. Messages are ordered by dateTimeSent descending (most recent first).

The phoneNumber path parameter should contain only the digits of the phone number including country code (e.g. 14436420607 for +1 443-642-0607). The system automatically prepends + before querying.

Use Cases

  • Display a full SMS conversation thread with a tenant or vendor
  • Retrieve message history for a specific phone number for audit or compliance
  • Load messages before a known message ID for infinite-scroll pagination (use load endpoint instead)

Business Rules

  • phoneNumber must be provided as digits only (no +, dashes, or spaces).
  • Both inbound and outbound messages for the phone number are returned.
  • Default page size is 15.
  • POST /messages/texts/send — send a new text message
  • GET /messages/texts/{id} — retrieve a single text message
Authorizations:
basicAuth
path Parameters
phoneNumber
required
integer
Example: 14436420607

Phone number digits including country code, without + prefix (e.g. 14436420607).

query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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 YYYY-MM-DD HH:MM:SS.

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).

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Screening

Get Screening Settings

Returns the screening and application settings configured for the account. This includes whether online applications are enabled, which application template is used by default, and automation preferences.

Use Cases

  • Determine whether the application portal is active before directing prospects to apply
  • Check which generic application template is assigned for use in portals that do not have a property-specific template
  • Inspect automation flags to understand when confirmation emails and auto-assignment are triggered

Business Rules

  • Returns a single settings object scoped to the authenticated account — there is no pagination.
  • isApplicationEnabled controls whether the resident-facing application portal is accessible.
  • isGenericApplicationEnabled controls whether a generic (non-property-specific) application link is active.
  • isAvailableUnitsOnly restricts the application portal to units that are marked as available.
  • autoAssignApplicationFromProperty causes incoming applications to automatically inherit the assigned manager from the property.
  • autoSendProspectConfirmationEmail sends a confirmation email to the applicant upon submission.
  • GET /screening/applications — list submitted applications
  • GET /screening/applications/{applicationID} — retrieve a single application
Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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. 1 = enabled, 0 = disabled.

isGenericApplicationEnabled
required
string
Enum: "0" "1"

Whether a generic (non-property-specific) application link is active. 1 = enabled, 0 = disabled.

isAvailableUnitsOnly
required
string
Enum: "0" "1"

Restricts the application portal to units marked as available. 1 = available units only, 0 = all units.

autoAssignApplicationFromProperty
required
string
Enum: "0" "1"

Automatically assigns the property's manager to incoming applications. 1 = enabled, 0 = disabled.

autoSendProspectConfirmationEmail
required
string
Enum: "0" "1"

Sends a confirmation email to applicants upon submission. 1 = enabled, 0 = disabled.

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.

Response samples

Content type
application/json
{
  • "screeningSettingID": "1",
  • "applicationProviderID": "1",
  • "isApplicationEnabled": "1",
  • "applicationUrl": "",
  • "isGenericApplicationEnabled": "1",
  • "genericApplicationTemplateID": "2",
  • "isAvailableUnitsOnly": "1",
  • "autoAssignApplicationFromProperty": "1",
  • "autoSendProspectConfirmationEmail": "1",
  • "genericApplicationTemplateName": "Commercial Application"
}

List Application Templates

Lists the account's application templates, active and inactive, sorted by ID, one page at a time. Each item wraps the template under template, beside a token the list adds. A template's templateID is what POST /screening/applications takes.

Use Cases

  • Find the template to create an application with
  • Show which templates are active and which is the default

Business Rules

  • Requires only authentication; no permission is checked.
  • search matches any part of the template's name, in any case. Its &, <, >, ' and " are HTML-escaped first, so a search holding one of them matches no name that has it. Without search every template is listed.
  • Inactive templates are listed too; isActive tells them apart.
  • Sorted by templateID, oldest first.
  • POST /screening/applications - create an application from a template
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
pagination-page-size
integer
Example: "15"

Page size used -- the requested pageSize (default 15), capped at 5000. Not reduced when fewer items match.

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-current-page is at or past pagination-last-page.

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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    }
]

List Applications

Returns a paginated list of rental applications submitted to the account. Each item includes the application record, current status, associated unit and property details, and linked lease information when a lease has been created.

Use Cases

  • Display a queue of pending applications for review
  • Filter applications by status or unit to find relevant submissions
  • Sync application data with an external leasing workflow

Business Rules

  • Results are scoped to the portfolios accessible to the authenticated account.
  • Default page size is 25. Use page and pageSize to paginate through results.
  • Applications are returned in descending order by applicationID (most recent first).
  • The lease object will have null values when no lease has been created from the application yet.
  • GET /screening/applications/{applicationID} — retrieve a single application's details
  • GET /screening/applications/{applicationID}/summary — retrieve a full summary with applicant data
  • POST /screening/applications/{applicationID}/status — update an application's status
Authorizations:
basicAuth
query Parameters
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.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
required
object
required
object
required
object
required
object
required
object

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Application

Creates a rental application on behalf of an applicant, from one of the account's application templates, as the manager app's "Add Application" does. It creates the application, the applicant on it and the applicant's contact, and returns the applicant, not the application: the new application's ID is the applicant's applicationID.

Use Cases

  • Enter a paper or emailed application into Rentvine
  • Create an application from another leasing system's applicant data

Business Rules

  • Requires the Modify Applications permission (Screening › ModifyApplications), checked before anything else: a key without it gets the 403 whatever the body or ID.
  • templateID names the template, from GET /screening/templates. An inactive template is accepted too. Its sections decide which parts of application are read; GET /screening/templates/{templateID}/submission (undocumented) lists the sections a template has on, each by its key in application, with their fields and labels.
  • The body is checked in this order, answering 400 at the first stage that fails:
    1. an empty body or {} (invalid input.);
    2. a missing templateID (TemplateID is required), then a templateID with no template (Application Template not found);
    3. every field of application at once, the messages nested by section and field as the body is (a list section's under items, by position);
    4. a unitID with no unit (Failed to find unit with unitID {unitID});
    5. the applicant, application and contact records' own checks (a text longer than its column, an animal-photo file that doesn't exist), the messages keyed applicant.<field>, application.<field>, contact.<field> or animalPhotos.fileID.
  • Only the fields marked required in application are required, in the sections the template has on: a manager doesn't have to meet the template's own "required" choices or minimum item counts, except on a dropdown field: a dropdown the template marks required and the body leaves out answers 400 :field not valid for the defined list (the message as sent). A field the template turned off isn't checked, but its value is still saved.
  • A message names the field by the template's label for it, which a template can rename.
  • With a unitID, the application is for that unit and the address applied for is the unit's. The application.applyingFor address fields are still required, and are then not used.
  • Without a unitID, the application is for the address sent under application.applyingFor.
  • With a key limited to some portfolio groups, send a unitID from a property in those portfolios.
  • No application fee is charged, whatever the template's fee.
  • This API has no operation that deletes the application, the applicant or the contact the create makes.
  • Values the response takes from unitID and application keep the JSON type they were sent in (a rent sent as 1650 comes back as 1650, not "1650.00"). Top-level dates come back as YYYY-MM-DD whichever accepted form was sent; dates inside a list section (an occupant's birthDate) come back as sent. Read the application back with GET /screening/applications/{applicationID} for the stored values.
  • An application that isn't an object, an array where a required field expects text, or a question or term whose variableFieldID is missing or isn't any template's fails with an empty 500.

Side Effects

  • Creates the application and the applicant, and the applicant's contact from their name, email and the valid phone numbers sent.
  • Stores the Social Security or taxpayer number encrypted; the response gives only its last four digits.
  • Attaches each file in an animal's photos ({"fileID": …} entries) to the applicant as an animal photo.
  • Writes an "Application Created" log entry and a "created" activity on the application.
  • Raises application-created and applicant-created events, which send the account's webhooks for them.
  • Records an "application submitted" analytics event.
  • GET /screening/templates - the templates, for templateID
  • GET /screening/applications/{applicationID} - the application created
  • GET /properties/{propertyID}/units - the units of a property, for unitID
Authorizations:
basicAuth
Request Body schema: application/json
required
non-empty
templateID
required
string or integer^[0-9]+$

The application template, from GET /screening/templates.

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 {"items": [...]}. Keys the template doesn't use are ignored.

A manager-created application requires only the fields marked required here, in the sections the template has turned on; the template's own "required" choices and minimum item counts apply to applicants only. The four sections a template can't turn off are required, and each item of a list section needs its own required fields. A section the template turned off is ignored; a field it turned off within a section that is on isn't checked, but its value is still saved as sent. GET /screening/templates/{templateID}/submission (undocumented) lists the sections a template has on, each by its key here, with their fields.

unitID
string or integer or null^[0-9]+$

The unit applied for, from GET /properties/{propertyID}/units. Leave it out (or null) for an application to the address under application.applyingFor.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
applicantID
required
string^-?[0-9]+$

The primary key of the applicant.

applicationID
required
string^-?[0-9]+$

The application the applicant belongs to, readable at GET /screening/applications/{applicationID}.

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 US) when unitID was sent, otherwise as sent under application.applyingFor.

address
required
string or null <= 100 characters

The address applied for: the unit's when unitID was sent, otherwise as sent under application.applyingFor.

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 application.leaseInfo (a JSON number when sent as one).

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 application.leaseInfo.moveInDate; null when not sent.

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 application.leaseInfo.agentName; null when not sent.

agentContactInformation
required
string or null <= 100 characters

Contact Info, as sent under application.leaseInfo.agentContactInformation; null when not sent.

firstName
required
string or null <= 50 characters

First Name, as sent under application.personalInfo.firstName; null when not sent.

middleName
required
string or null <= 50 characters

Middle Name, as sent under application.personalInfo.middleName; null when not sent.

lastName
required
string or null <= 50 characters

Last Name, as sent under application.personalInfo.lastName; null when not sent.

email
required
string or null <= 75 characters

Email, as sent under application.personalInfo.email; null when not sent.

homePhone
required
string or null <= 20 characters

Home Phone, as sent under application.personalInfo.homePhone; null when not sent.

cellPhone
required
string or null <= 20 characters

Cell Phone, as sent under application.personalInfo.cellPhone; null when not sent.

workPhone
required
string or null <= 20 characters

Work Phone, as sent under application.personalInfo.workPhone; null when not sent.

birthDate
required
string or null <date>

Date of Birth, as sent under application.personalInfo.birthDate; null when not sent.

birthPlace
required
string or null <= 50 characters

Birth Place, as sent under application.personalInfo.birthPlace; null when not sent.

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 application.personalInfo.licenseNumber; null when not sent.

licenseState
required
string or null <= 50 characters

License State, as sent under application.personalInfo.licenseState; null when not sent.

passportID
required
string or null <= 50 characters

Passport #, as sent under application.personalInfo.passportID; null when not sent.

studentID
required
string or null <= 50 characters

Student #, as sent under application.personalInfo.studentID; null when not sent.

maidenName
required
string or null <= 50 characters

Maiden Name, as sent under application.personalInfo.maidenName; null when not sent.

height
required
string or null <= 25 characters

Height, as sent under application.personalInfo.height; null when not sent.

weight
required
string or null <= 25 characters

Weight, as sent under application.personalInfo.weight; null when not sent.

eyeColor
required
string or null <= 25 characters

Eye Color, as sent under application.personalInfo.eyeColor; null when not sent.

hairColor
required
string or null <= 25 characters

Hair Color, as sent under application.personalInfo.hairColor; null when not sent.

maritalStatus
required
string or null <= 200 characters

Marital Status, as sent under application.personalInfo.maritalStatus; null when not sent.

citizenship
required
string or null <= 100 characters

Citizenship, as sent under application.personalInfo.citizenship; null when not sent.

referredBy
required
string or null <= 1000 characters

How were you referred to us?, as sent under application.personalInfo.referredBy; null when not sent.

assistanceAgency
required
string or null <= 45 characters

Agency, as sent under application.assistance.assistanceAgency; null when not sent.

assistanceCounty
required
string or null <= 100 characters

County, as sent under application.assistance.assistanceCounty; null when not sent.

assistanceTechnician
required
string or null <= 100 characters

Technician, as sent under application.assistance.assistanceTechnician; null when not sent.

assistancePhone
required
string or null <= 20 characters

Phone, as sent under application.assistance.assistancePhone; null when not sent.

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 application.assistance.assistanceUtility; null when not sent.

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 application.personalInfo.applicantType; null when not sent.

primaryAddress
required
string or null <= 100 characters

Address, as sent under application.currentAddress.primaryAddress; null when not sent.

primaryAddress2
required
string or null <= 100 characters

Unit/Apt #, as sent under application.currentAddress.primaryAddress2; null when not sent.

primaryCity
required
string or null <= 100 characters

City, as sent under application.currentAddress.primaryCity; null when not sent.

primaryStateID
required
string or null <= 3 characters

State, as sent under application.currentAddress.primaryStateID; null when not sent.

primaryPostalCode
required
string or null <= 20 characters

Postal Code, as sent under application.currentAddress.primaryPostalCode; null when not sent.

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 application.currentAddress.primaryRentOwn; null when not sent.

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 application.currentAddress.primaryMoveInDate; null when not sent.

primaryManagerName
required
string or null <= 100 characters

Manager Name, as sent under application.currentAddress.primaryManagerName; null when not sent.

primaryManagerPhone
required
string or null <= 20 characters

Manager Phone, as sent under application.currentAddress.primaryManagerPhone; null when not sent.

primaryManagerEmail
required
string or null <= 75 characters

Manager Email, as sent under application.currentAddress.primaryManagerEmail; null when not sent.

primaryReasonForLeaving
required
string or null

Reason for Leaving, as sent under application.currentAddress.primaryReasonForLeaving; null when not sent.

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 application.addressHistory, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The bank accounts as sent under application.bankAccounts, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The credit cards as sent under application.creditCards, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The emergency contacts as sent under application.emergencyContacts, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The employment history as sent under application.employmentHistory, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The other sources of income as sent under application.income, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The occupants as sent under application.occupants, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The animals as sent under application.pets, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The references as sent under application.references, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
null or object

The vehicles as sent under application.vehicles, values and dates exactly as sent, each item given an _id; null when the request had none or the template has the section off.

required
Array of objects or null

The answers to the template's questions, as sent under application.questions; null when none were sent.

required
Array of objects or null

The acceptances of the template's terms, as sent under application.terms; null when none were sent.

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 YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

When the applicant was last changed. UTC, formatted YYYY-MM-DD HH:MM:SS.

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.

Request samples

Content type
application/json
Example
{
  • "templateID": "16",
  • "unitID": "47",
  • "application": {
    }
}

Response samples

Content type
application/json
Example
{
  • "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": {
    },
  • "income": null,
  • "occupants": {
    },
  • "pets": {
    },
  • "references": null,
  • "vehicles": {
    },
  • "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
}

Get Application

Returns the core details of a single rental application by its ID, including the application record and its current status.

Use Cases

  • Retrieve the current status and metadata of a specific application
  • Display application details in a manager review view

Business Rules

  • Returns a 404 if the application does not exist or is not accessible to the authenticated account.
  • The status object reflects both the custom sub-status (applicationStatusID) and the underlying system-level status (primaryApplicationStatusID).
  • GET /screening/applications — list all applications
  • GET /screening/applications/{applicationID}/summary — full summary with applicant details and screening data
  • POST /screening/applications/{applicationID}/status — update the application status
Authorizations:
basicAuth
path Parameters
applicationID
required
integer
Example: 1702

The unique identifier of the application.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object
required
object

Response samples

Content type
application/json
{
  • "application": {
    },
  • "status": {
    }
}

Get Application Summary

Returns an enriched summary of a rental application, including applicant qualification data (income ratio, combined income, occupants, animals), individual applicant records with screening field statuses, pending applicant slots, legacy screening reports, and the screening report mode.

This endpoint provides significantly more detail than GET /screening/applications/{applicationID} and is intended for the application review screen.

Use Cases

  • Render the full application review page with income ratios, bedroom counts, and applicant screening statuses
  • Display individual applicant data tabs (credit, criminal, eviction, income, identity, rental history)
  • Determine whether legacy screening reports are available for an application

Business Rules

  • Returns a 404 if the application does not exist or is not accessible to the authenticated account.
  • summary.incomeRatio is calculated as combinedIncome / rent. A ratio meeting or exceeding expectedRatio indicates the applicant qualifies by income.
  • applicants[].data is an array of screening field status objects, one per field type (application, animals, identity, income, credit, criminal, eviction, landlord).
  • screeningReportModeID is the account's screening report mode (\Rentvine\Screening\Report\Modes): 0 = Disabled, 1 = Package, 2 = Dynamic.
  • pendingApplicants contains applicant slots that have been invited but have not yet submitted their portion of the application.
  • GET /screening/applications/{applicationID} — lightweight application record without summary data
  • GET /screening/applicants/{applicantID}/tab/application — full applicant form data for a specific applicant
  • POST /screening/reports — order screening reports for applicants
  • POST /screening/applications/{applicationID}/status — update the application status
Authorizations:
basicAuth
path Parameters
applicationID
required
integer
Example: 1702

The unique identifier of the application.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Response samples

Content type
application/json
{
  • "application": {
    }
}

Update Application Status

Updates the status of a rental application and optionally sends a notification email to the applicant and/or additional recipients. This is the primary action used to move an application through the review pipeline (e.g. from Submitted → Under Review → Approved or Declined).

Use Cases

  • Approve or decline an application after review
  • Move an application to a custom sub-status (e.g. "Contingent", "Pending Documents")
  • Send a templated notification email to the applicant upon status change
  • BCC additional recipients (e.g. owner, team member) on the notification

Business Rules

  • applicationStatusID must reference a valid system or custom status ID.
  • When sendEmail is true, the email object is required and must include at least one entry in recipients.
  • emailTemplateID references an email template configured in the account. The template may include Liquid variables such as {{ application.applicantNames | list }} and {{ application.address }}.
  • bcc and additionalRecipients accept arrays of email address strings.
  • attachments accepts an array of file attachment references (empty array if none).
  • copySender is treated as a string boolean: "1" = copy the sending user, "0" = do not copy.
  • Returns a 400 if applicationStatusID is missing or invalid.
  • Returns a 404 if the application does not exist or is not accessible.
  • GET /screening/applications/{applicationID} — retrieve current application status
  • GET /screening/applications/{applicationID}/summary — full application review data
Authorizations:
basicAuth
path Parameters
applicationID
required
integer
Example: 1702

The unique identifier of the application.

Request Body schema: application/json
required
applicationStatusID
required
string or integer^-?[0-9]+$

ID of the status to set on the application.

Common system status IDs:

  • 1 - Incomplete
  • 2 - Submitted
  • 3 - In Progress
  • 4 - On Hold
  • 5 - In Review
  • 6 - Approved
  • 7 - Declined
sendEmail
boolean
Default: false

Whether to send a notification email to the applicant on status change.

object

Email configuration. Required when sendEmail is true.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

The updated application record.

required
object

The application status record set by this action.

Request samples

Content type
application/json
Example
{
  • "applicationStatusID": "6",
  • "sendEmail": true,
  • "email": {
    }
}

Response samples

Content type
application/json
{
  • "application": {
    },
  • "status": {
    }
}

Get Applicant Application Tab

Returns the full application form data for a specific applicant, including personal details, employment history, address history, vehicles, occupants, SSN (last 4 digits), and the dynamic form builder structure used to render the application. This endpoint powers the applicant detail tab in the application review screen.

Use Cases

  • Render a read-only view of a specific applicant's submitted application form
  • Extract structured employment and address history for underwriting review
  • Access the dynamic builder field structure to display custom application sections and fields

Business Rules

  • Returns a 404 if the applicant does not exist or is not accessible to the authenticated account.
  • ssn returns only the last 4 digits of the social security number — the full value is never exposed via the API.
  • builder.sections contains the dynamic form structure including all active sections and field definitions. includedForView = 1 means the section is visible in the review view.
  • employmentHistory and vehicles use an items + maxID structure where maxID tracks the highest auto-incremented ID for client-side additions.
  • addressHistory may be null if the applicant did not provide prior addresses.
  • GET /screening/applications/{applicationID}/summary — application-level summary with all applicants
  • GET /screening/applications/{applicationID} — application core record
  • POST /screening/reports — order screening reports for this applicant
Authorizations:
basicAuth
path Parameters
applicantID
required
integer
Example: 1664

The unique identifier of the applicant.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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 items + maxID structure.

object or null

Employment history entries.

occupants
object or null

Additional occupants in items + maxID structure.

object or null

Vehicle information entries.

object

Dynamic form builder structure defining the application sections and fields.

Response samples

Content type
application/json
{
  • "applicantID": "1664",
  • "applicationID": "1702",
  • "number": "101635",
  • "userID": null,
  • "applicantContactID": "5231",
  • "unitID": "709",
  • "countryID": "US",
  • "address": "9470 Corkscrew Palms Circle",
  • "address2": "315",
  • "city": "Estero",
  • "stateID": "FL",
  • "postalCode": "33928",
  • "moveInDate": null,
  • "leaseMonths": "1 year",
  • "firstName": "Walter",
  • "middleName": "William",
  • "lastName": "DeVeas",
  • "email": "applicant@example.com",
  • "homePhone": null,
  • "cellPhone": null,
  • "workPhone": null,
  • "birthDate": "2001-01-01",
  • "licenseNumber": null,
  • "licenseState": null,
  • "applicantType": null,
  • "ssn": "3333",
  • "addressHistory": null,
  • "employmentHistory": {
    },
  • "occupants": null,
  • "vehicles": {
    }
}

Order Screening Reports

Orders one or more screening reports (credit, criminal, eviction) for specified applicants on a rental application. Reports are requested from the integrated screening provider and results are associated with the applicant records.

Use Cases

  • Trigger credit, criminal, and/or eviction checks for all applicants on an application
  • Order only specific report types (e.g. eviction only) for a subset of applicants
  • Re-run screening reports after an initial error

Business Rules

  • applicationID must reference an existing, accessible application.
  • applicantIDs must contain at least one applicant ID. All provided applicants must belong to the specified application.
  • reportTypeIDs must contain at least one valid report type. Supported report type IDs:
    • 1 — Credit
    • 2 — Criminal
    • 3 — Eviction
  • The account must have an active screening provider integration configured (applicationProviderID in screening settings).
  • Returns a 400 if any applicant ID does not belong to the specified application or if reportTypeIDs is empty.
  • Report results are returned asynchronously by the provider — this endpoint initiates the request but does not return the report data. Poll GET /screening/applications/{applicationID}/summary to check report status.
  • GET /screening/settings — verify screening provider is configured
  • GET /screening/applications/{applicationID}/summary — check report status after ordering
  • GET /screening/applicants/{applicantID}/tab/application — view applicant details before ordering
Authorizations:
basicAuth
Request Body schema: application/json
required
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.

  • 1 — Credit
  • 2 — Criminal
  • 3 — Eviction

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
object

Confirmation that screening report requests were submitted.

Request samples

Content type
application/json
Example
{
  • "applicationID": "1702",
  • "applicantIDs": [
    ],
  • "reportTypeIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Screening reports have been ordered"
}

Custom Fields

List Custom Field Object Types

Returns all available custom field category object types. Each entry represents a distinct type of object in the system (e.g., Owner, Lease, Property) that can have custom field categories and fields assigned to it. Object types are static and preset — they cannot be created or deleted via the API.

Use Cases

  • Enumerate all object types before populating a dropdown for selecting which object type a new custom field category should apply to
  • Display a summary of how many custom field categories and fields are configured per object type
  • Determine valid customFieldCategoryObjectTypeID values for use in POST /custom-field-categories and GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}

Business Rules

  • Object types are system-defined and static — this list does not change between requests
  • categoryCount reflects the total number of custom field categories assigned to this object type
  • fieldCount reflects the total number of individual custom fields across all categories for this object type
  • No pagination — the full list is returned in a single response
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list all categories and fields for a specific object type
  • POST /custom-field-categories — create a new custom field category under one of these object types
  • GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for an object
Authorizations:
basicAuth

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
customFieldCategoryObjectTypeID
required
string^-?[0-9]+$

Unique identifier for the object type. Use this value as customFieldCategoryObjectTypeID when creating categories or fetching fields.

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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Custom Field Categories by Object Type

Returns all custom field categories and their associated fields for a given object type. Unlike GET /custom-fields/values/{objectTypeID}/{objectID}, this endpoint returns the field definitions only — it does not include any values saved for a specific object.

Use this endpoint to discover which categories and fields exist for an object type before reading or writing values via the values endpoints.

Use Cases

  • Build a custom field editor UI by first loading all available categories and fields for a given object type
  • Determine valid customFieldID keys when constructing a payload for POST /custom-fields/values/{objectTypeID}/{objectID}
  • Inspect field settings (e.g., dropdown options) to render appropriate input controls

Business Rules

  • customFieldCategoryObjectTypeID must be a valid ID from GET /custom-field-category-object-types
  • Categories are returned ordered by orderIndex
  • Each category includes a customFields array listing all fields in that category, ordered by their own orderIndex
  • The settings property is a JSON-encoded string that may contain a description and an options array for dropdown (fieldTypeID: 3) fields
  • This endpoint does not return current field values — use GET /custom-fields/values/{objectTypeID}/{objectID} for that
  • GET /custom-field-category-object-types — list all available object types
  • GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for a specific object
  • POST /custom-fields/values/{objectTypeID}/{objectID} — save field values for a specific object
  • POST /custom-field-categories — create a new category under this object type
Authorizations:
basicAuth
path Parameters
customFieldCategoryObjectTypeID
required
integer
Example: 1

The ID of the object type whose categories and fields should be returned. Obtain valid IDs from GET /custom-field-category-object-types.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create Custom Field Category

Creates a new custom field category under the specified object type. A category acts as a named grouping for related custom fields. After creating a category, custom fields can be added to it via the Rentvine UI or subsequent API calls.

Use Cases

  • Programmatically provision a new group of custom fields for a specific object type during account setup
  • Create a structured category (e.g., "Lease Terms", "Inspection Details") before adding fields to it

Business Rules

  • name and customFieldCategoryObjectTypeID together must be unique — a category with the same name cannot be created more than once for the same object type
  • customFieldCategoryObjectTypeID must reference a valid object type from GET /custom-field-category-object-types
  • The new category is created with no custom fields; fields must be added separately via the Rentvine interface
  • GET /custom-field-category-object-types — list available object types to find a valid customFieldCategoryObjectTypeID
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — verify the new category appears in the list after creation
  • GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for objects in this category's object type
Authorizations:
basicAuth
Request Body schema: application/json
required
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 GET /custom-field-category-object-types.

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.

  • 1 - Short Text
  • 2 - Paragraph
  • 3 - Dropdown
  • 4 - Toggle
  • 5 - Date
  • 6 - Number
  • 7 - Decimal
  • 8 - Integer
options
string

JSON-encoded array of options for Dropdown fields. Use "[]" for non-dropdown field types.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
required
object

Request samples

Content type
application/json
Example
{
  • "name": "test-docs",
  • "fieldTypeID": 1,
  • "options": "[]",
  • "customFieldCategoryID": "43",
  • "customFieldCategoryObjectTypeID": "1"
}

Response samples

Content type
application/json
{
  • "customField": {
    }
}

Delete Custom Field Category

Deletes a custom field category with every custom field in it, and clears those fields' values on every record of the category's record type. Returns the deleted category.

Use Cases

  • Remove a group of custom fields the account no longer uses, in one call

Business Rules

  • Requires the Manage Custom Fields permission (Administration › ManageCustomFields), checked before anything else: a key without it gets the 403 whatever the body or ID.
  • A well-formed customFieldCategoryID with no category answers 400 Custom Field Category {customFieldCategoryID} not found; one that isn't all digits (abc, -1) answers the stock 404.
  • A category with no fields is deleted the same way.
  • The delete can't be undone, and the cleared values can't be recovered.

Side Effects

  • Every custom field in the category is deleted.
  • Those fields' values are cleared (set to null) on every record of the category's record type; values of fields in other categories are kept.
  • On each record whose values change, an "Updated" log entry is written, and an update event is raised where the record type sends webhooks.
  • GET /custom-field-categories (undocumented) - the account's categories
  • DELETE /custom-fields/{customFieldID} - delete one field
Authorizations:
basicAuth
path Parameters
customFieldCategoryID
required
integer
Example: 7

The category, from GET /custom-field-categories (undocumented).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Lease
  • 5 - Property
  • 6 - Unit
  • 8 - Work Order
  • 9 - Portfolio
  • 10 - Listing
  • 11 - Appliance
  • 12 - Association
  • 13 - Maintenance Technician
name
required
string <= 200 characters

The category's name.

orderIndex
required
string^-?[0-9]+$

The category's position among the record type's categories, from 0.

Response samples

Content type
application/json
{
  • "customFieldCategoryID": "7",
  • "customFieldCategoryObjectTypeID": "5",
  • "name": "Access details",
  • "orderIndex": "0"
}

Delete Custom Field

Deletes a custom field and clears its value on every record of its record type. Returns the deleted field.

Use Cases

  • Retire a custom field the account no longer uses

Business Rules

  • Requires the Manage Custom Fields permission (Administration › ManageCustomFields), checked before anything else: a key without it gets the 403 whatever the body or ID.
  • A well-formed customFieldID with no field answers 400 Custom Field {customFieldID} not found; one that isn't all digits (abc, -1) answers the stock 404.
  • The delete can't be undone, and the cleared values can't be recovered.

Side Effects

  • The field's value is cleared (set to null) on every record of its record type; the record's other custom field values are kept.
  • On each record whose value changes, an "Updated" log entry is written, and an update event is raised where the record type sends webhooks.
  • GET /custom-fields/values/{objectTypeID}/{objectID} - a record's custom field values
  • DELETE /custom-field-categories/{customFieldCategoryID} - delete a whole category and its fields
Authorizations:
basicAuth
path Parameters
customFieldID
required
integer
Example: 21

The custom field, from GET /custom-fields (undocumented).

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
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.

  • 1 - Single Line Text
  • 2 - Paragraph
  • 3 - Dropdown
  • 4 - Toggle
  • 5 - Date
  • 6 - Numeric
  • 7 - Currency
  • 8 - Whole Number
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.

  • 1 - Owner
  • 2 - Tenant
  • 3 - Vendor
  • 4 - Lease
  • 5 - Property
  • 6 - Unit
  • 8 - Work Order
  • 9 - Portfolio
  • 10 - Listing
  • 11 - Appliance
  • 12 - Association
  • 13 - Maintenance Technician
settings
required
string or null

The field's settings (its description, and a dropdown's options) as a JSON-encoded string, such as {"description":"Gate code"}; null when it has none.

orderIndex
required
string^-?[0-9]+$

The field's position within its category, from 0.

valueColumn
required
string or null <= 20 characters

The internal column the field's values are stored in (text_1).

Response samples

Content type
application/json
{
  • "customFieldID": "21",
  • "customFieldCategoryID": "27",
  • "name": "Gate code",
  • "fieldTypeID": "1",
  • "customFieldCategoryObjectTypeID": "5",
  • "settings": "{\"description\":\"Side gate code\"}",
  • "orderIndex": "0",
  • "valueColumn": "text_1"
}

Get Custom Field Values

Returns all custom field categories and their field values for a given object type and object. Each category contains an ordered list of fields with their current values for the specified object.

Use Cases

  • Display custom field data on a property, lease, owner, tenant, or vendor detail page
  • Retrieve all custom fields associated with an applicant or screening record before displaying them
  • Audit which custom field values have been filled in for a specific object

Business Rules

  • objectTypeID identifies the type of object (e.g., 1 = Owner, 2 = Lease, 5 = Property)
  • objectID is the unique identifier of the specific object within that type
  • Fields with no value saved will return null for the value property
  • Fields are grouped by customFieldCategoryID and ordered by orderIndex
  • The settings property is a JSON-encoded string containing field metadata such as dropdown options and description
  • POST /custom-fields/values/{objectTypeID}/{objectID} — save or update field values for the object
  • GET /custom-field-category-object-types — list all object types and their category counts
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list categories and fields for an object type
Authorizations:
basicAuth
path Parameters
objectTypeID
required
integer
Example: 5

The ID of the object type (e.g., 1 = Owner, 2 = Lease, 5 = Property).

objectID
required
integer
Example: 577

The unique ID of the specific object whose custom field values are being retrieved.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Save Custom Field Values

Saves or updates the custom field values for a specific object. The request body is a flat map where each key is a customFieldID (as a string) and the value is the new value to save. A customFieldCategoryID key must be included to scope the update to the correct category.

Only the fields provided in the payload are updated. Fields not included in the payload retain their existing values.

Use Cases

  • Save filled-in custom field data after a user edits a property, lease, or contact record
  • Programmatically populate custom fields during an import or onboarding flow
  • Clear a field value by setting it to null

Business Rules

  • objectTypeID and objectID in the path must match a valid object
  • Keys in the request body are customFieldID values cast to strings
  • customFieldCategoryID is required in the payload to scope the write to the correct category
  • Setting a field value to null clears any previously stored value
  • The response returns the full updated set of categories and fields for the object (same shape as GET /custom-fields/values/{objectTypeID}/{objectID})
  • GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve current field values for the object
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list categories and fields to know which customFieldID keys are valid
Authorizations:
basicAuth
path Parameters
objectTypeID
required
integer
Example: 5

The ID of the object type (e.g., 1 = Owner, 2 = Lease, 5 = Property).

objectID
required
integer
Example: 577

The unique ID of the specific object whose custom field values are being saved.

Request Body schema: application/json
required
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 customFieldID. Set to null to clear the value.

Responses

Response Headers
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, q is how many requests it allows and w the period it allows them in, in seconds. For an "endpoint" limit that refills continuously that is its sustained rate, not what you can send at once (an export allows 10 of its 60 at once): read r in RateLimit for that. Read it as an RFC 8941 structured-field list, as the IETF rate-limit headers draft defines it; the items are separated by , and each name is quoted.

A signed-in request lists "account", "user" and "api-key", plus "client" for a partner app and "endpoint" on an operation with a limit of its own (a few undocumented routes add items of their own), but not "ip", although the per-IP limit counted it too. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A limit that counts requests without refusing them (one being tried out before it's enforced, or one Rentvine has set to count only for your account, user or API key) is listed like the others, with r=0 in RateLimit once you are over it; the request is still run, and its response carries a Retry-After as well. If the limits counted after sign-in are switched off for your account, user or API key, a response lists only "ip". A response sent with no limit counted (rate limiting switched off) carries neither header, so treat both as optional.

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 RateLimit-Policy, after this request: r is how many more requests it allows right now and t how many seconds until its whole allowance is back. Same names, same order and same structured-field list format as RateLimit-Policy. A per-minute limit ("account", "user", "client", "ip") gives its whole allowance back at the start of each clock minute, which can be sooner than t. A limit that refills continuously ("api-key", "endpoint") gives requests back one at a time, so r grows again before t.

The limit with the lowest r is the one that refuses your next request to this operation first: slow down before it reaches 0.

Response Schema: application/json
Array
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.

Request samples

Content type
application/json
Example
{
  • "364": null,
  • "469": "test",
  • "customFieldCategoryID": "96"
}

Response samples

Content type
application/json
[
  • {
    }
]

Object Types

Rentvine uses Object Types to label different objects in the system. Object types, along with the primary key of the object given as objectID, are commonly used to identify objects that use a shared resource.

For example, when uploading a file for a unit, the unitID would be used for the objectID and an objectTypeID of 7 would given with the file when uploading a file to the files endpoint.

ID Object Type
1Account
2User
3Contact
4Lease
5Bill
6Property
7Unit
8Deposit
9Accounting Transaction
10Accounting Transaction Entry
11Portfolio
12Payout
13Bank Adjustment
14Company
15Statement
16Work Order
17Inspection
18Inspection Area
19Inspection Item
20Application
21Applicant
22Bank Transfer
23Listing
24Appliance
25Text Message
26Email Message
27Work Order Estimate
28Settlement
29Lease Tenant
30Email Template
31Note
32File Attachment
33Vendor Bill
34Document Transaction
35Document Envelope
36Application Template
37Recurring Bill
38Chat Message
39Reconciliation
40Path
41Payout Return
42Management Fee Setting
43Additional Management Fee Setting
44Accounting Setting
45Posting Setting
46Late Fee Setting
47Statement Setting
48Payout Batch
49Letter
50Reminder
51Review