Rentvine API Docs (2026.11.19)

Download OpenAPI specification:

Read and change the properties, leases, accounting, maintenance and contacts of a Rentvine account over HTTPS and JSON.

The Rentvine Manager API lets a property management company that uses Rentvine, and the software it connects to Rentvine, read and change the data in its Rentvine account: properties and units, leases and tenants, accounting, maintenance, contacts, screening and messages. Each request signs in with one of the account's API keys and acts with the permissions of the key's role.

The supported API

The Rentvine Manager API is the set of operations in this reference. Rentvine supports them, and records changes to them and to this reference, dated, in the Changelog. Other routes under /api/manager serve Rentvine's own applications: they can change, without notice.

Some descriptions name a route marked (undocumented): the place a field's values come from today, which this reference doesn't cover yet.

Base URL

https://{account}.rentvine.com/api/manager

{account} is your account's subdomain, the first part of your Rentvine address ({account}.rentvine.com). An API key works only on its own account's subdomain; on any other it gets a 401. A subdomain with no account behind it answers 404 with {"error": "No Account Found"}, and a subdomain that is no longer the account's main one (after a rename, for example) answers 202 with {"message": "Subdomain is not primary", "redirectTo": "<subdomain>"}: send the request again to the subdomain in redirectTo.

Requests and responses

  • JSON both ways. Send request bodies as JSON with Content-Type: application/json, except file uploads, which take multipart/form-data (POST /files, POST /accounting/invoices/upload). Responses are JSON unless the operation says otherwise (a PDF or a file download).
  • Methods. Reads are GET. A create is a POST to the collection (POST /owners) and an update a POST to the record (POST /owners/{contactID}); some records also accept the update as PUT, and their operations document it. Deletes and voids are DELETE; other actions are a POST to a named path (POST /owners/{contactID}/deactivate). A request whose path or method matches no route, a trailing slash included, answers 404.
  • Values are strings. Responses send IDs, counts, amounts and yes/no flags as JSON strings: "1042", "1600.00", and "1" or "0". Timestamps are UTC, as "2026-11-14 16:01:03", and dates are "2026-11-14". This holds for values Rentvine reads from its database; a value the API computes or a settings object it stores as JSON can hold real numbers and booleans, so type each field as its operation documents it. Request bodies accept numbers either as JSON numbers or as strings. Send the times in filters in UTC.
  • Records are wrapped. Most responses put each record under its type's name: a list is an array of objects such as {"property": {...}}, and a read is one such object. A list item can carry other keys beside the record, such as related records or a token, and a few operations return the record unwrapped; each operation's response shows its shape.
  • Includes. Many reads take an includes parameter, a comma-separated list of related records to add beside the record (?includes=portfolio,unit). Each operation lists the names it accepts; an unknown name is ignored.
  • Unknown query parameters are ignored. A filter the operation doesn't read, a misspelled one included, has no effect: the list comes back with a 200 as if the parameter hadn't been sent, with the operation's default filters still applied. Check filter names against the operation.
  • No session. Every request authenticates with its API key. Most responses set a __rv_api__ session cookie; you don't need to store it or send it back.

Authentication

Every request signs in with one of your account's API keys over HTTP Basic authentication: the access key is the username and the secret is the password.

# -u sends {access key}:{secret} as an HTTP Basic Authorization header
curl https://{account}.rentvine.com/api/manager/properties \
  -u "$RENTVINE_ACCESS_KEY:$RENTVINE_SECRET"

A key belongs to one account and works only on that account's subdomain. A request with no credentials, a wrong key or secret, a deactivated key, or a key from another account gets a 401 with {"code": 401, "error": "Access Denied"} (Errors); an Authorization header that isn't HTTP Basic with both a key and a secret gets a 401 with another message. Repeated failed sign-ins from one IP address are answered more slowly.

What a key can do

A key acts as its own user, with the role you give it. An operation that checks a permission the role lacks answers 403 with {"error": "Permission Denied"}; operations name the permission they check in their description. A key added to Pods (portfolio groups) sees and changes only the records in those groups' portfolios; a key in no Pod is not limited.

Creating an API key

  1. In Rentvine, go to Settings › Users, Roles and API and open the API tab. Creating and changing keys needs the Manage Users permission and a recent re-authentication in the app.
  2. Select New API Key.
  3. Enter a name and choose a role.

    ℹ️ Create the role first, on the Roles tab, with only the permissions your integration needs.

  4. Copy the access key and the secret. The secret is shown only now; if you lose it, use Update Secret to make a new one, which replaces the old secret.

From the same list you can edit a key's name and role, add it to Pods (Edit Pods), or deactivate it (Delete Key). Keep the secret out of source control and logs.

Errors

A request that fails answers with a 4xx or 5xx status. Read the status first: the body's shape depends on it, and a few errors have no body. Each operation lists the errors it returns. Every response, errors included, carries an X-Request-ID header (Request IDs, below).

Status When Body
400 The request was refused: a field failed validation, the body was empty or malformed, a business rule refused it, or a record the path or a field names doesn't exist {"error": "..."}, or a map of validation messages by field
401 No credentials, or a key or secret that isn't valid on this account (Authentication) {"code": 401, "error": "Access Denied"}
403 The key signed in, but this request was refused: its role lacks a permission, the record is outside the key's Pods, or a feature is off {"error": "..."}, naming the check; a few 403s have no body
404 The path or method matches no route (and a missing record on a few operations, below) {"code": "404", "error": "Not Found", "message": "Requested Resource could not be found."}
404 The subdomain in the URL has no Rentvine account behind it (Base URL) {"error": "No Account Found"}
429 A rate limit refused the request, which wasn't run; wait the Retry-After seconds and send it again (Rate Limits) {"code": "429", "error": "Too Many Requests", "message": "Rate limit exceeded."}
500 The request failed inside Rentvine {"error": "Internal Server Error", "requestID": "..."}

Note that code is a number in a 401 and a string in a 404 or a 429.

400: validation and missing records

A field that fails validation answers with a map from each failing field to its messages:

{
  "name": ["Name is required"],
  "rate": ["Rate is required"]
}

Other refusals send one message, {"error": "invalid input."}, sometimes with a longer message beside it. A few operations send another shape, such as a bare string or an empty list, and document it.

A record that doesn't exist is usually a 400, not a 404. Most operations answer a well-formed ID with no record behind it with a 400 and a message naming the record, such as {"error": "Property 999999999 not found"}. A 404 means the URL itself matched nothing: an unknown path, a value the path doesn't accept (letters where an ID goes, as in /properties/abc), a method the path doesn't take, or a trailing slash. The exceptions are reading, updating and deleting a resident service or package, and adding, reading and updating one of a lease's resident services, which answer a missing record with this same 404.

403: what was refused

error names the check that refused the request:

  • Permission Denied: the key's role lacks a permission the operation needs. Give the role that permission on the Roles tab of Settings › Users, Roles and API.
  • Access Denied, or a message naming the record: the record is outside the portfolios the key's Pods allow.
  • A message naming a feature, such as Workflows are not enabled for your account.: the feature is off for your account.
  • ELEVATION_REQUIRED: the operation needs a recently re-authenticated user session, which an API key can't have, unless Rentvine has turned on API elevation for your account.

500: failures inside Rentvine

A 500 means Rentvine couldn't complete the request. The body names no cause, only the request's ID:

{
  "error": "Internal Server Error",
  "requestID": "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"
}

Recognise a 500 by its status, not its body: a request that ran out of memory or time can answer with no body, and a failure while the API key is being checked may send another JSON body. A 500 that has a request ID carries it in the X-Request-ID header, whatever its body.

Some 500s come from the request itself, and the operation lists each of those with the input that causes it: sending the same request again fails the same way, so change the input instead. Otherwise reads are safe to retry. Before retrying a write, read the record back to see whether the first attempt took effect. If a request keeps failing, contact Rentvine support with its request ID.

Request IDs

Every response the API sends, successes and errors alike, carries an X-Request-ID header: the ID, a UUID, that Rentvine gave the request. Rentvine makes a new one for every request; an X-Request-ID you send is ignored. A 500 repeats it in the body as requestID.

X-Request-ID: 01a1eaeb-e38d-71f1-9fbf-a43bcc163a42

Rentvine records the ID with the errors it reports, with the log lines a request writes, and with the change history of the records a request changes. Log the X-Request-ID of each request you send, or at least of each one that answers 500 or changes something. When you contact Rentvine support about a 500 or a change, quote its X-Request-ID and the time you sent it, so support can find what that request recorded. A request that changed nothing and didn't fail inside Rentvine, a 400, 403 or 404 included, usually leaves no record to find.

A response sent from in front of the API, such as a 502 or 504 from the gateway, has no X-Request-ID. The request may still have run behind it: before resending a write, read the record back.

Pagination

Lists that page take two query parameters, page (the first page is 1) and pageSize, and return one page as a JSON array. The paging details come back in response headers, not in the body:

Header Meaning
pagination-total-items Items across all pages
pagination-total-pages Number of pages
pagination-current-page The page returned
pagination-last-page The last page
pagination-page-size The page size used. On the lists with no cap (table below) it is the total number of items instead when that is smaller, and 15 when nothing matches
pagination-first-page, pagination-before-page, pagination-next-page The first, previous and next page numbers
pagination-page-size: 2
pagination-total-items: 763
pagination-total-pages: 382
pagination-current-page: 1
pagination-next-page: 2
pagination-before-page: 1
pagination-first-page: 1
pagination-last-page: 382

To read a whole list, start at page=1 and request the next page until pagination-current-page is at or past pagination-last-page. That also stops after one request for an empty list. Send page and pageSize as whole numbers from 1 up.

Pages are read when you request them, so records created, deleted or changed between your requests can move from one page to another. To keep another system in step, use the lists and exports that filter by dateTimeModifiedMin, and start each run a little before the end of the last one. A deleted record simply drops out of the lists, so a modification-time read never reports it: compare the full list of IDs now and then to find deletions.

Page sizes

The default page size, and the most a page can hold, differ from list to list. A pageSize above a list's cap is served at the cap, not refused.

Default Cap Lists
15 5,000 GET /properties, GET /tenants, GET /owners, GET /associations, GET /accounting/bills, GET /accounting/deposits, GET /maintenance/work-orders, GET /maintenance/inspections, GET /leases/{leaseID}/pets, GET /leases/{leaseID}/recurring-charges, GET /screening/templates
20 5,000 GET /properties/{propertyID}/units
25 5,000 GET /leases, GET /portfolios, GET /portfolios/{portfolioID}/statements
50 5,000 GET /files
250 5,000 GET /vendors, GET /maintenance-technicians
5,000 5,000 GET /accounting/accounts
25 None Every /search list except GET /properties/search (GET /tenants/search, GET /accounting/transactions/search and the rest), GET /accounting/invoices, GET /accounting/reconciliations, GET /maintenance/labor-rates, GET /maintenance/materials, GET /screening/applications, GET /screening/applicants, GET /contacts/conversations, GET /events/webhooks, GET /events/webhooks/calls, and the exports (GET /leases/export, GET /properties/export, GET /properties/units/export, GET /screening/applications/export)
20 None GET /chat/messages
15 None GET /messages/texts/phone/{phoneNumber}

GET /properties/search defaults to 25 and takes a pageSize of up to 5,000.

GET /accounting/bank-accounts, GET /leases/statuses and GET /maintenance/work-order/statuses return every item in one page: they ignore page and pageSize, though they send the headers. Lists not named here return every item at once, with no paging headers.

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 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 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 endpoint where it applies) 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.

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.

Concurrency

The API doesn't detect conflicting changes. Updates check no version number, ETag or If-Match header, and responses send no ETag. When two clients update the same record, the request that arrives last wins: its values replace what the other client wrote.

To avoid overwriting someone else's change:

  • Read the record just before you update it, and check in the update's description whether fields you leave out keep their values. Where they do, send only the fields you mean to change.
  • Where the record has a dateTimeModified, compare it with the value you read earlier to see whether the record changed in between.

A create has no duplicate check either: retrying a create whose response you didn't receive can create the record twice. Before retrying, search for the record to see whether the first attempt created it.

Webhooks

Rentvine can notify your system when things happen in your account by sending webhooks, HTTP requests to a URL you register. Set them up in Rentvine under Settings › Other › Webhooks, or through the API: Webhook Subscriptions registers, changes and deletes webhooks, and Webhook Deliveries lists each send and what your receiver answered. The payloads Rentvine sends, and how to verify they came from Rentvine, aren't covered by this reference yet.

To keep your own changes from coming back to you as webhooks, send the header Suppress-Webhooks: true with the request: the changes that request makes send no webhooks.

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, to upload a file and attach it to a unit, send POST /files?objectTypeID=7&objectID=<the unitID>. The table lists object types 1 to 51; higher values exist for other kinds of records.

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
33Invoice
34Document Transaction
35Document Envelope
36Application Template
37Recurring Bill
38Chat Message
39Reconciliation
40Path
41Payout Return
42Management Fee Setting
43Additional Management Fee Setting
44Accounting Setting
45Posting Setting
46Late Fee Setting
47Statement Setting
48Payout Batch
49Letter
50Reminder
51Review

Changelog

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

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

2026-11-19

  • Every response carries a request ID. Each response, errors included, now sends an X-Request-ID header: the ID Rentvine gives the request and records with the errors and changes the request makes. Log it with each request, and quote it when you contact Rentvine support about a 500 or a change. Errors describes it.
  • A 500 has a JSON body. A request that fails inside Rentvine now answers 500 with {"error": "Internal Server Error", "requestID": "..."}, the requestID matching the X-Request-ID header, instead of an empty body. The operations that document a 500 show this body.
  • An unknown subdomain answers JSON. A request to a subdomain with no Rentvine account behind it now answers 404 with {"error": "No Account Found"} instead of the plain-text No Account Found.

Reference only.

  • Accounting reads checked against the API. The reference for 21 accounting read operations now matches what the API returns: GET /accounting/accounts and /accounting/accounts/search; the ledger, journal-entry, ledger-transfer and recurring searches; GET /accounting/bills, /accounting/bills/{billID} and its /print; GET /accounting/invoices, /accounting/invoices/{invoiceID} and its /print; /accounting/payables/search; GET /accounting/deposits, /accounting/deposits/search, /accounting/deposits/transactions/undeposited, /accounting/deposits/{depositID} and its /print; and /accounting/transactions/search and /accounting/transactions/entries/search. IDs, flags and amounts are typed as the strings the API sends, fields that can be null say so, query parameters the API ignores are gone, each error is documented with the body it really returns, and paging is described as each list pages.
  • Accounting diagnostics removed from the reference. The 11 read operations under /accounting/diagnostics are internal health checks, not part of the supported API, and are no longer documented. Don't build integrations on them.
  • Creating a material checked against the API. POST /maintenance/materials now documents every field it accepts with the limits the API enforces (name unique ignoring case, sellPrice above 0 and purchasePrice 0 or more with up to 2 decimals, a 12-digit upc, an existing file's imageFileID), that a new material is created active, the includes=file parameter, each 400 with the body it returns, and what sending the same request twice does.
  • Unintended behaviors no longer described. The reference stopped describing responses that aren't intended and may change; don't rely on them. leaseID on GET /leases/{leaseID}/recurring-charges, /leases/{leaseID}/resident-services and /leases/{leaseID}/pets, propertyID on GET /properties/{propertyID}/units, portfolioID on GET /portfolios/{portfolioID}/statements and statementBatchID on GET /portfolios/statements/search start at 1; portfolioIDs[] is gone from GET /portfolios/statements/batches/search; isOwnerApproved on GET /maintenance/work-orders documents only the yes values; GET /accounting/invoices/{invoiceID}/print documents printing an invoice that has a payee contact, without the 500; POST and PUT /accounting/leases/charges/{transactionID} drop the 500 for an amount that isn't a number; GET /leases documents sending propertyImage with property, without the 500, and sending search with includes=unit, and GET /portfolios/{portfolioID}/owners sending search with includes=contact; endDate on GET /maintenance/work-orders says only that work orders created after the date are left out; maxLineItemsOnPayment on a vendor, technician or association create is a whole number; and the reference no longer describes how search treats ', ", &, < and > on GET /owners, /tenants, /vendors, /associations, /maintenance-technicians, /portfolios, /portfolios/{portfolioID}/owners, /leases, /leases/{leaseID}/recurring-charges, /leases/{leaseID}/pets, /properties/{propertyID}/units, /files, /maintenance/vendor-trades, /maintenance/work-orders and /screening/templates or text on GET /accounting/invoices, the image and portfolio includes dropping properties on GET /properties, listings whose unit image is gone dropping out of GET /properties/listings/search, the unit image includes dropping units, or the write GET /maintenance/work-orders/{workOrderID} can make. contact, without the 500; POST and PUT /accounting/leases/charges/{transactionID} drop the 500 for an amount that isn't a number; endDate on GET /maintenance/work-orders returns work orders created up to the date; maxLineItemsOnPayment on a vendor, technician or association create is a whole number; and the reference no longer describes how search treats special characters on GET /properties/{propertyID}/units or text on GET /accounting/invoices, the unit image includes dropping units, or the write GET /maintenance/work-orders/{workOrderID} can make. portfolioBalances and leaseBalances.currentBalance on GET /properties/{propertyID} and GET /properties/{propertyID}/units/{unitID}, and the lease balances' currentBalance on GET /leases/{leaseID}, are documented as decimal strings only, without the number 0 for a ledger with no balances or a lease with nothing posted yet.
  • Sort order of four lists. GET /portfolios/statements/search, GET /portfolios/{portfolioID}/statements and GET /portfolios/statements/batches/search state their order: newest first by start date, end date or creation time, then by ID, so a page boundary never splits ties differently. GET /screening/applicants is newest first by creation time only, so applicants created in the same second can move between pages. No parameter changes any of the four orders.
  • Wording. A contact's birthDate and identificationNumber are marked as personal data; a lease's occupancyEndDate notes that some pending leases send 0000-00-00, and a contact's liabilityInsuranceExpiresDate that rows of any age can store 0000-00-00; and a portfolio owner's missing percentDistributed is to be read as its percentOwned.

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 IP address, and the export and report limits. On a 429, wait the Retry-After seconds, then send the request again. 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

Leases, one page at a time, each with its unit, property and portfolio details, for copying them into another system. Filter by status or by modification time, dateTimeModifiedMin and dateTimeModifiedMax, to fetch only the leases changed since your last export.

Export Leases

Lists the account's leases for export, one row per lease with its balances, unpaid charges, property, unit and portfolio, ordered by leaseID. Built for incremental syncs: filter on dateTimeModifiedMin (and dateTimeModifiedMax) to fetch only the leases that changed since the last run.

Use Cases

  • Sync leases, their tenants and their balances into a data warehouse or another system, nightly or hourly
  • Pull the leases that changed since the last sync, page by page
  • Export only some leases (leaseIDs[]) or lease statuses

Business Rules

  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups gets only the leases whose property is in one of its groups' portfolios.
  • Rate limited per API key, apart from the other exports: 60 an hour, of which 10 can be sent at once, then one a minute (see Rate Limits).
  • Every filter narrows the result; a list filter matches any of its values. List values aren't checked: one that isn't a number matches no lease rather than being ignored, so send numbers only.
  • A lease is exported only once it has a modification-time record, which the API and the manager portal write when they create or change it: a lease that has none is left out, whatever the filters.
  • lease.dateTimeModified moves when the lease itself changes, when a transaction on it (a charge, credit, payment, refund, return, deposit release or payout) is posted, changed or voided, and when one of its tenants, occupants, pets, vehicles or renters-insurance requests changes. It doesn't move when only the property, the unit, the portfolio or its owners change, or when a charge becomes past due with time, so the balances, property, unit and portfolio of a row an incremental sync skipped can be out of date.
  • unpaidCharges lists the lease charges that aren't voided and aren't fully paid; a charge is overdue (isOverdue 1) when it was posted before today in the account's time zone, and balances totals the unpaid amounts of these charges.
  • Paging: 25 rows per page by default, with no upper limit; see pageSize. Read pages until pagination-current-page is at or past pagination-total-pages; no match answers [].
  • GET /leases/{leaseID} - one lease, with its includes
  • GET /properties/export - the property export
  • GET /properties/units/export - the unit export
Authorizations:
basicAuth
query Parameters
leaseIDs[]
Array of integers

Only these leases. Send each ID as a separate leaseIDs[]=; a single leaseIDs= value is read as a one-item list.

primaryLeaseStatusIDs[]
Array of strings or integers (primary_lease_statuses_request)
Items Enum: "1" "2" "3" 1 2 3

Only leases in these primary statuses (1 Pending, 2 Active, 3 Closed). Send each as a separate primaryLeaseStatusIDs[]=.

leaseStatusIDs[]
Array of integers

Only leases in these lease statuses, the account's own statuses (GET /leases/statuses). Send each as a separate leaseStatusIDs[]=.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01 10:00:00

Only records last modified at or after this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z (2024-01-01T10:00:00Z); a date alone means its midnight. For an incremental sync, send the dateTimeModified of the newest record the previous sync received. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-31 23:59:59

Only records last modified at or before this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z; a date alone means its midnight, so it leaves out the rest of that day. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25
Example: pageSize=100

Rows per page (default 25). There is no upper limit: a larger value returns up to that many rows in one response. 0, a negative number or a value that isn't a number is served at 15 rows per page.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

On a page with results: the page size in effect (the requested pageSize, default 25, no upper limit), or the number of matching rows when that is smaller.

pagination-total-items
integer
Example: "1"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The lease's own fields, its active tenants and its created and last-modified times.

required
object (balances)

Totals of the lease's unpaid charges (unpaidCharges), computed when the export runs. Each amount is the string "0.00" while no unpaid charge adds to it, and a JSON number once one does (1275, 1200.5): read both forms.

required
Array of objects (unpaid_charges)

The lease's unpaid charges, in no set order; an empty list when there are none.

required
object (property_export)

The property's own fields.

required
object (unit_export)

The unit's own fields.

required
object (portfolio_export)

The portfolio that holds the property.

Response samples

Content type
application/json
[
  • {
    }
]

Properties

Properties, one page at a time, with their details, for copying them into another system. Filter by modification time, dateTimeModifiedMin and dateTimeModifiedMax, to fetch only the properties changed since your last export.

Export Properties

Lists the account's properties for export, one row per property with its property groups and its portfolio and owners, ordered by propertyID. Built for incremental syncs: filter on dateTimeModifiedMin (and dateTimeModifiedMax) to fetch only the properties that changed since the last run.

Use Cases

  • Sync properties, their groups and their owners into a data warehouse or another system
  • Pull the properties that changed since the last sync, page by page
  • Export only active (or only inactive) properties

Business Rules

  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups gets only the properties in one of its groups' portfolios.
  • Rate limited per API key, apart from the other exports: 60 an hour, of which 10 can be sent at once, then one a minute (see Rate Limits).
  • A property is exported only once it has a modification-time record, which the API and the manager portal write when they create or change it: a property that has none is left out, whatever the filters.
  • property.dateTimeModified moves when the property itself changes (activating and deactivating it included), when it moves to another portfolio, and when its property groups, associations or appliances change. It doesn't move when only the portfolio or its owners change, so the portfolio of a row an incremental sync skipped can be out of date.
  • Paging: 25 rows per page by default, with no upper limit; see pageSize. Read pages until pagination-current-page is at or past pagination-total-pages; no match answers [].
  • GET /properties/{propertyID} - one property
  • GET /properties/units/export - the unit export
  • GET /leases/export - the lease export
Authorizations:
basicAuth
query Parameters
isActive
boolean

true (or 1, yes) for active properties only, false (or 0, no) for inactive ones only. Leave it out for both; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01 10:00:00

Only records last modified at or after this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z (2024-01-01T10:00:00Z); a date alone means its midnight. For an incremental sync, send the dateTimeModified of the newest record the previous sync received. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-31 23:59:59

Only records last modified at or before this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z; a date alone means its midnight, so it leaves out the rest of that day. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25
Example: pageSize=100

Rows per page (default 25). There is no upper limit: a larger value returns up to that many rows in one response. 0, a negative number or a value that isn't a number is served at 15 rows per page.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

On a page with results: the page size in effect (the requested pageSize, default 25, no upper limit), or the number of matching rows when that is smaller.

pagination-total-items
integer
Example: "1"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The property's own fields, its property groups and its created and last-modified times.

required
object (portfolio_export)

The portfolio that holds the property.

Response samples

Content type
application/json
[
  • {
    }
]

Units

Units, one page at a time, each with its property details, for copying them into another system. Filter by modification time, dateTimeModifiedMin and dateTimeModifiedMax, to fetch only the units changed since your last export.

Export Units

Lists the account's units for export, one row per unit with its property, its current lease ID and whether it's vacant, ordered by unitID. Built for incremental syncs: filter on dateTimeModifiedMin (and dateTimeModifiedMax) to fetch only the units that changed since the last run.

Use Cases

  • Sync units and their vacancy into a data warehouse, a listing site or another system
  • Pull the units that changed since the last sync, page by page
  • Export only active (or only inactive) units

Business Rules

  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups gets only the units whose property is in one of its groups' portfolios.
  • Rate limited per API key, apart from the other exports: 60 an hour, of which 10 can be sent at once, then one a minute (see Rate Limits).
  • A unit is exported only once it has a modification-time record, which the API and the manager portal write when they create or change it: a unit that has none is left out, whatever the filters.
  • unit.dateTimeModified moves when the unit itself changes (activating and deactivating it included), and when its listings, appliances or filters change. It doesn't move when only the property changes, so the property of a row an incremental sync skipped can be out of date.
  • isVacant is 1 exactly when the unit has no current lease.
  • Paging: 25 rows per page by default, with no upper limit; see pageSize. Read pages until pagination-current-page is at or past pagination-total-pages; no match answers [].
  • GET /properties/{propertyID}/units/{unitID} - one unit
  • GET /properties/export - the property export
  • GET /leases/export - the lease export
Authorizations:
basicAuth
query Parameters
isActive
boolean

true (or 1, yes) for active units only, false (or 0, no) for inactive ones only. Leave it out for both; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01 10:00:00

Only records last modified at or after this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z (2024-01-01T10:00:00Z); a date alone means its midnight. For an incremental sync, send the dateTimeModified of the newest record the previous sync received. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-31 23:59:59

Only records last modified at or before this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z; a date alone means its midnight, so it leaves out the rest of that day. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25
Example: pageSize=100

Rows per page (default 25). There is no upper limit: a larger value returns up to that many rows in one response. 0, a negative number or a value that isn't a number is served at 15 rows per page.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

On a page with results: the page size in effect (the requested pageSize, default 25, no upper limit), or the number of matching rows when that is smaller.

pagination-total-items
integer
Example: "1"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The unit's own fields, its current lease, whether it's vacant, and its created and last-modified times.

required
object (property_export)

The property's own fields.

Response samples

Content type
application/json
[
  • {
    }
]

Applications

Rental applications, one page at a time, for copying them into another system. Filter by status, by whether a lease was created from the application, or by modification time, dateTimeModifiedMin and dateTimeModifiedMax, to fetch only the applications changed since your last export.

Export Applications

Lists the account's rental applications for export, one row per application with its applicants (names, email addresses and phone numbers), the unit applied for and the lease made from it, ordered by applicationID. Filter on dateTimeModifiedMin (and dateTimeModifiedMax) to fetch only the applications that changed since the last run, minding the Business Rules below.

Use Cases

  • Sync applications and applicants into a CRM, a data warehouse or a leasing tool
  • Find approved applications that have no lease yet (primaryApplicationStatusIDs[]=6&hasLease=false)
  • Pull the applications that changed since the last sync, page by page

Business Rules

  • Needs no permission: any API key on the account can call it, whatever its role.
  • Every filter narrows the result; a list filter matches any of its values. List values aren't checked: one that isn't a number matches no application rather than being ignored, so send numbers only.
  • Rate limited per API key, apart from the other exports: 60 an hour, of which 10 can be sent at once, then one a minute (see Rate Limits).
  • An application is exported only once it has a modification-time record, which the API, the manager portal and the applicant portal write when they create or change it: an application that has none is left out, whatever the filters.
  • The modified-time filters and the returned time differ. dateTimeModifiedMin and dateTimeModifiedMax filter on the application record's own last change, while application.dateTimeModified also moves when only an applicant changes. A row can therefore come back with a dateTimeModified later than the time the filter matched, and an application whose applicants alone changed since the last sync isn't returned by a dateTimeModifiedMin after its own last change. Don't build the next dateTimeModifiedMin from the returned application.dateTimeModified alone.
  • lease is the lease made from the application; its fields are null (and tenants an empty list) when there is none. unit's fields are all null for an application not tied to a unit.
  • Paging: 25 rows per page by default, with no upper limit; see pageSize. Read pages until pagination-current-page is at or past pagination-total-pages; no match answers [].
  • GET /screening/applications/{applicationID} - one application
  • GET /screening/applications - the application list
  • GET /leases/export - the lease export
Authorizations:
basicAuth
query Parameters
primaryApplicationStatusIDs[]
Array of strings or integers (primary_application_statuses_request)
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8

Only applications in these primary statuses. Send each as a separate primaryApplicationStatusIDs[]=; a single value without brackets is read as a one-item list.

applicationStatusIDs[]
Array of integers

Only applications in these application statuses, the account's own statuses (GET /screening/statuses (undocumented)). Send each as a separate applicationStatusIDs[]=.

hasLease
boolean

true (or 1, yes) for applications a lease was made from, false (or 0, no) for those with none. Leave it out for both; any other value is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01 10:00:00

Only applications whose own record last changed at or after this time, inclusive (see Business Rules: this is not always the returned application.dateTimeModified). Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z; a date alone means its midnight. A value that can't be read as a date is ignored, not refused: the response is then unfiltered by this bound.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-01-31 23:59:59

Only applications whose own record last changed at or before this time, inclusive. Send the time in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 ending in Z; a date alone means its midnight, so it leaves out the rest of that day. A value that can't be read as a date is ignored, not refused.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25
Example: pageSize=100

Rows per page (default 25). There is no upper limit: a larger value returns up to that many rows in one response. 0, a negative number or a value that isn't a number is served at 15 rows per page.

Responses

Response Headers
pagination-page-size
integer
Example: "1"

On a page with results: the page size in effect (the requested pageSize, default 25, no upper limit), or the number of matching rows when that is smaller.

pagination-total-items
integer
Example: "1"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The application's own fields, its applicants and its created and last-modified times.

required
object (application_unit_export)

The unit applied for. Every field is null when the application isn't tied to a unit.

required
object

The lease made from the application. Every field is null, and tenants an empty list, when there is none.

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

The chart of accounts: the general ledger accounts every transaction posts to, each of one type (accounts receivable, accounts payable, bank, asset, liability, equity, income, other income, expense or other expense). List, search, create, read and update accounts, and list the bank accounts.

List Accounts

Returns a page of chart-of-accounts accounts. Each row holds the full account row under account, and a token; with includes=parentAccount it holds the parent account instead of the token.

Use Cases

  • Load the chart of accounts, or the accounts of some types (bank accounts, income accounts), in one request: the page size defaults to 5000.
  • Find an account by its number or name with search.

Business Rules

  • Requires only authentication; no permission is checked.
  • The chart of accounts belongs to the whole account: portfolio restrictions don't apply.
  • search is a substring match on the account's number or name, for text without the characters &, ', ", < and >.
  • accountTypeID takes one type or a comma-separated list of types (spaces are ignored). accountTypes is read the same way, only when accountTypeID isn't sent. A value that isn't a number is ignored.
  • accountTypeIDs[] filters on a list of types too. When it and accountTypeID are both sent, both apply: an account must match each.
  • isActive reads 1, true and yes as active only and 0, false and no as inactive only; any other value is ignored. Without it, active and inactive accounts come back.
  • Sorted by account type, then by number compared as text (800 sorts after 1234).
  • The page size defaults to 5000; values above 5000 are served at 5000.
  • includes=parentAccount adds each account's parent under parentAccount and leaves out every account that has no parent. Those rows carry no token.

Available Includes (1)

  • parentAccount - the parent account (parentAccountID); accounts with no parent are left out
  • GET /accounting/accounts/search - a search with ID, escrow and modified-date filters, and each account's category
  • GET /accounting/accounts/{accountID} - one account, with includes
Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

Page number, from 1 (default 1).

pageSize
integer >= 1
Default: 5000
Example: pageSize=100

Items per page, from 1 (default 5000). Values above 5000 are served at 5000.

search
string
Example: search=Operating

Substring matched against the account's number and name. Send text without the characters &, ', ", < and >.

accountTypeID
string or integer
Example: accountTypeID=3,7

One account type, or a comma-separated list of types (3,7). A value that isn't a number is ignored.

  • 1 - Accounts Receivable
  • 2 - Accounts Payable
  • 3 - Bank
  • 4 - Asset
  • 5 - Liability
  • 6 - Equity
  • 7 - Income
  • 8 - Other Income
  • 9 - Expense
  • 10 - Other Expense
accountTypes
string or integer
Example: accountTypes=9

The same as accountTypeID, read only when accountTypeID isn't sent.

accountTypeIDs[]
Array of strings or integers (account_types_request)
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10
Example: accountTypeIDs[]=3&accountTypeIDs[]=7

Account types, each as a separate accountTypeIDs[]=. Applies together with accountTypeID: an account must match both.

isActive
string or integer or boolean
Example: isActive=1

1, true or yes for active accounts only; 0, false or no for inactive accounts only. Any other value is ignored.

includes
string
Example: includes=parentAccount

Comma-separated includes. One is available: parentAccount, which adds each account's parent and leaves out the accounts with none.

Responses

Response Headers
pagination-page-size
integer
Example: "5000"

Page size used -- the requested pageSize (default 5000), capped at 5000. Not reduced when fewer items match.

pagination-total-items
integer
Example: "3"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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.

object (account)

The parent account. Sent only with includes=parentAccount.

token
string^[0-9]+$

The time of the request as Unix seconds. Sent unless includes=parentAccount is requested.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (account)

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 page of chart-of-accounts accounts, each with its category. Each row holds the full account row under account and the account's category under accountCategory.

Use Cases

  • Find accounts by number or name with search, or look up known accounts with accountID or accountIDs[].
  • Sync the chart of accounts: fetch the accounts changed since a point in time with dateTimeModifiedMin.
  • List the escrow accounts with isEscrow=1.

Business Rules

  • Requires only authentication; no permission is checked.
  • The chart of accounts belongs to the whole account: portfolio restrictions don't apply.
  • search is a substring match on the account's name or number.
  • accountCategory is always sent. For an account with no category, each of its fields is null.
  • isActive and isEscrow read 1, true and yes as yes and 0, false and no as no; any other value is ignored. Without them, every account comes back.
  • List filters take each value as a separate name[]=.
  • Sorted by number (compared as text, so 800 sorts after 1234), then name, then accountID.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/accounts - the list with type filters, a 5000-row default page and the parent-account include
  • GET /accounting/accounts/{accountID} - one account, with includes
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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
Example: search=Operating

Substring matched against the account's name and number.

isActive
string or integer or boolean
Example: isActive=1

1, true or yes for active accounts only; 0, false or no for inactive accounts only. Any other value is ignored.

isEscrow
string or integer or boolean
Example: isEscrow=1

1, true or yes for escrow accounts only; 0, false or no for the others. Any other value is ignored.

accountTypeIDs[]
Array of strings or integers (account_types_request)
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10
Example: accountTypeIDs[]=3&accountTypeIDs[]=7

Account types, each as a separate accountTypeIDs[]=.

accountID
integer
Example: accountID=31

One account, by ID. A value that isn't a number, or 0, is ignored.

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

Accounts, by ID, each as a separate accountIDs[]=.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only accounts 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-31T23:59:59Z

Only accounts 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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.

required
object

The account's category. Every field is null when the account has no category.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (account)

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (account)

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (account)

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

A bank account's summary fields.

Response samples

Content type
application/json
[
  • {
    }
]

Bills

A bill is an amount owed to a vendor or another payee, with one or more charges, each against an account and a ledger. Create, list, read, update, approve, void and print bills, and search payables, one row per bill charge.

List Bills

Returns one page of bills, each with its payee contact, latest due date first.

Use Cases

  • Page through a payee's bills (contactID).
  • Find a bill by the payee's reference (search), or the bills dated in a range (startDate, endDate).

Business Rules

  • No permission is checked beyond a valid API key.
  • Voided bills are listed like any other; each row's bill.isVoided says which they are.
  • Sorted by dateDue, latest first; bills due the same day come in no set order, so paging through them can repeat some bills and skip others.
  • GET /accounting/bills/{billID} - One bill, with its charges and other includes.
  • GET /accounting/payables/search - Search bill charges, with more filters.
  • POST /accounting/bills - Create a bill.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=INV-204

Part of the bill's reference, matched anywhere in it. Empty means no filter.

contactID
integer
Example: contactID=210

Only the bills owed to this payee contact (a vendor from GET /vendors, or another contact). A non-numeric value is ignored.

startDate
string
Example: startDate=2026-03-01

Only bills dated (billDate) on or after this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

endDate
string
Example: endDate=2026-03-31

Only bills dated (billDate) on or before this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A bill: what is owed to a payee (a vendor, or the management company for a manager bill), with its dates and approval state. A bill holds no amounts itself: its charges are accounting transactions, one per ledger line (the charges include of GET /accounting/bills/{billID}, or GET /accounting/payables/search).

required
object (included_contact_left_joined)

The bill's payee contact. When the payee contact no longer exists, every field is null.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns one bill, with the related records the includes parameter asks for. A bill row holds no amounts: its lines are bill charge transactions (the charges include), one per ledger it charges.

Use Cases

  • Show a bill with its charges, payouts and markup or discount bills.
  • Check whether a bill still needs approval, and at which level (approvalRequirementType).

Business Rules

  • No permission is checked beyond a valid API key.
  • Portfolio restrictions: a restricted caller gets the bill when at least one of its transactions (charges, payout charges and lease charges, voided ones counted only on a voided bill) is in a portfolio of the caller's groups, or when the bill has none; otherwise 403 {"error": "Access Denied"}. The restrictions include says whether the caller reaches all of them (full) or only some (partial).
  • The charges, leaseCharges and payouts includes list every non-voided transaction of the bill whatever the caller's restrictions; each row's restricted is 1 when its portfolio is outside the caller's groups.
  • markupDiscount and approvalRequirementType are worked out from the bill charges the caller's restrictions reach: for a restricted caller who reaches only some of the charges, they reflect those charges alone, not the whole bill.
  • An ID with no bill answers 400 {"error": "Bill <id> not found"}.

Available Includes (14)

  • contact - The payee contact (null when it no longer exists).
  • charges - The bill's charges (bill charge transactions), each with its property, unit, portfolio, the portfolio's posting setting, ledger, restricted flag and payeeLedger.
  • bankAccount - {"bankAccountID": ...}: the operating bank account the charges' posting settings share; bankAccountID is null when they differ or a charge has no portfolio. Only with charges in the same request; alone it adds nothing.
  • leaseCharges - Lease charges billed to tenants from this bill, latest first, with property, unit, ledger and restricted.
  • payouts - Payout charges toward this bill, latest first, with property, unit, payout and restricted.
  • workOrder - The bill's work order. Left out of the response, not null, when the bill has none.
  • parentBill - For a markup or discount bill, the bill it was generated from; null otherwise.
  • discountBill - The discount bill generated from this bill, or null.
  • markupBill - The markup bill generated from this bill, or null.
  • markupDiscount - The bill's markup and discount totals, as JSON numbers.
  • utility - The utility of a utility bill, or null.
  • property - The bill's property (propertyID), or null when it has none.
  • restrictions - How much of the bill the caller's portfolio restrictions reach.
  • approvalRequirementType - The approval the bill needs, or null.
  • GET /accounting/bills - List bills.
  • GET /accounting/payables/search - Search bill charges across bills.
  • GET /accounting/bills/{billID}/print - The bill as a PDF.
  • POST /accounting/bills/{billID} - Update the bill.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15054

The bill. A well-formed ID with no record answers 400; a value that isn't a number answers 404.

query Parameters
includes
string
Example: includes=contact,charges,bankAccount,markupDiscount,approvalRequirementType

Comma-separated related records to add: contact, charges, bankAccount (with charges), leaseCharges, payouts, workOrder, parentBill, discountBill, markupBill, markupDiscount, utility, property, restrictions, approvalRequirementType. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (bill_record)

A bill: what is owed to a payee (a vendor, or the management company for a manager bill), with its dates and approval state. A bill holds no amounts itself: its charges are accounting transactions, one per ledger line (the charges include of GET /accounting/bills/{billID}, or GET /accounting/payables/search).

included_contact_accounting (object) or null

The payee contact, or null when it no longer exists. Requires the contact include.

Array of objects (bill_charge_row)

The bill's non-voided charges. Requires the charges include.

object

Requires the charges and bankAccount includes.

Array of objects (bill_lease_charge_row)

Lease charges billed from this bill, latest posting date first. Requires the leaseCharges include.

Array of objects (bill_payout_row)

Payout charges toward this bill, latest posting date first. Requires the payouts include.

included_work_order (object) or null

The bill's work order. Requires the workOrder include; left out when the bill has none, and null when it names a work order that no longer exists.

bill_record (object) or null

The bill this markup or discount bill was generated from, or null. Requires the parentBill include.

bill_record (object) or null

The discount bill generated from this bill, or null. Requires the discountBill include.

bill_record (object) or null

The markup bill generated from this bill, or null. Requires the markupBill include.

object

The bill's markup and discount totals, as JSON numbers. In Bill management fee mode they are the charge totals of its markup and discount bills; in Ledger mode the sums of its charges' markupAmount and discountAmount. Only the non-voided charges the caller's restrictions reach are counted, so a restricted caller who reaches some of the charges gets their totals, not the whole bill's. Requires the markupDiscount include.

object or null

The utility of a utility bill, or null. Requires the utility include.

included_property (object) or null

The bill's property (propertyID), or null when it has none. Requires the property include.

object

Requires the restrictions include.

approvalRequirementType
integer or null
Enum: 1 2 null

The approval the bill needs, a JSON number: null when bill approval is off, the bill's total is at or under the minimum threshold, or the payee is exempt; a markup or discount bill takes its parent bill's. The total compared with the thresholds counts only the non-voided charges the caller's restrictions reach. Requires the approvalRequirementType include.

  • 1 - Standard
  • 2 - Master (the total is at or over the maximum threshold)

Response samples

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (bill)

Response samples

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

Print Bill

Returns the bill as a PDF: the bill, its payee, and its non-voided charges with their property, unit, ledger and charge account.

Use Cases

  • Download a printable copy of a bill to file with the vendor's invoice.
  • Print one portfolio's share of a bill split across portfolios (portfolioID).

Business Rules

  • No permission is checked beyond a valid API key. The charges printed are only those in portfolios the caller may access.
  • The body is the PDF itself (application/pdf), not JSON.
  • An ID with no bill answers 400 {"error": "Bill <id> not found"}.
  • GET /accounting/bills/{billID} - The bill as JSON.
  • GET /accounting/bills - List bills.
Authorizations:
basicAuth
path Parameters
billID
required
integer
Example: 15054

The bill. A well-formed ID with no record answers 400; a value that isn't a number answers 404.

query Parameters
portfolioID
integer
Example: portfolioID=12

Print only the charges in this portfolio. Without it, every charge the caller may access is printed.

Responses

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

Always 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/pdf
string <binary>

Response samples

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

Search Payables

Returns one page of bill charges, one row per charge (a bill with charges on three ledgers has three rows), each with a summary of its bill, approval assignee, ledger, portfolio, property, unit, charge account and payee.

Use Cases

  • Build a payables queue: unpaid (isPaid=false), unapproved (isApproved=false) or needing master approval (requiresMasterApproval=true) charges, by due date or payee.
  • Find the open charges of a set of properties or portfolios.

Business Rules

  • No permission is checked beyond a valid API key. A caller restricted to portfolio groups gets only the charges in those groups' portfolios.
  • Default sort: transaction.datePosted latest first. Every sort ends with the charge's ID ascending, which is also the whole order when orderBy names no known column.
  • Each list filter (payeeContactIDs[], portfolioIDs[], propertyIDs[], unitIDs[], assignedToUserIDs[], billApprovalAssigneeUserIDs[], tagIDs[]) takes several values, each as its own name[]= (propertyIDs[]=101&propertyIDs[]=102). payeeContactID, portfolioID, propertyID and unitID give one value, used only when the list form is absent.
  • The yes/no filters accept true, false, 1, 0, yes and no; any other value is ignored (no filter).
  • GET /accounting/bills/{billID} - One bill, with its charges and other includes.
  • GET /accounting/bills - List bills (one row per bill).
Authorizations:
basicAuth
query Parameters
search
string
Example: search=HVAC

Text matched anywhere in the charge's description, the ledger's name, the portfolio's name, the property's address, the bill's reference or the payee's name, or equal to the charge's amount.

isVoided
string or integer or boolean
Example: isVoided=0

1, true or yes: only voided charges; 0, false or no: only charges that aren't voided. Absent, or any other value: both.

isApproved
string or integer or boolean
Example: isApproved=0

1, true or yes: only charges of approved bills; 0, false or no: only of unapproved bills. Absent, or any other value: both.

isPaid
string or integer or boolean
Example: isPaid=0

1, true or yes: only fully paid charges (amountPaid equals amount); 0, false or no: only charges with a balance (amountPaid below amount). Absent, or any other value: both.

isChildBill
string or integer or boolean

1, true or yes: only charges of markup and discount bills (bills with a parentBillID); 0, false or no: only of other bills. Absent, or any other value: both.

requiresMasterApproval
string or integer or boolean
Example: requiresMasterApproval=1

1, true or yes: only charges of bills that need master approval: unapproved, not a markup or discount bill, with non-voided charges totaling at least the account's bill approval maximum threshold. Ignored when no maximum threshold is set, and for any other value.

amountMin
number
Example: amountMin=100

Only charges whose amount is at least this. A non-numeric value is ignored.

amountMax
number
Example: amountMax=5000

Only charges whose amount is at most this. A non-numeric value is ignored.

datePostedMin
string
Example: datePostedMin=2026-01-01

Only charges posted on or after this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

datePostedMax
string
Example: datePostedMax=2026-04-30

Only charges posted on or before this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

billDateMin
string

Only charges of bills dated on or after this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

billDateMax
string

Only charges of bills dated on or before this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

dateDueMin
string

Only charges of bills due on or after this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

dateDueMax
string

Only charges of bills due on or before this day, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

ledgerTypeID
string or integer (ledger_types_request)
Enum: "1" "2" "3" "4" 1 2 3 4
Example: ledgerTypeID=3

Only charges on ledgers of this type.

payeeContactIDs[]
Array of integers
Example: payeeContactIDs[]=200&payeeContactIDs[]=201

Only charges of bills owed to these payee contacts; send each as its own payeeContactIDs[]=.

payeeContactID
integer

As payeeContactIDs[] with one contact; ignored when payeeContactIDs[] is sent.

portfolioIDs[]
Array of integers

Only charges in these portfolios; send each as its own portfolioIDs[]=.

portfolioID
integer

As portfolioIDs[] with one portfolio; ignored when portfolioIDs[] is sent.

propertyIDs[]
Array of integers

Only charges on these properties; send each as its own propertyIDs[]=.

propertyID
integer

As propertyIDs[] with one property; ignored when propertyIDs[] is sent.

unitIDs[]
Array of integers

Only charges on these units; send each as its own unitIDs[]=.

unitID
integer

As unitIDs[] with one unit; ignored when unitIDs[] is sent.

assignedToUserIDs[]
Array of integers

Only charges on properties assigned to these users; send each as its own assignedToUserIDs[]=.

billApprovalAssigneeUserIDs[]
Array of integers

Only charges of bills whose approval is assigned to these users; -1 also matches bills with no assignee. Send each as its own billApprovalAssigneeUserIDs[]=.

tagIDs[]
Array of integers

Only charges of bills with any of these tags; send each as its own tagIDs[]=.

orderBy
string
Example: orderBy=transaction.amount|desc

Sort column, optionally followed by |asc (the default) or |desc; several, comma-separated, sort in turn. Columns: bill.dateTimeCreated, bill.billDate, bill.dateDue, bill.reference, contact.name, ledger.name, property.name, transaction.datePosted, transaction.amount, transaction.amountPaid, billApprovalAssigneeUser.name (last name, then first name), chargeAccount.number (number, then name). Unknown columns are ignored. Default transaction.datePosted|desc.

page
integer
Default: 1
Example: page=1

Page number, from 1 (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25), with no upper limit. A value of 0 or below is read as 15.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Items on a full page -- the requested pageSize (default 25), or the total item count when that is smaller, when anything matches. When nothing matches, read pagination-total-items (0) instead.

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
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The charge's bill.

required
object

The approval assignee; every key null when the bill has none.

required
object

The bill charge.

required
object

The ledger the charge is on.

required
object

The charge's portfolio; every key null when it has none.

required
object

The charge's property; every key null when it has none.

required
object

The charge's unit; every key null when it has none.

required
object

The chart-of-accounts account charged; every key null when there is none.

required
object

The bill's payee.

Response samples

Content type
application/json
[
  • {
    }
]

Deposits

A deposit groups payments you received into one bank deposit, as it appears on the bank statement. Create, list, search, read, update, void and print deposits, add transactions to one, reconcile or unreconcile it, and list the transactions not yet deposited into a bank account.

List Deposits

Returns one page of a bank account's deposits, oldest created first. Each item holds the deposit record and a token. For filters on amount, date, voided and reconciled state, and a text search, use GET /accounting/deposits/search.

Use Cases

  • List the deposits made into one bank account.

Business Rules

  • No permission is checked beyond a valid API key.
  • bankAccountID is the only filter: without it, every bank account's deposits are listed. Voided deposits are included.
  • Deposits come back in the order they were created (dateTimeCreated, oldest first).
  • A key restricted to some portfolios sees only the deposits holding at least one non-voided payment in those portfolios; a deposit with no payments is left out for it.
  • GET /accounting/deposits/search - Search deposits with more filters.
  • GET /accounting/deposits/{depositID} - Retrieve one deposit, with its lines.
Authorizations:
basicAuth
query Parameters
bankAccountID
integer
Example: bankAccountID=12

Only the deposits into this bank account (GET /accounting/bank-accounts). Left out, every bank account's deposits are listed.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

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

Response samples

Content type
application/json
[
  • {
    }
]

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 one page of deposits matching the filters, newest deposit date first. Each item holds the deposit, its bank account, and the reconciliation it is in.

Use Cases

  • Find deposits by amount or date range for an audit.
  • List the deposits not yet reconciled (isReconciled=false), or those in one reconciliation.
  • Search a deposit by its number, description, exact amount or bank account.

Business Rules

  • No permission is checked beyond a valid API key.
  • The filters combine with AND. A filter left out filters nothing.
  • Sorted by dateDeposited, newest first, then by depositID, highest first.
  • Voided deposits are included unless isVoided=false.
  • A key restricted to some portfolios sees only the deposits holding at least one non-voided payment in those portfolios; a deposit with no payments is left out for it.
  • GET /accounting/deposits - A bank account's deposits in the order they were created.
  • GET /accounting/deposits/{depositID} - Retrieve one deposit, with its lines.
  • GET /accounting/bank-accounts - The bank accounts to filter by.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=2024-0165

Matches deposits whose depositNumber or description contains the text, whose amount equals it exactly, or whose bank account's number, name or bank name contains it. The amount is compared as a number, so text that isn't a number also matches every deposit of 0.00.

bankAccountIDs[]
Array of integers
Example: bankAccountIDs[]=12&bankAccountIDs[]=15

Only the deposits into these bank accounts (GET /accounting/bank-accounts). Send each ID as its own bankAccountIDs[]=. Takes precedence over bankAccountID.

bankAccountID
integer
Example: bankAccountID=12

Only the deposits into this bank account. Read only when bankAccountIDs[] is left out.

isVoided
string
Example: isVoided=false

true (or 1, yes) for voided deposits only, false (or 0, no) for the others. Any other value filters nothing.

isReconciled
string
Example: isReconciled=false

true (or 1, yes) for deposits in a reconciliation, false (or 0, no) for those not reconciled. Any other value filters nothing.

amountMin
string <decimal>
Example: amountMin=1000.00

Only deposits of at least this amount.

amountMax
string <decimal>
Example: amountMax=10000.00

Only deposits of at most this amount.

dateDepositedMin
string
Example: dateDepositedMin=2024-01-01

Only deposits made on or after this date, as YYYY-MM-DD or MM/DD/YYYY.

dateDepositedMax
string
Example: dateDepositedMax=2024-12-31

Only deposits made on or before this date, as YYYY-MM-DD or MM/DD/YYYY.

reconciliationIDs[]
Array of integers
Example: reconciliationIDs[]=88&reconciliationIDs[]=89

Only the deposits in these reconciliations (GET /accounting/reconciliations). Send each ID as its own reconciliationIDs[]=. Takes precedence over reconciliationID.

reconciliationID
integer
Example: reconciliationID=88

Only the deposits in this reconciliation. Read only when reconciliationIDs[] is left out.

page
integer
Default: 1

The page number for pagination

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: "2"

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: "3"

Total number of items across all pages; 0 when nothing matches

pagination-total-pages
integer
Example: "2"

Total number of pages

pagination-current-page
integer
Example: "1"

Current page number

pagination-next-page
integer
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 (account)

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.

required
object (included_reconciliation_left_joined)

A bank reconciliation reached through a left join, as a deposit search row's reconciliation is: every column of the reconciliation row, all of them null when the deposit isn't reconciled. A reconciliation matches a bank account's entries against one bank statement; its totals are decimal strings.

Response samples

Content type
application/json
[
  • {
    }
]

List Undeposited Transactions

Returns everything waiting to be deposited into a bank account: its payments not yet in a deposit, and its bulk payments not yet in a deposit. The list isn't paginated: every match comes back in one array, with no pagination headers.

Each item is one line, told apart by transaction.depositTransactionTypeID:

  • 1, a payment: a tenant receipt, owner receipt or other receipt into the bank account that is not voided, not deposited, not part of a bulk payment and not taken through a payment gateway.
  • 2, a bulk payment: a bulk payment into the bank account that is not voided and not deposited. Its ledger, property and unit objects have every key null.

Use Cases

  • Pick the payments and bulk payments for a new deposit.
  • Show what one user recorded that still has to be deposited (createdByUserID).

Business Rules

  • No permission is checked beyond a valid API key.
  • bankAccountID is required and must be a bank account; otherwise the API answers 400 (see the examples).
  • Sorted by posting date, newest first; on the same date payments come before bulk payments, then the higher ID first.
  • A key restricted to some portfolios gets only the payments inside those portfolios, and no bulk payments.
  • GET /accounting/bank-accounts - The bank accounts to list for.
  • POST /accounting/deposits - Create a deposit from these lines.
  • POST /accounting/deposits/{depositID}/transactions - Add these lines to a deposit.
Authorizations:
basicAuth
query Parameters
bankAccountID
required
integer
Example: bankAccountID=31

The bank account to list for (GET /accounting/bank-accounts). A value that isn't a number counts as missing.

createdByUserID
integer
Example: createdByUserID=42

Only the lines this user recorded: a payment whose history's create entry names the user, or a bulk payment the user created.

transactionTypeID
integer
Example: transactionTypeID=2

Only payments of this transaction type: 2 (Tenant Receipt), 5 (Owner Receipt) or 12 (Other Receipt). Bulk payments have no transaction type, so this filter leaves them out.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

One line of a deposit or of the undeposited list: a payment transaction, or a bulk payment taken as a whole. The two kinds are told apart by depositTransactionTypeID; the transaction keys are null on a bulk payment line and the bulk payment keys are null on a payment line.

required
object (deposit_row_ledger)

The ledger a deposit line's payment posts to. Every key is null on a bulk payment line, or when the payment has no ledger.

required
object

Who paid.

required
object (deposit_row_property)

The property of a deposit line's payment. Every key is null on a bulk payment line, or when the payment has no property.

required
object (deposit_row_unit)

The unit of a deposit line's payment. Every key is null on a bulk payment line. When the payment has no unit, every key except countryID (taken from the payment's property) is null.

required
object

Who recorded the line.

Response samples

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

Get Deposit

Retrieves one deposit. The response always holds the deposit; the includes parameter adds its lines, its reconciliations and the caller's access to it.

Use Cases

  • Show a deposit with the payments and bulk payments it holds.
  • Check whether a deposit is reconciled before changing or voiding it.

Business Rules

  • No permission is checked beyond a valid API key.
  • A key restricted to some portfolios is checked against the deposit's non-voided payments together with the payments that make up its non-voided bulk payments. When none of them is in the key's portfolios, it gets 403 Access Denied.
  • When some of them are in a restricted key's portfolios, the deposit is served (restrictions.access partial, or full when all are), and its transactions include lists only the payments inside them.
  • A deposit with no non-voided payment and no non-voided bulk payment (one whose payments are all voided, for example) is served to every key, with access full.
  • A well-formed ID with no deposit answers 400 Deposit {depositID} not found; a value that isn't a number answers the stock 404.

Available Includes (4)

  • transactions - The deposit's lines: each non-voided payment in it and each non-voided bulk payment, newest posting date first, payments before bulk payments on the same date. A restricted key gets only the payments inside its portfolios, and no bulk payments.
  • reconciliation - The reconciliation the deposit is in, or null.
  • previousReconciliation - The reconciliation the deposit was in before it was last unreconciled, or null.
  • restrictions - The caller's access to the deposit: full, or partial when only some of its payments are inside a restricted key's portfolios.
  • GET /accounting/deposits/search - Find deposits.
  • POST /accounting/deposits/{depositID} - Update this deposit.
  • GET /accounting/deposits/{depositID}/print - Print this deposit's slip.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The deposit's ID, from GET /accounting/deposits/search.

query Parameters
includes
string
Example: includes=transactions,reconciliation

Comma-separated list of related data to add: 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 (deposit_transaction_row)

The deposit's lines. Requires the transactions include; an empty array when it has none.

included_reconciliation (object) or null

The reconciliation the deposit is in, or null. Requires the reconciliation include.

included_reconciliation (object) or null

The reconciliation the deposit was in before it was last unreconciled, or null. Requires the previousReconciliation include.

object

The caller's access to the deposit. Requires the restrictions include.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the deposit.

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

The bank account the deposit was made into (GET /accounting/bank-accounts).

reconciliationID
required
string or null^-?[0-9]+$

The reconciliation this deposit is linked to, or null if unreconciled.

previousReconciliationID
required
string or null^-?[0-9]+$

The reconciliation the deposit was in before it was last unreconciled; cleared (null) when it is reconciled again.

depositNumber
required
string or null <= 100 characters

A user-assigned reference number for the deposit. New deposits always have one; older deposits can have none (null).

description
required
string or null <= 1000 characters

Optional free-text description.

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

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 the deposit's slip as a PDF and streams it as the response body (Content-Type: application/pdf), with no JSON envelope.

Use Cases

  • Download a deposit slip to take to the bank or keep with the bank records.

Business Rules

  • No permission is checked beyond a valid API key.
  • A key restricted to some portfolios is checked against the deposit's non-voided payments together with the payments that make up its non-voided bulk payments. When none of them is in the key's portfolios, it gets 403 Access Denied; a deposit with neither (one whose payments are all voided, for example) is printed for every key.
  • For a deposit with payments both inside and outside a restricted key's portfolios, the slip lists only the payments inside them, while the deposit's amount at the top stays the full amount: the listed lines then add up to less than it.
  • A well-formed ID with no deposit answers 400 Deposit {depositID} not found, as JSON; a value that isn't a number answers the stock 404.
  • GET /accounting/deposits/{depositID} - The same deposit as JSON.
Authorizations:
basicAuth
path Parameters
depositID
required
integer
Example: 4210

The deposit's ID, from GET /accounting/deposits/search.

Responses

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

Always 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/pdf
string <binary>

Response samples

Content type
application/json
{
  • "error": "Deposit 999999999 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

An invoice is a vendor's bill before it becomes a bill in Rentvine: a PDF or image uploaded to Rentvine, whose details Rentvine reads from the file, or line items a vendor entered in Rentvine. List, read and print invoices, upload one, and decline one; an accepted invoice is converted into a bill in the Rentvine app.

List Invoices

Returns one page of invoices, newest first. An invoice is a bill received from a vendor: a file uploaded (through the vendor portal, an upload, email or the mobile app) and read by the invoice prediction service, or line items entered in Rentvine, waiting to be converted to a bill or declined. Each row carries the invoice and a summary of its file, payee, work order, bill and submitter.

Use Cases

  • Show the invoices waiting for review (invoiceStatusIDs[]=2).
  • Find the invoices of a payee, a work order or a bill.

Business Rules

  • Sorted by dateTimeCreated, newest first; invoices created in the same second come in no set order, so paging through them can repeat some invoices and skip others.
  • Each filter with a plural form takes several values, each as its own name[]= (invoiceStatusIDs[]=1&invoiceStatusIDs[]=2). The singular form is used only when the plural one is absent.
  • The related summaries (invoiceFile, contact, workOrder, bill, submittedBy, property, createdInvoice) are always present; their keys are null when the invoice has no such record.
  • GET /accounting/invoices/{invoiceID} - One invoice, with its line items and includes.
  • GET /accounting/invoices/{invoiceID}/print - An invoice as a PDF.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Northwind

Text matched against the invoice's reference and predicted reference (from the start), the submitter's email and first or last name, the payee's name, the predicted payee name and ledger address (anywhere), and the predicted amount and the line-item total (equal, or from the start).

invoiceStatusIDs[]
Array of strings or integers (invoice_statuses_request)
Items Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
Example: invoiceStatusIDs[]=2

Only invoices in these statuses; send each as its own invoiceStatusIDs[]=.

invoiceStatusID
string or integer (invoice_statuses_request)
Enum: "1" "2" "3" "4" "5" 1 2 3 4 5

Only invoices in this status; ignored when invoiceStatusIDs[] is sent.

payeeContactIDs[]
Array of integers
Example: payeeContactIDs[]=210

Only invoices owed to these payee contacts; send each as its own payeeContactIDs[]=.

payeeContactID
integer

Only invoices owed to this payee contact; ignored when payeeContactIDs[] is sent.

assignedToUserIDs[]
Array of integers

Only invoices assigned to these users: the user assigned to the invoice's work order, or to the property of its predicted ledger. -1 also matches invoices with no assignee. Send each as its own assignedToUserIDs[]=.

assignedToUserID
integer

As assignedToUserIDs[] with one user; ignored when assignedToUserIDs[] is sent.

workOrderIDs[]
Array of integers

Only invoices for these work orders: the invoice's work order, or the predicted one when it has none. Send each as its own workOrderIDs[]=.

workOrderID
integer

As workOrderIDs[] with one work order; ignored when workOrderIDs[] is sent.

billIDs[]
Array of integers

Only invoices converted to these bills; send each as its own billIDs[]=.

billID
integer

As billIDs[] with one bill; ignored when billIDs[] is sent.

dateCreatedMin
string
Example: dateCreatedMin=2026-01-01

Only invoices created on or after this day in the account's time zone, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

dateCreatedMax
string
Example: dateCreatedMax=2026-01-31

Only invoices created on or before this day in the account's time zone, YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is ignored.

page
integer
Default: 1
Example: page=1

Page number, from 1 (default 1). A value below 1 is read as 1.

pageSize
integer >= 1
Default: 25
Example: pageSize=25

Items per page, from 1 (default 25), with no upper limit.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Items on a full page -- the requested pageSize (default 25), or the total item count when that is smaller, when anything matches. When nothing matches, read pagination-total-items (0) instead.

pagination-total-items
integer
Example: "74"

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
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The invoice's own columns.

required
object

The uploaded file; every key null when the invoice has none.

required
object

The payee contact; every key null when the invoice has none yet.

required
object

The invoice's work order, or the predicted one when it has none; every key null when there is neither.

required
object

The bill the invoice was converted to; every key null before conversion.

required
object

Who submitted the invoice.

required
object

Where the work goes and what it totals. The address and ledger are those of the work order's unit, else its property; null without a work order.

required
object

The property of the invoice's predicted ledger (its own, or its unit's).

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns one invoice with its line items, and the related records the includes parameter asks for.

Use Cases

  • Review an invoice before converting it to a bill or declining it.
  • Read the invoice prediction service's result for an uploaded invoice (predictedInvoice).

Business Rules

  • lineItems is always sent. A created invoice (invoiceTypeID 2) lists its own line items; an uploaded one lists the line items its prediction holds, each field unwrapped from the prediction's value (null when the prediction has none).
  • unit, property, lease and ledger are read from the invoice's work order: they need workOrder in the same request, and are left out when the invoice has no work order or the work order has no such record.
  • An ID with no invoice answers 400 {"error": "Invoice <id> not found"}.

Available Includes (9)

  • contact - The payee contact (the predicted payee when none is set), or false when there is neither.
  • predictedInvoice - The prediction service's record for the invoice, or null.
  • invoiceFile - The uploaded file, or false when there is none.
  • files - Files attached to the invoice and shared with the vendor, each with its attachment.
  • workOrder - The invoice's work order, or null.
  • unit - The work order's unit (with workOrder).
  • property - The work order's property (with workOrder).
  • lease - The work order's lease (with workOrder).
  • ledger - The ledger of the work order's unit, else of its property, or null (with workOrder).
  • GET /accounting/invoices - List invoices.
  • GET /accounting/invoices/{invoiceID}/print - The invoice as a PDF.
  • POST /accounting/invoices/{invoiceID}/decline - Decline the invoice.
Authorizations:
basicAuth
path Parameters
invoiceID
required
integer
Example: 8850

The invoice. A well-formed ID with no record answers 400; a value that isn't a number answers 404.

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

Comma-separated related records to add: contact, predictedInvoice, invoiceFile, files, workOrder, and with workOrder, unit, property, lease and ledger. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (invoice_record)

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)

The invoice's line items; the shape depends on the invoice type.

included_contact_accounting (object) or boolean or null

The payee contact, else the predicted payee contact; false (not null) when the invoice has neither, and null when it names a contact that no longer exists. Requires the contact include.

invoice_predicted_invoice (object) or null

The prediction service's record for the invoice, or null. Requires the predictedInvoice include.

file (object) or boolean or null

The uploaded file; false (not null) when the invoice has none, and null when it names a file that no longer exists. Requires the invoiceFile include.

Array of objects

Files attached to the invoice and shared with the vendor. Requires the files include.

included_work_order (object) or null

The invoice's work order, or null. Requires the workOrder include.

included_unit (object) or null

The work order's unit. Requires the workOrder and unit includes; left out when there is none, and null when the work order names one that no longer exists.

included_property (object) or null

The work order's property. Requires the workOrder and property includes; left out when there is none, and null when the work order names one that no longer exists.

included_lease (object) or null

The work order's lease. Requires the workOrder and lease includes; left out when there is none, and null when the work order names one that no longer exists.

included_ledger (object) or null

The ledger of the work order's unit, else of its property; null when that unit or property has none. Requires the workOrder and ledger includes; left out when the work order has neither.

Response samples

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

Print Invoice

Returns the invoice as a PDF: the payee, the line items and their total, and the work order with its unit, property, lease and ledger when it has one.

Use Cases

  • Download a printable copy of an invoice.

Business Rules

  • The body is the PDF itself (application/pdf), not JSON.
  • An ID with no invoice answers 400 {"error": "Invoice not found"}.
  • Only an invoice with a payee contact (payeeContactID set) can be printed. An uploaded invoice whose payee isn't set yet has none, even when GET /accounting/invoices/{invoiceID} shows a predicted payee.
  • GET /accounting/invoices/{invoiceID} - The invoice as JSON.
Authorizations:
basicAuth
path Parameters
invoiceID
required
integer
Example: 8850

The invoice. A well-formed ID with no record answers 400; a value that isn't a number answers 404.

Responses

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

Always 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A ledger is the set of books an amount belongs to: your management company's own (Manager), a portfolio's, a property's or a unit's. Every transaction entry posts to one ledger. List and search 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Response samples

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

Search Ledgers

Returns a page of ledgers. Each row holds the ledger under ledger and, for a unit's ledger, the unit under unit.

Use Cases

  • Find ledgers by name with search, narrowed to some types with ledgerTypeIDs[].
  • Look up known ledgers with ledgerID or ledgerIDs[].
  • Sync ledgers changed since a point in time with dateTimeModifiedMin.

Business Rules

  • Requires only authentication; no permission is checked.
  • A key restricted to some portfolios gets only the ledgers in those portfolios.
  • Only ledgers whose portfolio, property or unit still exists come back: a property or unit ledger also needs its portfolio and that portfolio's ledger. A manager ledger always qualifies.
  • isActive reads 1, true and yes as active only and 0, false and no as inactive only; any other value is ignored. Without it, active and inactive ledgers come back.
  • search is a substring match on the ledger's name.
  • ledgerTypeID (one type) is read only when ledgerTypeIDs[] isn't sent.
  • unit is always sent. For a ledger that isn't a unit's (ledgerTypeID other than 4), each of its fields is null.
  • Sorted by name (ignoring case), then by ledgerID, newest first.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/ledgers - an unpaged ledger lookup by name or ID, active ledgers only
  • GET /accounting/ledgers/{ledgerID} (undocumented) - one ledger, with includes
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Operating

Substring matched against the ledger's name.

isActive
string or integer or boolean
Example: isActive=1

1, true or yes for active ledgers only; 0, false or no for inactive ledgers only. Any other value is ignored.

ledgerID
integer
Example: ledgerID=100

One ledger, by ID. A value that isn't a number, or 0, is ignored.

ledgerIDs[]
Array of integers
Example: ledgerIDs[]=100&ledgerIDs[]=101

Ledgers, by ID, each as a separate ledgerIDs[]=.

ledgerTypeIDs[]
Array of strings or integers (ledger_types_request)
Items Enum: "1" "2" "3" "4" 1 2 3 4
Example: ledgerTypeIDs[]=3&ledgerTypeIDs[]=4

Ledger types, each as a separate ledgerTypeIDs[]=; a single ledgerTypeIDs=3 (no brackets) is read as a one-item list.

ledgerTypeID
string or integer (ledger_types_request)
Enum: "1" "2" "3" "4" 1 2 3 4
Example: ledgerTypeID=4

One ledger type. Read only when ledgerTypeIDs[] isn't sent.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only ledgers 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-31T23:59:59Z

Only ledgers 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.

page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

An accounting ledger (every column of the row; the shared ledger model lacks the timestamps).

required
object

The unit, for a unit's ledger. Every field is null for any other ledger.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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)

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Transactions are the accounting records: lease charges, payments and credits, bills, journal entries, ledger transfers and the rest, each made of debit and credit entries. Search transactions and read one; post lease charges, payments, refunded returns, deposit-release credits and payouts; record other payments; void and return lease transactions; and search journal entries, ledger transfers and their recurring schedules.

Search Transactions

Returns one page of accounting transactions of every type, newest posting date first. Each row holds the transaction's main columns, its primary ledger, property, portfolio and unit, and the names of the ledgers its entries post to.

Use Cases

  • Find transactions by date range, amount or text for an audit.
  • List the transactions of some types (transactionTypeIDs[]), properties or ledgers.
  • Pull the transactions changed since a time, for a sync (dateTimeModifiedMin).

Business Rules

  • No permission is checked beyond a valid API key.
  • The filters combine with AND. A filter left out filters nothing. Voided transactions are included unless isVoided=false.
  • A date, datetime or amount filter whose value can't be read (datePostedMin=garbage, amountMin=abc) is ignored: the list comes back as if that filter were left out.
  • Sorted by datePosted, newest first, then by transactionID, highest first.
  • A key restricted to some portfolios gets the transactions of those portfolios, and the ledger transfers of other portfolios with a non-voided entry in them.
  • property, portfolio, unit and ledger are always sent; each of their keys is null when the transaction names none.
  • GET /accounting/transactions/{transactionID} - One transaction, with its entries.
  • GET /accounting/transactions/entries/search - Search the debit and credit lines instead.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Water

Matches transactions whose description, property name, property address or primary ledger name contains the text, or whose amount equals it exactly.

isVoided
string
Example: isVoided=false

true (or 1, yes) for voided transactions only, false (or 0, no) for the others only. Any other value filters nothing.

amountMin
string <decimal>
Example: amountMin=100.00

Only transactions of at least this amount.

amountMax
string <decimal>
Example: amountMax=5000.00

Only transactions of at most this amount.

datePostedMin
string
Example: datePostedMin=2024-01-01

Only transactions posted on or after this date, as YYYY-MM-DD or MM/DD/YYYY.

datePostedMax
string
Example: datePostedMax=2024-12-31

Only transactions posted on or before this date, as YYYY-MM-DD or MM/DD/YYYY.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-10-01 00:00:00

Only transactions changed at or after this time, in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 with no offset.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-10-31 23:59:59

Only transactions changed at or before this time, in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 with no offset.

transactionTypeIDs[]
Array of integers
Example: transactionTypeIDs[]=12&transactionTypeIDs[]=15

Only the transactions of these types (the values of transaction.transactionTypeID). Send each ID as its own transactionTypeIDs[]=. Takes precedence over transactionTypeID.

transactionTypeID
integer
Example: transactionTypeID=12

The same filter for one ID, read only when transactionTypeIDs[] is left out.

propertyIDs[]
Array of integers
Example: propertyIDs[]=12&propertyIDs[]=15

Only the transactions of these properties (GET /properties). Send each ID as its own propertyIDs[]=. Takes precedence over propertyID.

propertyID
integer
Example: propertyID=12

The same filter for one ID, read only when propertyIDs[] is left out.

primaryLedgerIDs[]
Array of integers
Example: primaryLedgerIDs[]=12&primaryLedgerIDs[]=15

Only the transactions of these ledgers (GET /accounting/ledgers/search). Send each ID as its own primaryLedgerIDs[]=. Takes precedence over primaryLedgerID.

primaryLedgerID
integer
Example: primaryLedgerID=12

The same filter for one ID, read only when primaryLedgerIDs[] is left out.

page
integer
Default: 1

The page number for pagination

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: "2"

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: "16"

Total number of items across all pages; 0 when nothing matches

pagination-total-pages
integer
Example: "8"

Total number of pages

pagination-current-page
integer
Example: "1"

Current page number

pagination-next-page
integer
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The transaction's main columns.

required
object

The primary ledger. Both fields are null when the transaction has none.

required
object

The transaction's property. Every field is null when it names none.

required
object

The transaction's portfolio. Both fields are null when it names none, as on a ledger transfer.

required
object

The transaction's unit. Every field is null when it names none.

required
object

What the transaction's entries post to.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Get Lease Charge

Returns one lease charge: the amount, what has been paid on it (amountPaid), its account, dates and management-fee settings, under transaction, plus any related records the includes parameter asks for.

Use Cases

  • Checking what is still owed on a charge (amount minus amountPaid) and which payments and credits paid it (receipts).
  • Reading a charge before changing or voiding it.
  • Finding the sales tax charge posted with a charge, or the charge a sales tax charge was posted for.

Business Rules

  • No permission is checked: any API key can read any lease charge it can reach.
  • 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 charge, answers 400 {"error": "Charge 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • For a user restricted to portfolio groups the restriction is checked before the type, so a transaction with no lease, or on a lease outside their groups, answers the 403 even when it isn't a lease charge.
  • A voided charge is still returned, with isVoided '1'.

Available Includes (8)

  • property - the lease's property
  • unit - the lease's unit
  • lease - the lease
  • portfolio - the portfolio the charge posted to
  • propertyPortfolios - every ownership period of the property
  • receipts - the payments and credits applied to the charge (receipts that aren't voided), each with its payment or credit
  • salesTaxTransaction - the sales tax charge posted for this charge, or null
  • salesTaxFromTransaction - for a sales tax charge, the charge it was posted for; null otherwise
  • POST /accounting/leases/charges/{transactionID} - Change the charge.
  • DELETE /accounting/leases/charges/{transactionID} - Void the charge.
  • POST /accounting/leases/{leaseID}/charges - Post a charge.
  • GET /accounting/transactions/search - Find charges (transactionTypeIDs[] 1).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease charge.

query Parameters
includes
string
Example: includes=receipts,salesTaxTransaction

Comma-separated related records to add to the response, each under its own key: property, unit, lease, portfolio, propertyPortfolios, receipts, salesTaxTransaction, salesTaxFromTransaction.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 charge's lease, with the lease include.

object (included_portfolio)

The portfolio the charge posted to, with the portfolio include.

Array of objects (included_property_portfolio)

Every ownership period of the lease's property, with the propertyPortfolios include.

Array of objects (lease_charge_receipt_row)

The payments and credits applied to the charge, one row per receipt that isn't voided, with the receipts include. Empty for an unpaid charge.

lease_transaction (object) or null

The sales tax charge posted for this charge, with the salesTaxTransaction include; null when the charge has none (its account isn't subject to sales tax, the property has no sales tax setting, or it is itself a sales tax charge).

lease_transaction (object) or null

For a sales tax charge, the charge it was posted for, with the salesTaxFromTransaction include; null for any other charge.

Response samples

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

Update Lease Charge

Changes a posted lease charge's account, amount, date or description, and returns the charge as GET /accounting/leases/charges/{transactionID} does, with the same includes. Send only the fields to change.

Use Cases

  • Correcting a charge entered with the wrong amount, date or account before anyone pays it.
  • Relabelling a charge's description, which is allowed at any time while it isn't voided.

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"}.
  • Only chargeAccountID, amount, datePosted and description are read; any other key is ignored, billID included.
  • A transaction ID that doesn't exist, or isn't a lease charge, answers 400 {"error": "Charge 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • Once any payment or credit is applied (amountPaid above 0.00), the account and the date can't change, and the amount can't drop below what is paid.
  • A voided charge can't be changed: 400 {"isVoided": ["Cannot modify a voided transaction"]}.
  • A chargeAccountID that doesn't exist is checked first and answers only {"chargeAccountID": ["Account not found"]}. Otherwise every failing field is reported at once, in one validation map. Nothing is saved.

Side Effects

  • A modify entry is added to the charge's transaction log.
  • When the account, amount or date changes, the charge's ledger entries are archived and posted again for the new values.

From the code, not covered by a contract test:

  • A new account re-derives the charge's management fee settings (managementFeePercent, isSuppressed, isAdditionalManagementFee and the management fee sales tax fields) from the new account and the property's management fee settings.
  • A new date moves the date of the receipts applied to the charge from the tenant's prepaid credit.
  • A tenant notification for the charge that hasn't been sent yet takes the new amount, date and description.
  • An updateLeaseCharge event is recorded, and the lease's last-activity date is updated.
  • GET /accounting/leases/charges/{transactionID} - Read the charge first.
  • PUT /accounting/leases/charges/{transactionID} - The same operation as PUT.
  • DELETE /accounting/leases/charges/{transactionID} - Void the charge instead.
  • GET /accounting/accounts - Find a chargeAccountID.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease charge to change.

query Parameters
includes
string
Example: includes=receipts,salesTaxTransaction

Comma-separated related records to add to the response, each under its own key: property, unit, lease, portfolio, propertyPortfolios, receipts, salesTaxTransaction, salesTaxFromTransaction.

Request Body schema: application/json
required

The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is refused.

non-empty
chargeAccountID
string or integer^-?[0-9]+$

The account the charge posts to, from GET /accounting/accounts: an account whose accountTypeID is 4 (Asset), 5 (Liability), 6 (Equity), 7 (Income), 8 (Other Income), 9 (Expense) or 10 (Other Expense). Accounts Receivable (1), Accounts Payable (2) and bank accounts (3) are refused. Can't change once any payment or credit is applied to the charge.

amount
string or number <decimal>

The charge amount, above 0.00 and not below what is already paid on it (amountPaid). Sent as a decimal string or a JSON number.

datePosted
string

The date the charge posts to the ledger, as YYYY-MM-DD or MM/DD/YYYY. Can't change once any payment or credit is applied to the charge.

description
string [ 1 .. 4000 ] characters

The charge's label on the tenant ledger and statements. Can't be emptied.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 charge's lease, with the lease include.

object (included_portfolio)

The portfolio the charge posted to, with the portfolio include.

Array of objects (included_property_portfolio)

Every ownership period of the lease's property, with the propertyPortfolios include.

Array of objects (lease_charge_receipt_row)

The payments and credits applied to the charge, one row per receipt that isn't voided, with the receipts include. Empty for an unpaid charge.

lease_transaction (object) or null

The sales tax charge posted for this charge, with the salesTaxTransaction include; null when the charge has none (its account isn't subject to sales tax, the property has no sales tax setting, or it is itself a sales tax charge).

lease_transaction (object) or null

For a sales tax charge, the charge it was posted for, with the salesTaxFromTransaction include; null for any other charge.

Request samples

Content type
application/json
{
  • "amount": "275.00",
  • "datePosted": "2026-11-05",
  • "description": "Carpet cleaning, two rooms"
}

Response samples

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

Update Lease Charge (PUT)

The same operation as POST /accounting/leases/charges/{transactionID}, under the PUT method: the same body, rules, side effects and responses. Send only the fields to change.

  • POST /accounting/leases/charges/{transactionID} - The full description of this operation.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80980

ID of the lease charge to change.

query Parameters
includes
string
Example: includes=receipts,salesTaxTransaction

Comma-separated related records to add to the response, each under its own key: property, unit, lease, portfolio, propertyPortfolios, receipts, salesTaxTransaction, salesTaxFromTransaction.

Request Body schema: application/json
required

The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is refused.

non-empty
chargeAccountID
string or integer^-?[0-9]+$

The account the charge posts to, from GET /accounting/accounts: an account whose accountTypeID is 4 (Asset), 5 (Liability), 6 (Equity), 7 (Income), 8 (Other Income), 9 (Expense) or 10 (Other Expense). Accounts Receivable (1), Accounts Payable (2) and bank accounts (3) are refused. Can't change once any payment or credit is applied to the charge.

amount
string or number <decimal>

The charge amount, above 0.00 and not below what is already paid on it (amountPaid). Sent as a decimal string or a JSON number.

datePosted
string

The date the charge posts to the ledger, as YYYY-MM-DD or MM/DD/YYYY. Can't change once any payment or credit is applied to the charge.

description
string [ 1 .. 4000 ] characters

The charge's label on the tenant ledger and statements. Can't be emptied.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 charge's lease, with the lease include.

object (included_portfolio)

The portfolio the charge posted to, with the portfolio include.

Array of objects (included_property_portfolio)

Every ownership period of the lease's property, with the propertyPortfolios include.

Array of objects (lease_charge_receipt_row)

The payments and credits applied to the charge, one row per receipt that isn't voided, with the receipts include. Empty for an unpaid charge.

lease_transaction (object) or null

The sales tax charge posted for this charge, with the salesTaxTransaction include; null when the charge has none (its account isn't subject to sales tax, the property has no sales tax setting, or it is itself a sales tax charge).

lease_transaction (object) or null

For a sales tax charge, the charge it was posted for, with the salesTaxFromTransaction include; null for any other charge.

Request samples

Content type
application/json
{
  • "amount": "275.00",
  • "datePosted": "2026-11-05",
  • "description": "Carpet cleaning, two rooms"
}

Response samples

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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"
}

Get Lease Credit

Returns one lease credit: an amount taken off what the tenant owes (a concession or an adjustment), how much of it is applied to charges (amountAllocated), its account and date, under transaction, plus any related records the includes parameter asks for.

Use Cases

  • Checking which charges a credit is applied to (receipts) and how much is left unapplied.
  • Reading a credit before voiding it.

Business Rules

  • No permission is checked: any API key can read any lease credit it can reach.
  • 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 credit, answers 400 {"error": "Credit 999999999 not found"}; neither is a 404. A path value that isn't a number answers the stock 404.
  • For a user restricted to portfolio groups the restriction is checked before the type, so a transaction with no lease, or on a lease outside their groups, answers the 403 even when it isn't a lease credit.

Available Includes (7)

  • contact - always false: a lease credit has no contact
  • lease - the lease
  • portfolio - the portfolio the credit posted to
  • property - the lease's property
  • unit - the lease's unit
  • propertyPortfolios - every ownership period of the property
  • receipts - receipts that aren't voided: the charges the credit is applied to and any refund of it, each with the charge, its account and the refund payout
  • DELETE /accounting/leases/credits/{transactionID} - Void the credit.
  • GET /accounting/leases/charges/{transactionID} - Read a charge the credit is applied to.
  • GET /accounting/transactions/search - Find credits (transactionTypeIDs[] 3).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80982

ID of the lease credit.

query Parameters
includes
string
Example: includes=lease,receipts

Comma-separated related records to add to the response, each under its own key: contact, lease, portfolio, property, unit, propertyPortfolios, receipts.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

contact
boolean
Value: false

With the contact include, always false: a lease credit carries no contact (contactID is always null), so there is none to return.

object (included_lease)

The credit's lease, with the lease include.

object (included_portfolio)

The portfolio the credit 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.

Array of objects (lease_receipt_row)

The credit's receipts that aren't voided, with the receipts include: the charges it is applied to, and any refund of it. Empty when none of it is applied.

Response samples

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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"
}

Get Lease Payment

Returns one lease payment: the amount, how much of it is applied to charges (amountAllocated), the bank account, payment type, deposit and return status, under transaction, plus any related records the includes parameter asks for.

Use Cases

  • Checking which charges a payment paid (receipts) and how much is left as a tenant credit.
  • Checking whether a payment is deposited (depositID), returned (returnTransactionID) or voided (isVoided) before changing, returning or voiding it.

Business Rules

  • No permission is checked: any API key can read any lease payment it can reach.
  • 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.
  • For a user restricted to portfolio groups the restriction is checked before the type, so a transaction with no lease, or on a lease outside their groups, answers the 403 even when it isn't a lease payment.
  • A voided payment is still returned, with isVoided '1'.

Available Includes (12)

  • deposit - the bank deposit the payment is in, or false when it isn't in one
  • 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, or null until the payment is returned
  • bulkPayment - the bulk payment (bulk receipt) it belongs to, or null
  • transactionLogs - the payment's change log
  • receipts - receipts that aren't voided: the charges it paid and any refunds
  • managementFees - management fees taken on it that aren't voided
  • POST /accounting/leases/payments/{transactionID} - Change the payment.
  • DELETE /accounting/leases/payments/{transactionID} - Void the payment.
  • POST /accounting/leases/payments/{transactionID}/return - Return a deposited payment.
  • POST /accounting/leases/{leaseID}/payments - Record a payment.
  • GET /accounting/transactions/search - Find payments (transactionTypeIDs[] 2).
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80981

ID of the lease payment.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Update Lease Payment

Changes a lease payment's date, description, reference, payment type or bank deposit, and returns the payment as GET /accounting/leases/payments/{transactionID} does, with the same includes. Send only the fields to change. The amount, bank account, tenant and how the payment is applied to charges can't be changed here.

Use Cases

  • Correcting a payment's date, check number or payment type.
  • Putting a payment into a bank deposit, moving it to another deposit on the same bank account, or taking it out of its deposit.

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"}.
  • Only datePosted, description, reference, paymentTypeID and depositID are read; any other key is ignored.
  • 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.
  • For a user restricted to portfolio groups the restriction is checked before the type, so a transaction with no lease, or on a lease outside their groups, answers the 403 even when it isn't a lease payment.
  • A gateway-connected (online) payment keeps its date and payment type: a new payment type answers 400 {"paymentTypeID": ["Electronic payment types cannot be changed"]}, and a new date 400 {"payment": ["Payment date posted cannot be changed"]}.
  • The deposit must exist, be on the payment's bank account, and be neither voided nor reconciled. A gateway-connected (online) payment or one in a bulk payment (bulk receipt) can't be put in a deposit, and a reconciled payment can't be taken out of its deposit. Each answers 400 with its message (see the examples).
  • A voided payment can't be changed: 400 {"isVoided": ["Cannot modify a voided transaction"]}.

Side Effects

  • A modify entry is added to the payment's transaction log.
  • A new datePosted reallocates the payment: its receipts are voided and issued again for the same charges and amounts, dated the later of the new date and each charge's date; any amount not applied stays a tenant credit.
  • A new depositID adds the payment's amount to that deposit; leaving a deposit takes it off that deposit's amount, and a deposit left with no payments is voided.

From the code, not covered by a contract test:

  • A deposit the payment joins or leaves gets an entry in its own change log ("Deposit Voided" when it is voided).
  • A reallocation also archives the payment's ledger entries and posts them again, voids the management fees on the voided receipts, and adds a "Reallocate Receipts" entry to the transaction log.
  • The lease's last-activity date is updated.
  • GET /accounting/leases/payments/{transactionID} - Read the payment first.
  • PUT /accounting/leases/payments/{transactionID} - The same operation as PUT.
  • DELETE /accounting/leases/payments/{transactionID} - Void the payment instead.
  • GET /accounting/deposits - Find a depositID.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80981

ID of the lease payment to change.

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

The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is refused.

non-empty
datePosted
string

The date the payment posts, as YYYY-MM-DD or MM/DD/YYYY. A new date reallocates the payment: its receipts are voided and issued again for the same charges and amounts, dated the later of the new date and each charge's date. Can't change on a gateway-connected (online) payment.

description
string or null <= 4000 characters

A note on the payment. An empty string or null clears it.

reference
string or null <= 200 characters

The check number or other reference.

paymentTypeID
string or integer (payment_types_request)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8

How the tenant paid. Can't change on a gateway-connected (online) payment, and can't be null.

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
depositID
string or integer or null^-?[0-9]+$

The bank deposit to put the payment in, from GET /accounting/deposits; it must be on the payment's bank account. The payment leaves any deposit it was in, and that deposit's amount drops by the payment's. Null takes the payment out of its 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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
{
  • "datePosted": "2026-11-03",
  • "description": "Rent payment, November",
  • "reference": "1043",
  • "paymentTypeID": 4
}

Response samples

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

Update Lease Payment (PUT)

The same operation as POST /accounting/leases/payments/{transactionID}, under the PUT method: the same body, rules, side effects and responses. Send only the fields to change.

  • POST /accounting/leases/payments/{transactionID} - The full description of this operation.
Authorizations:
basicAuth
path Parameters
transactionID
required
integer
Example: 80981

ID of the lease payment to change.

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

The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is refused.

non-empty
datePosted
string

The date the payment posts, as YYYY-MM-DD or MM/DD/YYYY. A new date reallocates the payment: its receipts are voided and issued again for the same charges and amounts, dated the later of the new date and each charge's date. Can't change on a gateway-connected (online) payment.

description
string or null <= 4000 characters

A note on the payment. An empty string or null clears it.

reference
string or null <= 200 characters

The check number or other reference.

paymentTypeID
string or integer (payment_types_request)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8

How the tenant paid. Can't change on a gateway-connected (online) payment, and can't be null.

  • 1 - eCheck
  • 2 - Credit Card
  • 3 - Check
  • 4 - Money Order
  • 5 - Cash
  • 6 - Other
  • 7 - Cash Pay
  • 8 - Cashier's Check
depositID
string or integer or null^-?[0-9]+$

The bank deposit to put the payment in, from GET /accounting/deposits; it must be on the payment's bank account. The payment leaves any deposit it was in, and that deposit's amount drops by the payment's. Null takes the payment out of its 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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
{
  • "datePosted": "2026-11-03",
  • "description": "Rent payment, November",
  • "reference": "1043",
  • "paymentTypeID": 4
}

Response samples

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

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} 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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} 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns a page of ledger transfers (transaction type 15). Each row holds the transaction's main columns and the names of the ledgers its entries post to. A ledger transfer names no primary ledger, property, portfolio or unit, so those objects come with every field null.

Use Cases

  • List the ledger transfers posted in a date range, or the voided ones with isVoided=1.
  • Find the transfers that moved money in or out of a ledger with transactionEntriesLedgerIDs[].

Business Rules

  • Requires only authentication; no permission is checked.
  • A key restricted to some portfolios gets only the transfers with an entry, not voided, in one of those portfolios. A voided transfer's entries are voided too, so such a key doesn't get voided transfers.
  • Only ledger transfers come back; the type can't be changed.
  • search matches the description or the exact amount: a ledger transfer has no property or primary ledger to match. Its reference isn't searched.
  • isVoided reads 1, true and yes as yes and 0, false and no as no; any other value is ignored. Without it, voided and other transfers come back.
  • List filters take each value as a separate name[]=.
  • Sorted by date posted, newest first, then by transactionID, newest first.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/transactions/{transactionID} - one ledger transfer, with its entries
  • GET /accounting/recurring-ledger-transfers/search - the recurring ledger transfer schedules
Authorizations:
basicAuth
query Parameters
search
string
Example: search=reclass

Substring matched against the description, or the exact amount (450.00).

isVoided
string or integer or boolean

1, true or yes for voided transfers only; 0, false or no for the others. Any other value is ignored.

amountMin
string or number <decimal>
Example: amountMin=100.00

Only transfers of at least this amount. A value that isn't a number is ignored.

amountMax
string or number <decimal>
Example: amountMax=500.00

Only transfers of at most this amount. A value that isn't a number is ignored.

datePostedMin
string
Example: datePostedMin=2026-10-01

Only transfers posted on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

datePostedMax
string
Example: datePostedMax=2026-10-31

Only transfers posted on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

transactionEntriesLedgerIDs[]
Array of integers
Example: transactionEntriesLedgerIDs[]=8203

Only transfers with an entry on one of these ledgers, each as a separate transactionEntriesLedgerIDs[]=.

page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The transaction's main columns.

required
object

The primary ledger. Both fields are null when the transaction has none.

required
object

The transaction's property. Every field is null when it names none.

required
object

The transaction's portfolio. Both fields are null when it names none, as on a ledger transfer.

required
object

The transaction's unit. Every field is null when it names none.

required
object

What the transaction's entries post to.

Response samples

Content type
application/json
Example
[
  • {
    }
]

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; no negative debit, Journal entry line debit cannot be negative. keyed entries[<n>].debit, and no negative credit, Journal entry line credit cannot be negative. keyed entries[<n>].credit; 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, and the debits-equal-credits check totals each line on that same side: its debit when that's above zero, otherwise its 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.
  • 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns a page of journal entries (transaction type 11). Each row holds the transaction's main columns, its primary ledger, property, portfolio and unit, and the names of the ledgers its entries post to.

Use Cases

  • List the journal entries posted in a date range, or the voided ones with isVoided=1.
  • Find the journal entries of some properties with propertyIDs[], or those that touched a ledger with transactionEntriesLedgerIDs[].

Business Rules

  • Requires only authentication; no permission is checked.
  • A key restricted to some portfolios gets only the journal entries of those portfolios.
  • Only journal entries come back; the type can't be changed.
  • A journal entry made on a property's or unit's ledger posts to its portfolio's ledger, so ledger is the portfolio's ledger and property and unit name where it was made.
  • property and unit are always sent; each of their fields is null when the entry names none.
  • isVoided reads 1, true and yes as yes and 0, false and no as no; any other value is ignored. Without it, voided and other entries come back.
  • List filters take each value as a separate name[]=.
  • Sorted by date posted, newest first, then by transactionID, newest first.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/transactions/{transactionID} - one journal entry, with its entries
  • POST /accounting/journal-entries - create a journal entry
  • GET /accounting/recurring-journal-entries/search - the recurring journal entry schedules
Authorizations:
basicAuth
query Parameters
search
string
Example: search=reclass

Substring matched against the description, the property's name and address and the primary ledger's name; or the exact amount (125.00).

isVoided
string or integer or boolean

1, true or yes for voided entries only; 0, false or no for the others. Any other value is ignored.

amountMin
string or number <decimal>
Example: amountMin=100.00

Only entries of at least this amount. A value that isn't a number is ignored.

amountMax
string or number <decimal>
Example: amountMax=500.00

Only entries of at most this amount. A value that isn't a number is ignored.

datePostedMin
string
Example: datePostedMin=2026-10-01

Only entries posted on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

datePostedMax
string
Example: datePostedMax=2026-10-31

Only entries posted on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

propertyIDs[]
Array of integers
Example: propertyIDs[]=3255

Only entries of these properties, each as a separate propertyIDs[]=.

transactionEntriesLedgerIDs[]
Array of integers
Example: transactionEntriesLedgerIDs[]=8203

Only entries with an entry on one of these ledgers, each as a separate transactionEntriesLedgerIDs[]=.

page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The transaction's main columns.

required
object

The primary ledger. Both fields are null when the transaction has none.

required
object

The transaction's property. Every field is null when it names none.

required
object

The transaction's portfolio. Both fields are null when it names none, as on a ledger transfer.

required
object

The transaction's unit. Every field is null when it names none.

required
object

What the transaction's entries post to.

Response samples

Content type
application/json
Example
[
  • {
    }
]

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns a page of recurring ledger transfer schedules. Each row holds the schedule under recurringLedgerTransfer, with the names of the ledgers its entries move money between.

Use Cases

  • List the schedules that run in the next days with nextRunDateMin and nextRunDateMax.
  • Find the schedules paid from a bank account with bankAccountIDs[], or those that touch a ledger with ledgerIDs[].

Business Rules

  • Requires only authentication; no permission is checked.
  • A key restricted to some portfolios gets only the schedules with an entry on one of their ledgers.
  • Every schedule comes back, whether or not it has ended: there is no active filter.
  • search is a substring match on the reference or the description, or the exact amount (600.00).
  • ledgerIDs[] matches a schedule with an entry on any of the ledgers.
  • List filters take each value as a separate name[]=.
  • Sorted by next run date, then by recurringLedgerTransferID.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/ledger-transfers/search - the ledger transfers posted
Authorizations:
basicAuth
query Parameters
search
string
Example: search=reserve

Substring matched against the reference and the description, or the exact amount (600.00).

ledgerIDs[]
Array of integers
Example: ledgerIDs[]=8203

Only schedules with an entry on one of these ledgers, each as a separate ledgerIDs[]=.

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

Only schedules paid from these bank accounts, each as a separate bankAccountIDs[]=.

amountMin
string or number <decimal>
Example: amountMin=100.00

Only schedules of at least this amount; a schedule with no amount matches no amount bound. A value that isn't a number is ignored.

amountMax
string or number <decimal>
Example: amountMax=1000.00

Only schedules of at most this amount; a schedule with no amount matches no amount bound. A value that isn't a number is ignored.

endDateMin
string
Example: endDateMin=2027-06-30

Only schedules whose end date is on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A schedule with no end date matches no end-date bound. A value that can't be read as a date is ignored.

endDateMax
string
Example: endDateMax=2027-06-30

Only schedules whose end date is on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A schedule with no end date matches no end-date bound. A value that can't be read as a date is ignored.

nextRunDateMin
string
Example: nextRunDateMin=2026-12-01

Only schedules whose next run date is on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

nextRunDateMax
string
Example: nextRunDateMax=2026-12-01

Only schedules whose next run date is on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The schedule.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Search Recurring Journal Entries

Returns a page of recurring journal entry schedules. Each row holds the schedule under recurringJournalEntry and its ledger under ledger.

Use Cases

  • List the schedules that run in the next days with nextRunDateMin and nextRunDateMax.
  • Find the schedules of some ledgers with ledgerIDs[].

Business Rules

  • Requires only authentication; no permission is checked.
  • A key restricted to some portfolios gets only the schedules on their ledgers.
  • Every schedule comes back, whether or not it has ended: there is no active filter.
  • search is a substring match on the description, or the exact amount (240.00).
  • List filters take each value as a separate name[]=.
  • Sorted by next run date, then by recurringJournalEntryID.
  • The page size defaults to 25, with no upper limit today; a pageSize of 0 or less is served at 15. A page below 1 is served as page 1.
  • GET /accounting/journal-entries/search - the journal entries posted
Authorizations:
basicAuth
query Parameters
search
string
Example: search=accrual

Substring matched against the description, or the exact amount (240.00).

ledgerIDs[]
Array of integers
Example: ledgerIDs[]=8303

Only schedules on these ledgers, each as a separate ledgerIDs[]=.

amountMin
string or number <decimal>
Example: amountMin=100.00

Only schedules of at least this amount; a schedule with no amount matches no amount bound. A value that isn't a number is ignored.

amountMax
string or number <decimal>
Example: amountMax=1000.00

Only schedules of at most this amount; a schedule with no amount matches no amount bound. A value that isn't a number is ignored.

endDateMin
string
Example: endDateMin=2027-06-30

Only schedules whose end date is on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A schedule with no end date matches no end-date bound. A value that can't be read as a date is ignored.

endDateMax
string
Example: endDateMax=2027-06-30

Only schedules whose end date is on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A schedule with no end date matches no end-date bound. A value that can't be read as a date is ignored.

nextRunDateMin
string
Example: nextRunDateMin=2026-12-01

Only schedules whose next run date is on or after this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

nextRunDateMax
string
Example: nextRunDateMax=2026-12-01

Only schedules whose next run date is on or before this date, as YYYY-MM-DD or MM/DD/YYYY. A value that can't be read as a date is ignored.

page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is served as page 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.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

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: "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"

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The schedule.

required
object (included_ledger)

An accounting ledger (every column of the row; the shared ledger model lacks the timestamps).

Response samples

Content type
application/json
Example
[
  • {
    }
]

Transaction Entries

The debit and credit lines that make up each transaction, each posted to one account on one ledger. Search entries across all transactions.

Search Transaction Entries

Returns one page of transaction entries: the individual debit and credit lines of the double-entry transactions, newest posting date first. Each row holds the entry, the ledger it posts to, its transaction, and its property, portfolio, unit and reconciliations.

Use Cases

  • List the lines posted to one ledger, for a ledger statement (ledgerIDs[]).
  • Report on the cash or accrual basis (isCash, isAccrual), or leave out suppressed lines (isSuppressed).
  • Pull the lines whose transaction changed since a time, for a sync (dateTimeModifiedMin).

Business Rules

  • No permission is checked beyond a valid API key.
  • The filters combine with AND. A filter left out filters nothing. Voided lines are included unless isVoided=false.
  • amountMin, amountMax, propertyIDs[], transactionTypeIDs[], dateTimeModifiedMin and dateTimeModifiedMax filter on the line's transaction; datePostedMin, datePostedMax, ledgerIDs[] and the flags filter on the line itself.
  • Sorted by the line's datePosted, newest first, then by transactionID and transactionEntryID, highest first.
  • GET /accounting/transactions/search - Search whole transactions instead.
  • GET /accounting/transactions/{transactionID} - One transaction, with its entries.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Rent

Matches lines whose transaction description, property name, property address or ledger name contains the text, or whose transaction amount equals it exactly.

isVoided
string
Example: isVoided=false

true (or 1, yes) for voided lines only, false (or 0, no) for the others only. Any other value filters nothing.

isSuppressed
string
Example: isSuppressed=false

true (or 1, yes) for suppressed lines only, false (or 0, no) for the others only. Any other value filters nothing.

isCash
string
Example: isCash=false

true (or 1, yes) for cash-basis lines only, false (or 0, no) for the others only. Any other value filters nothing.

isAccrual
string
Example: isAccrual=false

true (or 1, yes) for accrual-basis lines only, false (or 0, no) for the others only. Any other value filters nothing.

amountMin
string <decimal>
Example: amountMin=100.00

Only lines whose transaction is of at least this amount.

amountMax
string <decimal>
Example: amountMax=5000.00

Only lines whose transaction is of at most this amount.

datePostedMin
string
Example: datePostedMin=2024-01-01

Only lines posted on or after this date, as YYYY-MM-DD or MM/DD/YYYY.

datePostedMax
string
Example: datePostedMax=2024-12-31

Only lines posted on or before this date, as YYYY-MM-DD or MM/DD/YYYY.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-10-01 00:00:00

Only lines whose transaction changed at or after this time, in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 with no offset.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-10-31 23:59:59

Only lines whose transaction changed at or before this time, in UTC, as YYYY-MM-DD HH:MM:SS or ISO 8601 with no offset.

transactionTypeIDs[]
Array of integers
Example: transactionTypeIDs[]=12&transactionTypeIDs[]=15

Only lines whose transaction has one of these types (the values of transaction.transactionTypeID). Send each ID as its own transactionTypeIDs[]=. Takes precedence over transactionTypeID.

transactionTypeID
integer
Example: transactionTypeID=12

The same filter for one ID, read only when transactionTypeIDs[] is left out.

propertyIDs[]
Array of integers
Example: propertyIDs[]=12&propertyIDs[]=15

Only lines whose transaction is on one of these properties (GET /properties). Send each ID as its own propertyIDs[]=. Takes precedence over propertyID.

propertyID
integer
Example: propertyID=12

The same filter for one ID, read only when propertyIDs[] is left out.

ledgerIDs[]
Array of integers
Example: ledgerIDs[]=12&ledgerIDs[]=15

Only lines posted to these ledgers (GET /accounting/ledgers/search). Send each ID as its own ledgerIDs[]=. Takes precedence over ledgerID.

ledgerID
integer
Example: ledgerID=12

The same filter for one ID, read only when ledgerIDs[] is left out.

page
integer
Default: 1

The page number for pagination

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: "2"

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: "16"

Total number of items across all pages; 0 when nothing matches

pagination-total-pages
integer
Example: "8"

Total number of pages

pagination-current-page
integer
Example: "1"

Current page number

pagination-next-page
integer
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

One debit or credit line of a transaction, as the transaction-entry search returns it: the entry's own columns, without its ledger, portfolio, property and unit IDs (the search sends those as objects of their own).

required
object

The ledger the entry posts to.

required
object

The transaction the entry belongs to.

required
object

The ledger of the entry's transaction; every key is null when the transaction has none.

required
object

propertyID is the transaction's property; the other keys describe the entry's own property, and are null when the entry has none. The two are the same property unless the entry was posted to another one.

required
object

portfolioID is the transaction's portfolio; the other keys describe the entry's own portfolio, and are null when the entry has none. The two are the same portfolio unless the entry was posted to another one.

required
object

unitID is the transaction's unit; the other keys describe the entry's own unit, and are null when the entry has none. The two are the same unit unless the entry was posted to another one.

required
object

The reconciliation the entry is in; every key is null when it is in none.

required
object

The reconciliation the entry was in before it was last unreconciled; every key is null when there is none.

Response samples

Content type
application/json
[
  • {
    }
]

Owners

Owners are the contacts who own your properties, through the portfolios they belong to. List, search, create, read, update, activate, deactivate and delete 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 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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an owner, with any emails, phone numbers and addresses the body lists, and answers with the new owner's view: the same body as GET /owners/{contactID}, including the related records the includes parameter names.

Use Cases

  • Add a property owner, with their contact details, in one request
  • Set how the owner is paid (payout type, held payments, payee name) when the owner is added

Business Rules

  • Requires the Update Owner Details permission (Contacts › UpdateOwner).
  • name is required; the body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, apart from bank-account details this reference doesn't describe.
  • taxPayerName, taxFormTypeID, taxIdentifier, taxIdentifierTypeID and taxIdentifierCountryID are read only when the role also holds Manage Tax Info & Reporting (1099s) (Contacts › ManageTaxInfo), and isBillApprovalExempt only when it holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without the permission the field is ignored, with no error.
  • payoutTypeID, holdPayments, preventConsolidatedPayments, payeeName, achAccountTypeID and achIsCorporateAccount are taken only here: POST /owners/{contactID} ignores them.
  • A payout type of 3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request with either and without them is refused with 400.
  • The new owner is active. firstName, middleName, lastName and suffix are parsed from name; payoutTypeID defaults to 2 (Check), and holdPayments, preventConsolidatedPayments, achIsCorporateAccount and isBillApprovalExempt to 0.
  • The first email, phone number and address become the owner's primary ones, copied to contact.email, contact.phone and the contact's address fields.
  • The owner's own fields are checked first, and the email, phone and address items only once they pass, so a request with errors in both reports only the owner's.
  • All of it is saved together: when any item fails validation, nothing is created.
  • The tax identifier is stored encrypted and never returned: contact.hasTaxIdentifier says one is stored.

Side Effects

  • Creates the contact's private-data row (the encrypted tax identifier, when one is sent), its assignee record, a log entry, "Owner Created", and one log entry per email, phone and address added.
  • Copying the first email, phone number and address onto the contact writes an "Updated Owner" log entry and saves the assignee record again, once for each.
  • GET /owners/{contactID} - get the owner
  • POST /owners/{contactID} - update the owner
  • GET /owners/search - search owners
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments.

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

The owner's full name. firstName, middleName, lastName and suffix are parsed from it.

code
string or null <= 100 characters

The account's own reference code for the owner.

websiteUrl
string or null <uri> <= 500 characters

The owner's website. Must be a valid URL.

birthDate
string or null

The owner's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

payoutTypeID
string or integer (payout_types_request)
Default: 2
Enum: "1" "2" "3" "4" 1 2 3 4

How the owner is paid; defaults to 2 (Check). 3 (eCheck) and 4 (NACHA) need bank details this reference doesn't describe; without them the request is refused.

  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(bank_account_types_request (string or integer)) or null

The kind of bank account payments go to; required with a payout type of 3 (eCheck) or 4 (NACHA). Taken only on a create.

achIsCorporateAccount
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the owner's bank account is a business account. true, false, yes and no are read too.

holdPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether payments to the owner are held. true, false, yes and no are read too.

preventConsolidatedPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the owner's payments are kept apart instead of combined into one payment. true, false, yes and no are read too.

payeeName
string or null <= 100 characters

The name payments are made out to, when it isn't name.

isBillApprovalExempt
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the owner's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

taxPayerName
string or null <= 100 characters

The name on the owner's tax forms. Read only when the role holds Manage Tax Info & Reporting (1099s).

(form_types_request (string or integer)) or null

The tax form the owner gets. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifier
string or null

The owner's tax identifier (an SSN, ITIN or EIN), stored encrypted and never returned. An identifier in the wrong form isn't refused: it is stored with isTaxIdentifierValid "0"; the view's hasTaxIdentifier, isTaxIdentifierValid and taxIdentifierTypeID describe it. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifierTypeID
string or integer (tax_identifier_types_request)
Enum: "1" "2" "3" "4" "99" 1 2 3 4 99

The kind of tax identifier. When it's missing, the type is worked out from the identifier. Read only when the role holds Manage Tax Info & Reporting (1099s).

  • 1 - SSN
  • 2 - ITIN
  • 3 - EIN
  • 4 - Foreign Tax ID
  • 99 - Unknown
taxIdentifierCountryID
string or null <= 2 characters

The two-letter code of the country that issued the tax identifier; leave it empty for the United States. Read only when the role holds Manage Tax Info & Reporting (1099s).

Array of objects (contact_email_request)

Email addresses to add to the owner.

Array of objects (contact_phone_request)

Phone numbers to add to the owner.

Array of objects (contact_address_request)

Addresses to add 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
Example
{
  • "name": "Jordan Rivera",
  • "code": "OWN-1001",
  • "websiteUrl": "https://example.com",
  • "birthDate": "1980-04-12",
  • "payoutTypeID": 2,
  • "holdPayments": 1,
  • "preventConsolidatedPayments": 1,
  • "payeeName": "Rivera Holdings LLC",
  • "isBillApprovalExempt": 1,
  • "taxPayerName": "Rivera Holdings LLC",
  • "taxFormTypeID": 1,
  • "taxIdentifier": "123456789",
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an owner's name, code, website, date of birth and bill-approval exemption, and answers with the owner's view: the same body as GET /owners/{contactID}, including the related records the includes parameter names.

Use Cases

  • Correct an owner's name or date of birth
  • Exempt an owner's bills from approval

Business Rules

  • Requires the Update Owner Details permission (Contacts › UpdateOwner).
  • A user restricted to portfolio groups can update 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.
  • Send only the fields to change; the others keep their values. The body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the payout settings POST /owners takes (payoutTypeID, holdPayments and the others), the tax fields, and emails, phones and addresses.
  • isBillApprovalExempt is read only when the role also holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without it the field is ignored, with no error.
  • firstName, middleName, lastName and suffix are parsed again from name.
  • A body of only keys this operation ignores isn't empty: it answers 200, and only dateTimeModified changes.
  • 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.

Side Effects

  • A new name is copied into the owner list of each portfolio the owner holds a share of (the contacts of GET /portfolios/{portfolioID}).
  • When a field changes, writes an "Updated Owner" entry with the changes to the owner's activity log, and saves the owner's assignee record.
  • GET /owners/{contactID} - get the owner
  • POST /owners - create an owner
  • POST /owners/{contactID}/deactivate - deactivate the owner
  • POST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have the same phones and addresses routes
  • POST /owners/{contactID}/tax-details (undocumented) - change the tax details
  • POST /owners/{contactID}/ach-details (undocumented) - change the payout settings
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, 404.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, portfolios, portalAccounts, portalInvitations, taxAdjustments.

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

The owner's full name. firstName, middleName, lastName and suffix are parsed from it again.

code
string or null <= 100 characters

The account's own reference code for the owner.

websiteUrl
string or null <uri> <= 500 characters

The owner's website. Must be a valid URL.

birthDate
string or null

The owner's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

isBillApprovalExempt
string or integer
Enum: "0" "1" 0 1

Whether the owner's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
{
  • "name": "Jordan A. Rivera",
  • "code": "OWN-2002",
  • "birthDate": "1981-05-13",
  • "isBillApprovalExempt": 1
}

Response samples

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

Delete Owner

Deletes an owner for good, with the records that belong only to the owner, and answers with the owner's row as it was. An owner with financial history or a portfolio share can't be deleted: deactivate it instead with POST /owners/{contactID}/deactivate.

Use Cases

  • Remove an owner added by mistake, before anything was recorded against them

Business Rules

  • Requires the Update Owner Details permission (Contacts › UpdateOwner).
  • A user restricted to portfolio groups can delete 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.
  • Refused with 400 when the owner holds a share of a portfolio, or has bills, payouts, recurring bills, accounting transactions, tax adjustments, leases, recurring lease payments, a withholding tax agency, a reminder it is assigned to, or work orders. The first check that fails names its reason (see the examples); nothing is deleted.
  • 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 response is the owner's row as it was before the delete, not wrapped in contact, with no tax-identifier keys.

Side Effects

  • Deletes the owner, its emails, addresses, payment methods, private data (the stored tax identifier), assignee record and vendor trades, and the invoices it is the payee of.
  • Deactivates the owner's phone numbers (they are kept, with isActive 0), so text threads stay linked.
  • Removes the owner from work-order technician assignments, and deletes the work-order templates, recurring work orders and property association links that name it.
  • Revokes the owner's owner-portal invitations and portal accounts, so the owner can no longer sign in to the owner portal.
  • Deletes the owner's email conversations, activities, notes, alerts, file attachments, custom field values, letters, chat messages, reminders about it, watchers and dates, and writes a log entry, "Owner Deleted".
  • Deletes each file attached to the owner that no other record has attached, so it is gone from GET /files/{fileID} too; a file still attached elsewhere is kept.
  • POST /owners/{contactID}/deactivate - deactivate the owner instead
  • GET /owners/{contactID} - get 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, 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the contact.

contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Contact type: 1 Owner, 2 Tenant, 3 Vendor, 4 Manager, 5 Association, 6 Applicant, 7 Screening Prospect, 8 Internal Technician (maintenance technician), 9 Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its includeManager, includeMaintenanceTechnician or contactIDs[] adds.

vendorTypeID
required
string or null^-?[0-9]+$

Vendor type, from GET /contacts/vendor-types (undocumented). Kept for vendors and maintenance technicians; null for other contact types.

code
required
string or null <= 100 characters

Optional short code or reference for the contact.

name
required
string <= 100 characters

Full display name.

firstName
required
string or null <= 100 characters

First name, parsed from name on every save for owners and tenants (and applicants); null for every other contact type.

middleName
required
string or null <= 100 characters

Middle name, parsed from name like firstName; null for types other than owners and tenants.

lastName
required
string or null <= 100 characters

Last name, parsed from name like firstName; null for types other than owners and tenants.

suffix
required
string or null <= 15 characters

Name suffix, parsed from name like firstName; null for types other than owners and tenants.

email
required
string or null <= 100 characters

Primary email address on the contact record.

phone
required
string or null <= 20 characters

Primary phone number on the contact record.

countryID
required
string or null <= 2 characters

Two-letter country code of the contact address.

address
required
string or null <= 100 characters

Street address.

address2
required
string or null <= 100 characters

Second address line.

city
required
string or null <= 45 characters

City.

stateID
required
string or null <= 3 characters

State or province code.

postalCode
required
string or null <= 30 characters

Postal code.

birthDate
required
string or null <date>

Date of birth. Personal data: store and show it only where your integration needs it.

defaultBillChargeAccountID
required
string or null^-?[0-9]+$

Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save).

payeeName
required
string or null <= 100 characters

Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save.

taxPayerName
required
string or null <= 100 characters

Name printed on tax forms; null for maintenance technicians.

required
form_types (string) or null

Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians.

required
identification_types (string) or null

Type of identification on file, or null.

identificationNumber
required
string or null <= 50 characters

The number of the contact's identification document, such as a driver's licence or passport. Personal data: store and show it only where your integration needs it.

identificationCountryID
required
string or null <= 2 characters

Two-letter code of the country that issued the identification.

identificationIssuingLocation
required
string or null <= 100 characters

Where the identification was issued.

identificationExpirationDate
required
string or null <date>

Identification expiry date.

required
payout_types (string) or string

How the contact is paid, or 0 when no payout type is set.

required
other_payout_types (string) or null

How the contact is paid outside Rentvine when payoutTypeID is 1 (Other), or null; always null for maintenance technicians.

achDetailsCiphertextID
required
string or null^-?[0-9]+$

Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians.

achAccountNumberTruncated
required
string or null <= 4 characters

Last 4 digits of the ACH account number; null for maintenance technicians.

required
bank_account_types (string) or null

ACH bank account type, or null; always null for maintenance technicians.

achIsCorporateAccount
required
string
Enum: "0" "1"

1 if the ACH account is a corporate account.

holdPayments
required
string
Enum: "0" "1"

1 if payouts to the contact are on hold. Always 0 for tenants and maintenance technicians.

liabilityInsuranceName
required
string or null <= 100 characters

Liability insurer (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsurancePolicyNumber
required
string or null <= 50 characters

Liability policy number (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsuranceExpiresDate
required
string or null

Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), YYYY-MM-DD. A few rows store 0000-00-00.

workersCompInsuranceName
required
string or null <= 100 characters

Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsurancePolicyNumber
required
string or null <= 50 characters

Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsuranceExpiresDate
required
string or null <date>

Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save).

discountPercent
required
string or null <decimal>

Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save).

discountAmount
required
string or null <decimal>

Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with discountPercent.

discountAmountMin
required
string or null <decimal>

Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountAmountMax
required
string or null <decimal>

Largest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountGraceDays
required
string or null^-?[0-9]+$

Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save).

isActive
required
string
Enum: "0" "1"

1 if the contact is active, 0 if deactivated.

isInsuranceRequiredForPayment
required
string or null
Enum: "0" "1" null

1 if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store 0.

maxLineItemsOnPayment
required
string or null^-?[0-9]+$

Maximum number of bill line items allowed per payment, or null.

preventConsolidatedPayments
required
string
Enum: "0" "1"

1 to prevent consolidated payouts.

isFromImport
required
string
Enum: "0" "1"

1 if the record came from an import.

importSourceKey
required
string or null <= 100 characters

Key of the record in the import it came from, or null.

websiteUrl
required
string or null <= 500 characters

Website address, or null; always null for maintenance technicians.

applicantID
required
string or null^-?[0-9]+$

The applicant this contact was converted from, or null.

ownerPortalNameOverride
required
string or null <= 100 characters

Display name shown in the owner portal instead of name (vendors and associations; null for other contact types, which the API clears on save).

isBillApprovalExempt
required
string
Enum: "0" "1"

1 if bills for this contact skip the bill approval workflow.

isBillingSalesTaxEnabled
required
string
Enum: "0" "1"

1 if sales tax is enabled for invoices billed from this contact. Always 0 except for vendors and associations.

isQuickbooksExportEnabled
required
string
Enum: "0" "1"

1 if QuickBooks export is enabled for this contact. Always 0 except for vendors and managers.

quickbooksCustomerName
required
string or null <= 100 characters

Name used for the contact in QuickBooks; null except for vendors and managers.

invoiceAutofillTemplateID
required
string or null^-?[0-9]+$

ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians.

dateTimeCreated
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

contactType
required
string
Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead"

The contact type's label, computed in PHP: Owner, Tenant, Vendor, Association, Internal Technician (maintenance technicians), and Manager for a manager row a list adds.

Response samples

Content type
application/json
{
  • "contactID": "2713",
  • "contactTypeID": "1",
  • "vendorTypeID": null,
  • "code": "C-6afb876fad03b",
  • "name": "Jordan Lee Rivera Jr.",
  • "firstName": "Jordan",
  • "middleName": "Lee",
  • "lastName": "Rivera",
  • "suffix": "Jr.",
  • "email": "jordan.rivera@example.com",
  • "phone": "+19195550100",
  • "countryID": "US",
  • "address": "100 Main St",
  • "address2": "Suite 200",
  • "city": "Raleigh",
  • "stateID": "NC",
  • "postalCode": "27601",
  • "birthDate": "1980-04-12",
  • "defaultBillChargeAccountID": null,
  • "payeeName": "Jordan Rivera",
  • "taxPayerName": "Jordan Rivera",
  • "taxFormTypeID": "1",
  • "identificationTypeID": "1",
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "payoutTypeID": "1",
  • "otherPayoutTypeID": "1",
  • "achDetailsCiphertextID": "319",
  • "achAccountNumberTruncated": "6789",
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "1",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": "12",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": "https://example.com",
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": "309",
  • "dateTimeCreated": "2026-11-16 22:45:03",
  • "dateTimeModified": "2026-11-16 22:45:03",
  • "dateTimeDeactivated": null,
  • "contactType": "Owner"
}

Activate Owner

Activates an owner: sets isActive to 1 and clears dateTimeDeactivated. Answers with the owner's view: the same body as GET /owners/{contactID}, including the related records the includes parameter names.

Use Cases

  • Bring back an owner who was deactivated

Business Rules

  • Requires the Update Owner Details permission (Contacts › UpdateOwner).
  • A user restricted to portfolio groups can change 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.
  • Takes no body.
  • Activating an owner that is already active answers 200 with the owner; only its dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Owner" entry to the owner's activity log when the owner was inactive, and saves the owner's assignee record.
  • POST /owners/{contactID}/deactivate - deactivate the owner
  • GET /owners/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Deactivate Owner

Deactivates an owner: sets isActive to 0 and dateTimeDeactivated to the time of the request. The owner and everything recorded against it are kept; GET /owners and GET /owners/search filter on isActive. Answers with the owner's view: the same body as GET /owners/{contactID}, including the related records the includes parameter names.

Use Cases

  • Retire an owner who no longer works with the account, keeping their history
  • Retire an owner that can't be deleted because of its history

Business Rules

  • Requires the Update Owner Details permission (Contacts › UpdateOwner).
  • A user restricted to portfolio groups can change 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.
  • Takes no body.
  • Deactivating an owner that is already inactive answers 200 with the owner; dateTimeDeactivated keeps its value and only dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Owner" entry to the owner's activity log when the owner was active, and saves the owner's assignee record.
  • POST /owners/{contactID}/activate - activate the owner again
  • DELETE /owners/{contactID} - delete the owner instead
  • GET /owners/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Tenants

Tenants are the contacts who rent your units, linked to the leases they're on. List, search, create, read, update, activate, deactivate and delete 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 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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 tenant, with any emails, phone numbers and addresses the body lists, and answers with the new tenant's view: the same body as GET /tenants/{contactID}, including the related records the includes parameter names. The tenant isn't put on a lease here.

Use Cases

  • Add a resident, with their contact details and identification, in one request

Business Rules

  • Requires the Update Tenant Details permission (Contacts › UpdateTenant).
  • name is required; the body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the payout settings other contact types take.
  • taxPayerName, taxFormTypeID, taxIdentifier, taxIdentifierTypeID and taxIdentifierCountryID are read only when the role also holds Manage Tax Info & Reporting (1099s) (Contacts › ManageTaxInfo); without it they are ignored, with no error.
  • The new tenant is active. firstName, middleName, lastName and suffix are parsed from name; payoutTypeID is 2 (Check) and holdPayments 0.
  • The first email, phone number and address become the tenant's primary ones, copied to contact.email, contact.phone and the contact's address fields.
  • The tenant's own fields are checked first, and the email, phone and address items only once they pass, so a request with errors in both reports only the tenant's.
  • All of it is saved together: when any item fails validation, nothing is created.
  • The tax identifier is stored encrypted and never returned: contact.hasTaxIdentifier says one is stored.

Side Effects

  • Creates the contact's private-data row (the encrypted tax identifier, when one is sent), its assignee record, a log entry, "Tenant Created", and one log entry per email, phone and address added.
  • Copying the first email, phone number and address onto the contact writes an "Updated Tenant" log entry and saves the assignee record again, once for each.
  • GET /tenants/{contactID} - get the tenant
  • POST /tenants/{contactID} - update the tenant
  • GET /tenants/search - search tenants
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, leases, portalAccounts, portalInvitations.

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

The tenant's full name. firstName, middleName, lastName and suffix are parsed from it.

code
string or null <= 100 characters

The account's own reference code for the tenant.

websiteUrl
string or null <uri> <= 500 characters

The tenant's website. Must be a valid URL.

birthDate
string or null

The tenant's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

(identification_types_request (string or integer)) or null

The kind of identification document.

identificationNumber
string or null <= 50 characters

The identification document's number. Personal data: the contact's reads return it.

identificationCountryID
string or null <= 2 characters

The two-letter code of the country that issued the document; values from GET /countries (undocumented).

identificationIssuingLocation
string or null <= 50 characters

Where the document was issued, such as a state code.

identificationExpirationDate
string or null

The document's expiration date, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

taxPayerName
string or null <= 100 characters

The name on the tenant's tax forms. Read only when the role holds Manage Tax Info & Reporting (1099s).

(form_types_request (string or integer)) or null

The tax form the tenant gets. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifier
string or null

The tenant's tax identifier (an SSN, ITIN or EIN), stored encrypted and never returned. An identifier in the wrong form isn't refused: it is stored with isTaxIdentifierValid "0"; the view's hasTaxIdentifier, isTaxIdentifierValid and taxIdentifierTypeID describe it. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifierTypeID
string or integer (tax_identifier_types_request)
Enum: "1" "2" "3" "4" "99" 1 2 3 4 99

The kind of tax identifier. When it's missing, the type is worked out from the identifier. Read only when the role holds Manage Tax Info & Reporting (1099s).

  • 1 - SSN
  • 2 - ITIN
  • 3 - EIN
  • 4 - Foreign Tax ID
  • 99 - Unknown
taxIdentifierCountryID
string or null <= 2 characters

The two-letter code of the country that issued the tax identifier; leave it empty for the United States. Read only when the role holds Manage Tax Info & Reporting (1099s).

Array of objects (contact_email_request)

Email addresses to add to the tenant.

Array of objects (contact_phone_request)

Phone numbers to add to the tenant.

Array of objects (contact_address_request)

Addresses to add 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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.

Request samples

Content type
application/json
Example
{
  • "name": "Jordan Rivera",
  • "code": "TEN-1001",
  • "websiteUrl": "https://example.com",
  • "birthDate": "1980-04-12",
  • "identificationTypeID": 1,
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "taxPayerName": "Jordan Rivera",
  • "taxIdentifier": "123456789",
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 (undocumented).
  • 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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 a tenant's name, code, website, date of birth and identification, and answers with the tenant's view: the same body as GET /tenants/{contactID}, including the related records the includes parameter names.

Use Cases

  • Correct a tenant's name or date of birth
  • Record a tenant's identification document

Business Rules

  • Requires the Update Tenant Details permission (Contacts › UpdateTenant).
  • A user restricted to portfolio groups can update 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.
  • Send only the fields to change; the others keep their values. The body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the tax fields and emails, phones and addresses.
  • firstName, middleName, lastName and suffix are parsed again from name.
  • A body of only keys this operation ignores isn't empty: it answers 200, and only dateTimeModified changes.
  • 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.

Side Effects

  • A new name is copied into the tenant names of each lease the tenant is active on (the tenants of GET /leases/{leaseID}), and the leases' credit-reporting enrollment is updated to match.
  • A new birthDate queues an update of the tenant's credit-reporting enrollment.
  • A new name records a lease update event for each of those leases, which the account's webhooks receive.
  • When a field changes, writes an "Updated Tenant" entry with the changes to the tenant's activity log, and saves the tenant's assignee record.
  • GET /tenants/{contactID} - get the tenant
  • POST /tenants - create a tenant
  • POST /tenants/{contactID}/deactivate - deactivate the tenant
  • POST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have the same phones and addresses routes
  • POST /tenants/{contactID}/tax-details (undocumented) - change the tax details
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, 404.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, leases, portalAccounts, portalInvitations.

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

The tenant's full name. firstName, middleName, lastName and suffix are parsed from it again.

code
string or null <= 100 characters

The account's own reference code for the tenant.

websiteUrl
string or null <uri> <= 500 characters

The tenant's website. Must be a valid URL.

birthDate
string or null

The tenant's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

(identification_types_request (string or integer)) or null

The kind of identification document.

identificationNumber
string or null <= 50 characters

The identification document's number. Personal data: the contact's reads return it.

identificationCountryID
string or null <= 2 characters

The two-letter code of the country that issued the document; values from GET /countries (undocumented).

identificationIssuingLocation
string or null <= 50 characters

Where the document was issued, such as a state code.

identificationExpirationDate
string or null

The document's expiration date, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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.

Request samples

Content type
application/json
{
  • "name": "Jordan A. Rivera",
  • "code": "TEN-2002",
  • "birthDate": "1981-05-13",
  • "identificationTypeID": 2,
  • "identificationNumber": "P7654321",
  • "identificationCountryID": "CA",
  • "identificationIssuingLocation": "ON",
  • "identificationExpirationDate": "2031-02-28"
}

Response samples

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

Delete Tenant

Deletes a tenant for good, with the records that belong only to the tenant, and answers with the tenant's row as it was. A tenant who is on a lease, or has financial history, can't be deleted: deactivate it instead with POST /tenants/{contactID}/deactivate.

Use Cases

  • Remove a tenant added by mistake, before anything was recorded against them

Business Rules

  • Requires the Update Tenant Details permission (Contacts › UpdateTenant).
  • A user restricted to portfolio groups can delete 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.
  • Refused with 400 when the tenant is on a lease (any lease, closed ones included), or has bills, payouts, recurring bills, accounting transactions, tax adjustments, recurring lease payments, a portfolio share, a withholding tax agency, a reminder it is assigned to, or work orders. The first check that fails names its reason (see the examples); nothing is deleted.
  • 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 response is the tenant's row as it was before the delete, not wrapped in contact, with no tax-identifier keys.

Side Effects

  • Deletes the tenant, its emails, addresses, payment methods, private data (the stored tax identifier), assignee record and vendor trades, and the invoices it is the payee of.
  • Deactivates the tenant's phone numbers (they are kept, with isActive 0), so text threads stay linked.
  • Removes the tenant from work-order technician assignments, and deletes the work-order templates, recurring work orders and property association links that name it.
  • Revokes the tenant's resident portal invitations and portal accounts, so it can no longer sign in to the resident portal.
  • Deletes the tenant's email conversations, activities, notes, alerts, file attachments, custom field values, letters, chat messages, reminders about it, watchers and dates, and writes a log entry, "Tenant Deleted".
  • Deletes each file attached to the tenant that no other record has attached, so it is gone from GET /files/{fileID} too; a file still attached elsewhere is kept.
  • POST /tenants/{contactID}/deactivate - deactivate the tenant instead
  • GET /tenants/{contactID} - get 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, 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the contact.

contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Contact type: 1 Owner, 2 Tenant, 3 Vendor, 4 Manager, 5 Association, 6 Applicant, 7 Screening Prospect, 8 Internal Technician (maintenance technician), 9 Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its includeManager, includeMaintenanceTechnician or contactIDs[] adds.

vendorTypeID
required
string or null^-?[0-9]+$

Vendor type, from GET /contacts/vendor-types (undocumented). Kept for vendors and maintenance technicians; null for other contact types.

code
required
string or null <= 100 characters

Optional short code or reference for the contact.

name
required
string <= 100 characters

Full display name.

firstName
required
string or null <= 100 characters

First name, parsed from name on every save for owners and tenants (and applicants); null for every other contact type.

middleName
required
string or null <= 100 characters

Middle name, parsed from name like firstName; null for types other than owners and tenants.

lastName
required
string or null <= 100 characters

Last name, parsed from name like firstName; null for types other than owners and tenants.

suffix
required
string or null <= 15 characters

Name suffix, parsed from name like firstName; null for types other than owners and tenants.

email
required
string or null <= 100 characters

Primary email address on the contact record.

phone
required
string or null <= 20 characters

Primary phone number on the contact record.

countryID
required
string or null <= 2 characters

Two-letter country code of the contact address.

address
required
string or null <= 100 characters

Street address.

address2
required
string or null <= 100 characters

Second address line.

city
required
string or null <= 45 characters

City.

stateID
required
string or null <= 3 characters

State or province code.

postalCode
required
string or null <= 30 characters

Postal code.

birthDate
required
string or null <date>

Date of birth. Personal data: store and show it only where your integration needs it.

defaultBillChargeAccountID
required
string or null^-?[0-9]+$

Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save).

payeeName
required
string or null <= 100 characters

Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save.

taxPayerName
required
string or null <= 100 characters

Name printed on tax forms; null for maintenance technicians.

required
form_types (string) or null

Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians.

required
identification_types (string) or null

Type of identification on file, or null.

identificationNumber
required
string or null <= 50 characters

The number of the contact's identification document, such as a driver's licence or passport. Personal data: store and show it only where your integration needs it.

identificationCountryID
required
string or null <= 2 characters

Two-letter code of the country that issued the identification.

identificationIssuingLocation
required
string or null <= 100 characters

Where the identification was issued.

identificationExpirationDate
required
string or null <date>

Identification expiry date.

required
payout_types (string) or string

How the contact is paid, or 0 when no payout type is set.

required
other_payout_types (string) or null

How the contact is paid outside Rentvine when payoutTypeID is 1 (Other), or null; always null for maintenance technicians.

achDetailsCiphertextID
required
string or null^-?[0-9]+$

Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians.

achAccountNumberTruncated
required
string or null <= 4 characters

Last 4 digits of the ACH account number; null for maintenance technicians.

required
bank_account_types (string) or null

ACH bank account type, or null; always null for maintenance technicians.

achIsCorporateAccount
required
string
Enum: "0" "1"

1 if the ACH account is a corporate account.

holdPayments
required
string
Enum: "0" "1"

1 if payouts to the contact are on hold. Always 0 for tenants and maintenance technicians.

liabilityInsuranceName
required
string or null <= 100 characters

Liability insurer (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsurancePolicyNumber
required
string or null <= 50 characters

Liability policy number (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsuranceExpiresDate
required
string or null

Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), YYYY-MM-DD. A few rows store 0000-00-00.

workersCompInsuranceName
required
string or null <= 100 characters

Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsurancePolicyNumber
required
string or null <= 50 characters

Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsuranceExpiresDate
required
string or null <date>

Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save).

discountPercent
required
string or null <decimal>

Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save).

discountAmount
required
string or null <decimal>

Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with discountPercent.

discountAmountMin
required
string or null <decimal>

Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountAmountMax
required
string or null <decimal>

Largest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountGraceDays
required
string or null^-?[0-9]+$

Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save).

isActive
required
string
Enum: "0" "1"

1 if the contact is active, 0 if deactivated.

isInsuranceRequiredForPayment
required
string or null
Enum: "0" "1" null

1 if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store 0.

maxLineItemsOnPayment
required
string or null^-?[0-9]+$

Maximum number of bill line items allowed per payment, or null.

preventConsolidatedPayments
required
string
Enum: "0" "1"

1 to prevent consolidated payouts.

isFromImport
required
string
Enum: "0" "1"

1 if the record came from an import.

importSourceKey
required
string or null <= 100 characters

Key of the record in the import it came from, or null.

websiteUrl
required
string or null <= 500 characters

Website address, or null; always null for maintenance technicians.

applicantID
required
string or null^-?[0-9]+$

The applicant this contact was converted from, or null.

ownerPortalNameOverride
required
string or null <= 100 characters

Display name shown in the owner portal instead of name (vendors and associations; null for other contact types, which the API clears on save).

isBillApprovalExempt
required
string
Enum: "0" "1"

1 if bills for this contact skip the bill approval workflow.

isBillingSalesTaxEnabled
required
string
Enum: "0" "1"

1 if sales tax is enabled for invoices billed from this contact. Always 0 except for vendors and associations.

isQuickbooksExportEnabled
required
string
Enum: "0" "1"

1 if QuickBooks export is enabled for this contact. Always 0 except for vendors and managers.

quickbooksCustomerName
required
string or null <= 100 characters

Name used for the contact in QuickBooks; null except for vendors and managers.

invoiceAutofillTemplateID
required
string or null^-?[0-9]+$

ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians.

dateTimeCreated
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

contactType
required
string
Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead"

The contact type's label, computed in PHP: Owner, Tenant, Vendor, Association, Internal Technician (maintenance technicians), and Manager for a manager row a list adds.

Response samples

Content type
application/json
{
  • "contactID": "2772",
  • "contactTypeID": "2",
  • "vendorTypeID": null,
  • "code": "C-6afb87831b71d",
  • "name": "Jordan Lee Rivera Jr.",
  • "firstName": "Jordan",
  • "middleName": "Lee",
  • "lastName": "Rivera",
  • "suffix": "Jr.",
  • "email": "jordan.rivera@example.com",
  • "phone": "+19195550100",
  • "countryID": "US",
  • "address": "100 Main St",
  • "address2": "Suite 200",
  • "city": "Raleigh",
  • "stateID": "NC",
  • "postalCode": "27601",
  • "birthDate": "1980-04-12",
  • "defaultBillChargeAccountID": null,
  • "payeeName": "Jordan Rivera",
  • "taxPayerName": "Jordan Rivera",
  • "taxFormTypeID": "1",
  • "identificationTypeID": "1",
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "payoutTypeID": "1",
  • "otherPayoutTypeID": "1",
  • "achDetailsCiphertextID": "328",
  • "achAccountNumberTruncated": "6789",
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": "12",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": "https://example.com",
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": "318",
  • "dateTimeCreated": "2026-11-16 22:45:23",
  • "dateTimeModified": "2026-11-16 22:45:23",
  • "dateTimeDeactivated": null,
  • "contactType": "Tenant"
}

Activate Tenant

Activates a tenant: sets isActive to 1 and clears dateTimeDeactivated. Answers with the tenant's view: the same body as GET /tenants/{contactID}, including the related records the includes parameter names.

Use Cases

  • Bring back a tenant who was deactivated

Business Rules

  • Requires the Update Tenant Details permission (Contacts › UpdateTenant).
  • A user restricted to portfolio groups can change 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.
  • Takes no body.
  • Activating a tenant that is already active answers 200 with the tenant; only its dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Tenant" entry to the tenant's activity log when the tenant was inactive, and saves the tenant's assignee record.
  • POST /tenants/{contactID}/deactivate - deactivate the tenant
  • GET /tenants/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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": {
    }
}

Deactivate Tenant

Deactivates a tenant: sets isActive to 0 and dateTimeDeactivated to the time of the request. The tenant and everything recorded against it are kept; GET /tenants and GET /tenants/search filter on isActive. Answers with the tenant's view: the same body as GET /tenants/{contactID}, including the related records the includes parameter names.

Use Cases

  • Retire a tenant whose leases are all closed, keeping their history

Business Rules

  • Requires the Update Tenant Details permission (Contacts › UpdateTenant).
  • A user restricted to portfolio groups can change 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.
  • Takes no body.
  • Refused with 400 while the tenant is an active tenant on a lease that is pending or active; deactivate the tenant once those leases are closed (or the tenant is removed from them).
  • Deactivating a tenant that is already inactive answers 200 with the tenant; dateTimeDeactivated keeps its value and only dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Tenant" entry to the tenant's activity log when the tenant was active, and saves the tenant's assignee record.
  • POST /tenants/{contactID}/activate - activate the tenant again
  • DELETE /tenants/{contactID} - delete the tenant instead
  • GET /tenants/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

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": {
    }
}

Vendors

Vendors are the companies and people you pay for services, such as contractors who work on your work orders. List, search, create, read, update, activate, deactivate and delete 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 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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 vendor, with any emails, phone numbers, addresses and attached files the body lists, and answers with the new vendor's view: the same body as GET /vendors/{contactID}, including the related records the includes parameter names.

Use Cases

  • Add a contractor, with their insurance, discount and payout settings, in one request

Business Rules

  • Requires the Update Vendor Details permission (Contacts › UpdateVendor).
  • name is required; the body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, apart from bank-account details this reference doesn't describe.
  • taxPayerName, taxFormTypeID, taxIdentifier, taxIdentifierTypeID and taxIdentifierCountryID are read only when the role also holds Manage Tax Info & Reporting (1099s) (Contacts › ManageTaxInfo); without it they are ignored, with no error.
  • isBillApprovalExempt is read only when the role also holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without it the field is ignored, with no error.
  • payeeName, payoutTypeID, otherPayoutTypeID, achAccountTypeID, achIsCorporateAccount, holdPayments, preventConsolidatedPayments and maxLineItemsOnPayment are taken only here: POST /vendors/{contactID} ignores them.
  • A payout type of 3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request with either and without them is refused with 400.
  • The new vendor is active. payoutTypeID defaults to 2 (Check), and holdPayments, preventConsolidatedPayments, achIsCorporateAccount, isBillApprovalExempt, isBillingSalesTaxEnabled and isQuickbooksExportEnabled to 0. A vendor's firstName, middleName, lastName and suffix are always null.
  • The first email, phone number and address become the vendor's primary ones, copied to contact.email, contact.phone and the contact's address fields.
  • The vendor's own fields are checked first, and the email, phone and address items only once they pass, so a request with errors in both reports only the vendor's.
  • All of it is saved together: when any item fails validation, nothing is created.
  • The tax identifier is stored encrypted and never returned: contact.hasTaxIdentifier says one is stored.
  • Not limited by portfolio-group restrictions: a restricted user can create one.

Side Effects

  • Creates the contact's private-data row (the encrypted tax identifier, when one is sent), its assignee record, a log entry, "Vendor Created", and one log entry per email, phone and address added.
  • Copying the first email, phone number and address onto the contact writes an "Updated Vendor" log entry and saves the assignee record again, once for each.
  • Links each file in attachments to the new vendor.
  • GET /vendors/{contactID} - get the vendor
  • POST /vendors/{contactID} - update the vendor
  • GET /vendors/search - search vendors
Authorizations:
basicAuth
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.

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

The vendor's name.

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

The vendor's type; values from GET /contacts/vendor-types (undocumented).

code
string or null <= 100 characters

The account's own reference code for the vendor.

websiteUrl
string or null <uri> <= 500 characters

The vendor's website. Must be a valid URL.

birthDate
string or null

A date of birth, for a vendor who is a person, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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

The account the vendor's bills are charged to by default; values from GET /accounting/accounts.

liabilityInsuranceName
string or null <= 100 characters

The vendor's liability insurer.

liabilityInsurancePolicyNumber
string or null <= 50 characters

The liability insurance policy number.

liabilityInsuranceExpiresDate
string or null

When the liability insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

workersCompInsuranceName
string or null <= 100 characters

The vendor's workers' compensation insurer.

workersCompInsurancePolicyNumber
string or null <= 50 characters

The workers' compensation policy number.

workersCompInsuranceExpiresDate
string or null

When the workers' compensation insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

discountPercent
string or number or null <decimal>

An early-payment discount, as a percentage from 0.1 to 99; 0 is stored as null, and any other value outside the range is refused. A vendor can't have both discountPercent and discountAmount, counting one already stored.

discountAmount
string or number or null <decimal> >= 0

An early-payment discount, as an amount. A vendor can't have both discountPercent and discountAmount, counting one already stored; 0 is stored as null.

discountAmountMin
string or number or null <decimal> >= 0

The smallest discount amount; 0 is stored as null.

discountAmountMax
string or number or null <decimal> >= 0

The largest discount amount; 0 is stored as null.

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

How many days after the bill the discount still applies; a whole number, 0 or more.

isInsuranceRequiredForPayment
string or integer or null
Enum: "0" "1" 0 1 null

Whether the vendor's insurance must be current before it can be paid. true, false, yes and no are read too.

ownerPortalNameOverride
string or null <= 100 characters

The name owners see for the vendor in the owner portal; empty is stored as null.

isBillingSalesTaxEnabled
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether sales tax is billed on the vendor's invoices. true, false, yes and no are read too.

isQuickbooksExportEnabled
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the vendor is exported to QuickBooks; needs quickbooksCustomerName. true, false, yes and no are read too.

quickbooksCustomerName
string or null <= 100 characters

The vendor's name in QuickBooks; required when isQuickbooksExportEnabled is 1.

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

The template the vendor's invoices are filled from; values from GET /accounting/invoices/autofill-templates (undocumented).

payeeName
string or null <= 100 characters

The name payments are made out to, when it isn't name. Taken only on a create.

payoutTypeID
string or integer (payout_types_request)
Default: 2
Enum: "1" "2" "3" "4" 1 2 3 4

How the vendor is paid; defaults to 2 (Check). Taken only on a create. 3 (eCheck) and 4 (NACHA) need bank details this reference doesn't describe; without them the request is refused.

  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(other_payout_types_request (string or integer)) or null

How the vendor is paid when payoutTypeID is 1 (Other). Taken only on a create.

(bank_account_types_request (string or integer)) or null

The kind of bank account payments go to; required with a payout type of 3 (eCheck) or 4 (NACHA). Taken only on a create.

achIsCorporateAccount
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether the vendor's bank account is a business account. true, false, yes and no are read too.

holdPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether payments to the vendor are held. true, false, yes and no are read too.

preventConsolidatedPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether the vendor's payments are kept apart instead of combined into one payment. true, false, yes and no are read too.

maxLineItemsOnPayment
string or integer or null

The most bill lines one payment to the vendor carries, as a whole number. Taken only on a create.

isBillApprovalExempt
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the vendor's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

taxPayerName
string or null <= 100 characters

The name on the vendor's tax forms. Read only when the role holds Manage Tax Info & Reporting (1099s).

(form_types_request (string or integer)) or null

The tax form the vendor gets. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifier
string or null

The vendor's tax identifier (an SSN, ITIN or EIN), stored encrypted and never returned. An identifier in the wrong form isn't refused: it is stored with isTaxIdentifierValid "0"; the view's hasTaxIdentifier, isTaxIdentifierValid and taxIdentifierTypeID describe it. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifierTypeID
string or integer (tax_identifier_types_request)
Enum: "1" "2" "3" "4" "99" 1 2 3 4 99

The kind of tax identifier. When it's missing, the type is worked out from the identifier. Read only when the role holds Manage Tax Info & Reporting (1099s).

  • 1 - SSN
  • 2 - ITIN
  • 3 - EIN
  • 4 - Foreign Tax ID
  • 99 - Unknown
taxIdentifierCountryID
string or null <= 2 characters

The two-letter code of the country that issued the tax identifier; leave it empty for the United States. Read only when the role holds Manage Tax Info & Reporting (1099s).

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

Files to attach to the vendor, by file ID: upload one with POST /files, or take an ID from GET /files. Each must be an existing file.

Array of objects (contact_email_request)

Email addresses to add to the vendor.

Array of objects (contact_phone_request)

Phone numbers to add to the vendor.

Array of objects (contact_address_request)

Addresses to add 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
Example
{
  • "name": "Rivera Plumbing LLC",
  • "code": "VEN-1001",
  • "vendorTypeID": "436",
  • "websiteUrl": "https://example.com",
  • "defaultBillChargeAccountID": "1",
  • "liabilityInsuranceName": "Acme Insurance",
  • "liabilityInsurancePolicyNumber": "L-1001",
  • "liabilityInsuranceExpiresDate": "2030-06-30",
  • "workersCompInsuranceName": "Acme Workers Comp",
  • "workersCompInsurancePolicyNumber": "W-2002",
  • "workersCompInsuranceExpiresDate": "2030-07-31",
  • "discountPercent": "2.50",
  • "discountGraceDays": 10,
  • "isInsuranceRequiredForPayment": 1,
  • "ownerPortalNameOverride": "Rivera Plumbing",
  • "isBillingSalesTaxEnabled": 1,
  • "isQuickbooksExportEnabled": 1,
  • "quickbooksCustomerName": "Rivera Plumbing",
  • "invoiceAutofillTemplateID": "325",
  • "payeeName": "Rivera Plumbing LLC",
  • "payoutTypeID": 1,
  • "otherPayoutTypeID": 1,
  • "holdPayments": 1,
  • "preventConsolidatedPayments": 1,
  • "maxLineItemsOnPayment": 12,
  • "isBillApprovalExempt": 1,
  • "taxPayerName": "Rivera Plumbing LLC",
  • "taxFormTypeID": 1,
  • "taxIdentifier": "12-3456789",
  • "taxIdentifierTypeID": 3,
  • "attachments": [
    ],
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 a vendor's name, type, insurance, discount and billing settings, and answers with the vendor's view: the same body as GET /vendors/{contactID}, including the related records the includes parameter names.

Use Cases

  • Record a vendor's renewed insurance
  • Change a vendor's discount or QuickBooks settings

Business Rules

  • Requires the Update Vendor Details permission (Contacts › UpdateVendor).
  • Send only the fields to change; the others keep their values. The body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the payout settings POST /vendors takes, the tax fields, and emails, phones, addresses and attachments.
  • isBillApprovalExempt is read only when the role also holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without it the field is ignored, with no error.
  • A body of only keys this operation ignores isn't empty: it answers 200, and only dateTimeModified changes.
  • Not limited by portfolio-group restrictions: a restricted user can update any 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.

Side Effects

  • When a field changes, writes an "Updated Vendor" entry with the changes to the vendor's activity log, and saves the vendor's assignee record.
  • GET /vendors/{contactID} - get the vendor
  • POST /vendors - create a vendor
  • POST /vendors/{contactID}/deactivate - deactivate the vendor
  • POST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have the same phones and addresses routes
  • POST /vendors/{contactID}/tax-details (undocumented) - change the tax details
  • POST /vendors/{contactID}/ach-details (undocumented) - change the payout settings
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, 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.

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

The vendor's type; values from GET /contacts/vendor-types (undocumented).

name
string [ 1 .. 100 ] characters

The vendor's name.

code
string or null <= 100 characters

The account's own reference code for the vendor.

websiteUrl
string or null <uri> <= 500 characters

The vendor's website. Must be a valid URL.

birthDate
string or null

A date of birth, for a vendor who is a person, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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

The account the vendor's bills are charged to by default; values from GET /accounting/accounts.

liabilityInsuranceName
string or null <= 100 characters

The vendor's liability insurer.

liabilityInsurancePolicyNumber
string or null <= 50 characters

The liability insurance policy number.

liabilityInsuranceExpiresDate
string or null

When the liability insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

workersCompInsuranceName
string or null <= 100 characters

The vendor's workers' compensation insurer.

workersCompInsurancePolicyNumber
string or null <= 50 characters

The workers' compensation policy number.

workersCompInsuranceExpiresDate
string or null

When the workers' compensation insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

discountPercent
string or number or null <decimal>

An early-payment discount, as a percentage from 0.1 to 99; 0 is stored as null, and any other value outside the range is refused. A vendor can't have both discountPercent and discountAmount, counting one already stored.

discountAmount
string or number or null <decimal> >= 0

An early-payment discount, as an amount. A vendor can't have both discountPercent and discountAmount, counting one already stored; 0 is stored as null.

discountAmountMin
string or number or null <decimal> >= 0

The smallest discount amount; 0 is stored as null.

discountAmountMax
string or number or null <decimal> >= 0

The largest discount amount; 0 is stored as null.

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

How many days after the bill the discount still applies; a whole number, 0 or more.

isInsuranceRequiredForPayment
string or integer or null
Enum: "0" "1" 0 1 null

Whether the vendor's insurance must be current before it can be paid. true, false, yes and no are read too.

ownerPortalNameOverride
string or null <= 100 characters

The name owners see for the vendor in the owner portal; empty is stored as null.

isBillingSalesTaxEnabled
string or integer
Enum: "0" "1" 0 1

Whether sales tax is billed on the vendor's invoices. true, false, yes and no are read too.

isQuickbooksExportEnabled
string or integer
Enum: "0" "1" 0 1

Whether the vendor is exported to QuickBooks; needs quickbooksCustomerName. true, false, yes and no are read too.

quickbooksCustomerName
string or null <= 100 characters

The vendor's name in QuickBooks; required when isQuickbooksExportEnabled is 1.

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

The template the vendor's invoices are filled from; values from GET /accounting/invoices/autofill-templates (undocumented).

isBillApprovalExempt
string or integer
Enum: "0" "1" 0 1

Whether the vendor's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
{
  • "name": "Rivera Plumbing & Heating LLC",
  • "code": "VEN-2002",
  • "liabilityInsurancePolicyNumber": "L-3003",
  • "liabilityInsuranceExpiresDate": "2031-06-30",
  • "discountPercent": "3.00",
  • "isBillApprovalExempt": 1
}

Response samples

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

Delete Vendor

Deletes a vendor for good, with the records that belong only to it, and answers with the vendor's row as it was. A vendor with history can't be deleted: deactivate it instead with POST /vendors/{contactID}/deactivate.

Use Cases

  • Remove a vendor added by mistake, before anything was recorded against them

Business Rules

  • Requires the Update Vendor Details permission (Contacts › UpdateVendor).
  • Refused with 400 when the vendor has work orders, or has bills, payouts, recurring bills, accounting transactions, tax adjustments, leases, recurring lease payments, a portfolio share, a withholding tax agency or a reminder it is assigned to. The first check that fails names its reason (see the examples); nothing is deleted.
  • Not limited by portfolio-group restrictions.
  • 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 response is the vendor's row as it was before the delete, not wrapped in contact, with no tax-identifier keys.

Side Effects

  • Deletes the vendor, its emails, addresses, payment methods, private data (the stored tax identifier), assignee record and vendor trades, and the invoices it is the payee of.
  • Deactivates the vendor's phone numbers (they are kept, with isActive 0), so text threads stay linked.
  • Removes the vendor from work-order technician assignments, and deletes the work-order templates, recurring work orders and property association links that name it.
  • Revokes the vendor's vendor portal invitations and portal accounts, so it can no longer sign in to the vendor portal.
  • Deletes the vendor's email conversations, activities, notes, alerts, file attachments, custom field values, letters, chat messages, reminders about it, watchers and dates, and writes a log entry, "Vendor Deleted".
  • Deletes each file attached to the vendor that no other record has attached, so it is gone from GET /files/{fileID} too; a file still attached elsewhere is kept.
  • POST /vendors/{contactID}/deactivate - deactivate the vendor instead
  • GET /vendors/{contactID} - get 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, 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the contact.

contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Contact type: 1 Owner, 2 Tenant, 3 Vendor, 4 Manager, 5 Association, 6 Applicant, 7 Screening Prospect, 8 Internal Technician (maintenance technician), 9 Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its includeManager, includeMaintenanceTechnician or contactIDs[] adds.

vendorTypeID
required
string or null^-?[0-9]+$

Vendor type, from GET /contacts/vendor-types (undocumented). Kept for vendors and maintenance technicians; null for other contact types.

code
required
string or null <= 100 characters

Optional short code or reference for the contact.

name
required
string <= 100 characters

Full display name.

firstName
required
string or null <= 100 characters

First name, parsed from name on every save for owners and tenants (and applicants); null for every other contact type.

middleName
required
string or null <= 100 characters

Middle name, parsed from name like firstName; null for types other than owners and tenants.

lastName
required
string or null <= 100 characters

Last name, parsed from name like firstName; null for types other than owners and tenants.

suffix
required
string or null <= 15 characters

Name suffix, parsed from name like firstName; null for types other than owners and tenants.

email
required
string or null <= 100 characters

Primary email address on the contact record.

phone
required
string or null <= 20 characters

Primary phone number on the contact record.

countryID
required
string or null <= 2 characters

Two-letter country code of the contact address.

address
required
string or null <= 100 characters

Street address.

address2
required
string or null <= 100 characters

Second address line.

city
required
string or null <= 45 characters

City.

stateID
required
string or null <= 3 characters

State or province code.

postalCode
required
string or null <= 30 characters

Postal code.

birthDate
required
string or null <date>

Date of birth. Personal data: store and show it only where your integration needs it.

defaultBillChargeAccountID
required
string or null^-?[0-9]+$

Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save).

payeeName
required
string or null <= 100 characters

Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save.

taxPayerName
required
string or null <= 100 characters

Name printed on tax forms; null for maintenance technicians.

required
form_types (string) or null

Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians.

required
identification_types (string) or null

Type of identification on file, or null.

identificationNumber
required
string or null <= 50 characters

The number of the contact's identification document, such as a driver's licence or passport. Personal data: store and show it only where your integration needs it.

identificationCountryID
required
string or null <= 2 characters

Two-letter code of the country that issued the identification.

identificationIssuingLocation
required
string or null <= 100 characters

Where the identification was issued.

identificationExpirationDate
required
string or null <date>

Identification expiry date.

required
payout_types (string) or string

How the contact is paid, or 0 when no payout type is set.

required
other_payout_types (string) or null

How the contact is paid outside Rentvine when payoutTypeID is 1 (Other), or null; always null for maintenance technicians.

achDetailsCiphertextID
required
string or null^-?[0-9]+$

Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians.

achAccountNumberTruncated
required
string or null <= 4 characters

Last 4 digits of the ACH account number; null for maintenance technicians.

required
bank_account_types (string) or null

ACH bank account type, or null; always null for maintenance technicians.

achIsCorporateAccount
required
string
Enum: "0" "1"

1 if the ACH account is a corporate account.

holdPayments
required
string
Enum: "0" "1"

1 if payouts to the contact are on hold. Always 0 for tenants and maintenance technicians.

liabilityInsuranceName
required
string or null <= 100 characters

Liability insurer (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsurancePolicyNumber
required
string or null <= 50 characters

Liability policy number (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsuranceExpiresDate
required
string or null

Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), YYYY-MM-DD. A few rows store 0000-00-00.

workersCompInsuranceName
required
string or null <= 100 characters

Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsurancePolicyNumber
required
string or null <= 50 characters

Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsuranceExpiresDate
required
string or null <date>

Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save).

discountPercent
required
string or null <decimal>

Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save).

discountAmount
required
string or null <decimal>

Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with discountPercent.

discountAmountMin
required
string or null <decimal>

Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountAmountMax
required
string or null <decimal>

Largest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountGraceDays
required
string or null^-?[0-9]+$

Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save).

isActive
required
string
Enum: "0" "1"

1 if the contact is active, 0 if deactivated.

isInsuranceRequiredForPayment
required
string or null
Enum: "0" "1" null

1 if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store 0.

maxLineItemsOnPayment
required
string or null^-?[0-9]+$

Maximum number of bill line items allowed per payment, or null.

preventConsolidatedPayments
required
string
Enum: "0" "1"

1 to prevent consolidated payouts.

isFromImport
required
string
Enum: "0" "1"

1 if the record came from an import.

importSourceKey
required
string or null <= 100 characters

Key of the record in the import it came from, or null.

websiteUrl
required
string or null <= 500 characters

Website address, or null; always null for maintenance technicians.

applicantID
required
string or null^-?[0-9]+$

The applicant this contact was converted from, or null.

ownerPortalNameOverride
required
string or null <= 100 characters

Display name shown in the owner portal instead of name (vendors and associations; null for other contact types, which the API clears on save).

isBillApprovalExempt
required
string
Enum: "0" "1"

1 if bills for this contact skip the bill approval workflow.

isBillingSalesTaxEnabled
required
string
Enum: "0" "1"

1 if sales tax is enabled for invoices billed from this contact. Always 0 except for vendors and associations.

isQuickbooksExportEnabled
required
string
Enum: "0" "1"

1 if QuickBooks export is enabled for this contact. Always 0 except for vendors and managers.

quickbooksCustomerName
required
string or null <= 100 characters

Name used for the contact in QuickBooks; null except for vendors and managers.

invoiceAutofillTemplateID
required
string or null^-?[0-9]+$

ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians.

dateTimeCreated
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

contactType
required
string
Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead"

The contact type's label, computed in PHP: Owner, Tenant, Vendor, Association, Internal Technician (maintenance technicians), and Manager for a manager row a list adds.

Response samples

Content type
application/json
{
  • "contactID": "2872",
  • "contactTypeID": "3",
  • "vendorTypeID": "442",
  • "code": "C-6afb879c970dd",
  • "name": "Jordan Lee Rivera Jr.",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": "jordan.rivera@example.com",
  • "phone": "+19195550100",
  • "countryID": "US",
  • "address": "100 Main St",
  • "address2": "Suite 200",
  • "city": "Raleigh",
  • "stateID": "NC",
  • "postalCode": "27601",
  • "birthDate": "1980-04-12",
  • "defaultBillChargeAccountID": "1",
  • "payeeName": "Jordan Rivera",
  • "taxPayerName": "Jordan Rivera",
  • "taxFormTypeID": "1",
  • "identificationTypeID": "1",
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "payoutTypeID": "1",
  • "otherPayoutTypeID": "1",
  • "achDetailsCiphertextID": "340",
  • "achAccountNumberTruncated": "6789",
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "1",
  • "liabilityInsuranceName": "Acme Insurance",
  • "liabilityInsurancePolicyNumber": "L-1001",
  • "liabilityInsuranceExpiresDate": "2030-06-30",
  • "workersCompInsuranceName": "Acme Workers Comp",
  • "workersCompInsurancePolicyNumber": "W-2002",
  • "workersCompInsuranceExpiresDate": "2030-07-31",
  • "discountPercent": "2.5000",
  • "discountAmount": null,
  • "discountAmountMin": "1.00",
  • "discountAmountMax": "50.00",
  • "discountGraceDays": "10",
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": "12",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": "https://example.com",
  • "applicantID": null,
  • "ownerPortalNameOverride": "Rivera Holdings",
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "1",
  • "isQuickbooksExportEnabled": "1",
  • "quickbooksCustomerName": "Rivera, Jordan",
  • "invoiceAutofillTemplateID": "331",
  • "dateTimeCreated": "2026-11-16 22:45:48",
  • "dateTimeModified": "2026-11-16 22:45:48",
  • "dateTimeDeactivated": null,
  • "contactType": "Vendor"
}

Activate Vendor

Activates a vendor: sets isActive to 1 and clears dateTimeDeactivated. Answers with the vendor's view: the same body as GET /vendors/{contactID}, including the related records the includes parameter names.

Use Cases

  • Bring back a vendor who was deactivated

Business Rules

  • Requires the Update Vendor Details permission (Contacts › UpdateVendor).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Activating a vendor that is already active answers 200 with the vendor; only its dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Vendor" entry to the vendor's activity log when the vendor was inactive, and saves its assignee record.
  • POST /vendors/{contactID}/deactivate - deactivate the vendor
  • GET /vendors/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Deactivate Vendor

Deactivates a vendor: sets isActive to 0 and dateTimeDeactivated to the time of the request. The vendor and everything recorded against it are kept; GET /vendors and GET /vendors/search filter on isActive. Answers with the vendor's view: the same body as GET /vendors/{contactID}, including the related records the includes parameter names.

Use Cases

  • Retire a vendor who no longer works for the account, keeping their history

Business Rules

  • Requires the Update Vendor Details permission (Contacts › UpdateVendor).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Deactivating a vendor that is already inactive answers 200 with the vendor; dateTimeDeactivated keeps its value and only dateTimeModified changes.
  • 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.

Side Effects

  • Deletes every recurring work order the vendor is assigned to, so no new work orders are generated for it.
  • Writes an "Updated Vendor" entry to the vendor's activity log when the vendor was active, and saves its assignee record.
  • POST /vendors/{contactID}/activate - activate the vendor again
  • DELETE /vendors/{contactID} - delete the vendor instead
  • GET /vendors/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Associations

Associations are the homeowners' and condominium associations your properties belong to. List, search, create, read, update, activate, deactivate and delete 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 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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an association (a homeowners' or condominium association), with any emails, phone numbers, addresses and attached files the body lists, and answers with the new association's view: the same body as GET /associations/{contactID}, including the related records the includes parameter names.

Use Cases

  • Add the homeowners' association a property belongs to, with its insurance, discount and payout settings

Business Rules

  • Requires the Update Association Details permission (Contacts › UpdateAssociation).
  • name is required; the body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them vendorTypeID, the discount amounts and the QuickBooks fields POST /vendors takes (bank-account details this reference doesn't describe are read).
  • taxPayerName, taxFormTypeID, taxIdentifier, taxIdentifierTypeID and taxIdentifierCountryID are read only when the role also holds Manage Tax Info & Reporting (1099s) (Contacts › ManageTaxInfo); without it they are ignored, with no error.
  • isBillApprovalExempt is read only when the role also holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without it the field is ignored, with no error.
  • payeeName, payoutTypeID, otherPayoutTypeID, achAccountTypeID, achIsCorporateAccount, holdPayments, preventConsolidatedPayments and maxLineItemsOnPayment are taken only here: POST /associations/{contactID} ignores them.
  • A payout type of 3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request with either and without them is refused with 400.
  • The new association is active. payoutTypeID defaults to 2 (Check), and holdPayments, preventConsolidatedPayments, achIsCorporateAccount, isBillApprovalExempt and isBillingSalesTaxEnabled to 0. An association's firstName, middleName, lastName and suffix are always null, and isQuickbooksExportEnabled is 0.
  • The first email, phone number and address become the association's primary ones, copied to contact.email, contact.phone and the contact's address fields.
  • The association's own fields are checked first, and the email, phone and address items only once they pass, so a request with errors in both reports only the association's.
  • All of it is saved together: when any item fails validation, nothing is created.
  • The tax identifier is stored encrypted and never returned: contact.hasTaxIdentifier says one is stored.
  • Not limited by portfolio-group restrictions: a restricted user can create one.

Side Effects

  • Creates the contact's private-data row (the encrypted tax identifier, when one is sent), its assignee record, a log entry, "Association Created", and one log entry per email, phone and address added.
  • Copying the first email, phone number and address onto the contact writes an "Updated Association" log entry and saves the assignee record again, once for each.
  • Links each file in attachments to the new association.
  • GET /associations/{contactID} - get the association
  • POST /associations/{contactID} - update the association
  • GET /associations/search - search associations
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate.

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

The association's name.

code
string or null <= 100 characters

The account's own reference code for the association.

websiteUrl
string or null <uri> <= 500 characters

The association's website. Must be a valid URL.

birthDate
string or null

A date of birth; rarely used for an association, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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

The account the association's bills are charged to by default; values from GET /accounting/accounts.

liabilityInsuranceName
string or null <= 100 characters

The association's liability insurer.

liabilityInsurancePolicyNumber
string or null <= 50 characters

The liability insurance policy number.

liabilityInsuranceExpiresDate
string or null

When the liability insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

workersCompInsuranceName
string or null <= 100 characters

The association's workers' compensation insurer.

workersCompInsurancePolicyNumber
string or null <= 50 characters

The workers' compensation policy number.

workersCompInsuranceExpiresDate
string or null

When the workers' compensation insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

discountPercent
string or number or null <decimal>

An early-payment discount, as a percentage from 0.1 to 99; 0 is stored as null, and any other value outside the range is refused.

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

How many days after the bill the discount still applies; a whole number, 0 or more.

ownerPortalNameOverride
string or null <= 100 characters

The name owners see for the association in the owner portal; empty is stored as null.

isBillingSalesTaxEnabled
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether sales tax is billed on the association's invoices. true, false, yes and no are read too.

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

The template the association's invoices are filled from; values from GET /accounting/invoices/autofill-templates (undocumented).

payeeName
string or null <= 100 characters

The name payments are made out to, when it isn't name. Taken only on a create.

payoutTypeID
string or integer (payout_types_request)
Default: 2
Enum: "1" "2" "3" "4" 1 2 3 4

How the association is paid; defaults to 2 (Check). Taken only on a create. 3 (eCheck) and 4 (NACHA) need bank details this reference doesn't describe; without them the request is refused.

  • 1 - Other
  • 2 - Check
  • 3 - eCheck (ACH)
  • 4 - NACHA (ACH)
(other_payout_types_request (string or integer)) or null

How the association is paid when payoutTypeID is 1 (Other). Taken only on a create.

(bank_account_types_request (string or integer)) or null

The kind of bank account payments go to; required with a payout type of 3 (eCheck) or 4 (NACHA). Taken only on a create.

achIsCorporateAccount
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether the association's bank account is a business account. true, false, yes and no are read too.

holdPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether payments to the association are held. true, false, yes and no are read too.

preventConsolidatedPayments
string or integer
Default: 0
Enum: "0" "1" 0 1

Taken only on a create. Whether the association's payments are kept apart instead of combined into one payment. true, false, yes and no are read too.

maxLineItemsOnPayment
string or integer or null

The most bill lines one payment to the association carries, as a whole number. Taken only on a create.

isBillApprovalExempt
string or integer
Default: 0
Enum: "0" "1" 0 1

Whether the association's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

taxPayerName
string or null <= 100 characters

The name on the association's tax forms. Read only when the role holds Manage Tax Info & Reporting (1099s).

(form_types_request (string or integer)) or null

The tax form the association gets. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifier
string or null

The association's tax identifier (an SSN, ITIN or EIN), stored encrypted and never returned. An identifier in the wrong form isn't refused: it is stored with isTaxIdentifierValid "0"; the view's hasTaxIdentifier, isTaxIdentifierValid and taxIdentifierTypeID describe it. Read only when the role holds Manage Tax Info & Reporting (1099s).

taxIdentifierTypeID
string or integer (tax_identifier_types_request)
Enum: "1" "2" "3" "4" "99" 1 2 3 4 99

The kind of tax identifier. When it's missing, the type is worked out from the identifier. Read only when the role holds Manage Tax Info & Reporting (1099s).

  • 1 - SSN
  • 2 - ITIN
  • 3 - EIN
  • 4 - Foreign Tax ID
  • 99 - Unknown
taxIdentifierCountryID
string or null <= 2 characters

The two-letter code of the country that issued the tax identifier; leave it empty for the United States. Read only when the role holds Manage Tax Info & Reporting (1099s).

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

Files to attach to the association, by file ID: upload one with POST /files, or take an ID from GET /files. Each must be an existing file.

Array of objects (contact_email_request)

Email addresses to add to the association.

Array of objects (contact_phone_request)

Phone numbers to add to the association.

Array of objects (contact_address_request)

Addresses to add to the association.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
Example
{
  • "name": "Oak Ridge HOA",
  • "code": "HOA-1001",
  • "websiteUrl": "https://example.com",
  • "defaultBillChargeAccountID": "1",
  • "liabilityInsuranceName": "Acme Insurance",
  • "liabilityInsurancePolicyNumber": "L-1001",
  • "liabilityInsuranceExpiresDate": "2030-06-30",
  • "discountPercent": "2.50",
  • "discountGraceDays": 10,
  • "ownerPortalNameOverride": "Oak Ridge",
  • "isBillingSalesTaxEnabled": 1,
  • "invoiceAutofillTemplateID": "345",
  • "payeeName": "Oak Ridge Homeowners Association",
  • "payoutTypeID": 2,
  • "holdPayments": 1,
  • "preventConsolidatedPayments": 1,
  • "maxLineItemsOnPayment": 12,
  • "isBillApprovalExempt": 1,
  • "taxPayerName": "Oak Ridge Homeowners Association",
  • "taxFormTypeID": 1,
  • "taxIdentifier": "12-3456789",
  • "taxIdentifierTypeID": 3,
  • "attachments": [
    ],
  • "emails": [
    ],
  • "phones": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an association's name, insurance, discount and billing settings, and answers with the association's view: the same body as GET /associations/{contactID}, including the related records the includes parameter names.

Use Cases

  • Record an association's renewed insurance
  • Change an association's discount

Business Rules

  • Requires the Update Association Details permission (Contacts › UpdateAssociation).
  • Send only the fields to change; the others keep their values. The body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the payout settings POST /associations takes, the tax fields, and emails, phones, addresses and attachments.
  • isBillApprovalExempt is read only when the role also holds Update Bill Approval Exemption (Contacts › UpdateBillApprovalExemption); without it the field is ignored, with no error.
  • A body of only keys this operation ignores isn't empty: it answers 200, and only dateTimeModified changes.
  • Not limited by portfolio-group restrictions: a restricted user can update any 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.

Side Effects

  • When a field changes, writes an "Updated Association" entry with the changes to the association's activity log, and saves the association's assignee record.
  • GET /associations/{contactID} - get the association
  • POST /associations - create an association
  • POST /associations/{contactID}/deactivate - deactivate the association
  • POST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have the same phones and addresses routes
  • POST /associations/{contactID}/tax-details (undocumented) - change the tax details
  • POST /associations/{contactID}/ach-details (undocumented) - change the payout settings
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, 404.

query Parameters
includes
string
Example: includes=emails,phones,addresses

Comma-separated related records to add: emails, phones, addresses, properties, contactPersons, invoiceAutofillTemplate.

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

The association's name.

code
string or null <= 100 characters

The account's own reference code for the association.

websiteUrl
string or null <uri> <= 500 characters

The association's website. Must be a valid URL.

birthDate
string or null

A date of birth; rarely used for an association, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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

The account the association's bills are charged to by default; values from GET /accounting/accounts.

liabilityInsuranceName
string or null <= 100 characters

The association's liability insurer.

liabilityInsurancePolicyNumber
string or null <= 50 characters

The liability insurance policy number.

liabilityInsuranceExpiresDate
string or null

When the liability insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

workersCompInsuranceName
string or null <= 100 characters

The association's workers' compensation insurer.

workersCompInsurancePolicyNumber
string or null <= 50 characters

The workers' compensation policy number.

workersCompInsuranceExpiresDate
string or null

When the workers' compensation insurance expires, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

discountPercent
string or number or null <decimal>

An early-payment discount, as a percentage from 0.1 to 99; 0 is stored as null, and any other value outside the range is refused.

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

How many days after the bill the discount still applies; a whole number, 0 or more.

ownerPortalNameOverride
string or null <= 100 characters

The name owners see for the association in the owner portal; empty is stored as null.

isBillingSalesTaxEnabled
string or integer
Enum: "0" "1" 0 1

Whether sales tax is billed on the association's invoices. true, false, yes and no are read too.

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

The template the association's invoices are filled from; values from GET /accounting/invoices/autofill-templates (undocumented).

isBillApprovalExempt
string or integer
Enum: "0" "1" 0 1

Whether the association's bills skip the approval step. Read only when the role holds Update Bill Approval Exemption; ignored otherwise. true, false, yes and no are read too.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
{
  • "name": "Oak Ridge Homeowners Association",
  • "code": "HOA-2002",
  • "liabilityInsurancePolicyNumber": "L-3003",
  • "liabilityInsuranceExpiresDate": "2031-06-30",
  • "discountPercent": "3.00",
  • "isBillApprovalExempt": 1
}

Response samples

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

Delete Association

Deletes an association for good, with the records that belong only to it, and answers with the association's row as it was. An association with history can't be deleted: deactivate it instead with POST /associations/{contactID}/deactivate.

Use Cases

  • Remove an association added by mistake, before anything was recorded against them

Business Rules

  • Requires the Update Association Details permission (Contacts › UpdateAssociation).
  • Refused with 400 when the association has bills, payouts, recurring bills, accounting transactions, tax adjustments, leases, recurring lease payments, a portfolio share, a withholding tax agency, a reminder it is assigned to, or work orders. The first check that fails names its reason (see the examples); nothing is deleted.
  • Not limited by portfolio-group restrictions.
  • 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 response is the association's row as it was before the delete, not wrapped in contact, with no tax-identifier keys.

Side Effects

  • Deletes the association, its emails, addresses, payment methods, private data (the stored tax identifier), assignee record and vendor trades, and the invoices it is the payee of.
  • Deactivates the association's phone numbers (they are kept, with isActive 0), so text threads stay linked.
  • Removes the association from work-order technician assignments, and deletes the work-order templates, recurring work orders and property association links that name it.
  • Revokes the association's association portal invitations and portal accounts, so it can no longer sign in to the association portal.
  • Deletes the association's email conversations, activities, notes, alerts, file attachments, custom field values, letters, chat messages, reminders about it, watchers and dates, and writes a log entry, "Association Deleted".
  • Deletes each file attached to the association that no other record has attached, so it is gone from GET /files/{fileID} too; a file still attached elsewhere is kept.
  • Unlinks the association from every property it was linked to (the associations of GET /properties/{propertyID}).
  • POST /associations/{contactID}/deactivate - deactivate the association instead
  • GET /associations/{contactID} - get 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, 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the contact.

contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Contact type: 1 Owner, 2 Tenant, 3 Vendor, 4 Manager, 5 Association, 6 Applicant, 7 Screening Prospect, 8 Internal Technician (maintenance technician), 9 Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its includeManager, includeMaintenanceTechnician or contactIDs[] adds.

vendorTypeID
required
string or null^-?[0-9]+$

Vendor type, from GET /contacts/vendor-types (undocumented). Kept for vendors and maintenance technicians; null for other contact types.

code
required
string or null <= 100 characters

Optional short code or reference for the contact.

name
required
string <= 100 characters

Full display name.

firstName
required
string or null <= 100 characters

First name, parsed from name on every save for owners and tenants (and applicants); null for every other contact type.

middleName
required
string or null <= 100 characters

Middle name, parsed from name like firstName; null for types other than owners and tenants.

lastName
required
string or null <= 100 characters

Last name, parsed from name like firstName; null for types other than owners and tenants.

suffix
required
string or null <= 15 characters

Name suffix, parsed from name like firstName; null for types other than owners and tenants.

email
required
string or null <= 100 characters

Primary email address on the contact record.

phone
required
string or null <= 20 characters

Primary phone number on the contact record.

countryID
required
string or null <= 2 characters

Two-letter country code of the contact address.

address
required
string or null <= 100 characters

Street address.

address2
required
string or null <= 100 characters

Second address line.

city
required
string or null <= 45 characters

City.

stateID
required
string or null <= 3 characters

State or province code.

postalCode
required
string or null <= 30 characters

Postal code.

birthDate
required
string or null <date>

Date of birth. Personal data: store and show it only where your integration needs it.

defaultBillChargeAccountID
required
string or null^-?[0-9]+$

Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save).

payeeName
required
string or null <= 100 characters

Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save.

taxPayerName
required
string or null <= 100 characters

Name printed on tax forms; null for maintenance technicians.

required
form_types (string) or null

Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians.

required
identification_types (string) or null

Type of identification on file, or null.

identificationNumber
required
string or null <= 50 characters

The number of the contact's identification document, such as a driver's licence or passport. Personal data: store and show it only where your integration needs it.

identificationCountryID
required
string or null <= 2 characters

Two-letter code of the country that issued the identification.

identificationIssuingLocation
required
string or null <= 100 characters

Where the identification was issued.

identificationExpirationDate
required
string or null <date>

Identification expiry date.

required
payout_types (string) or string

How the contact is paid, or 0 when no payout type is set.

required
other_payout_types (string) or null

How the contact is paid outside Rentvine when payoutTypeID is 1 (Other), or null; always null for maintenance technicians.

achDetailsCiphertextID
required
string or null^-?[0-9]+$

Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians.

achAccountNumberTruncated
required
string or null <= 4 characters

Last 4 digits of the ACH account number; null for maintenance technicians.

required
bank_account_types (string) or null

ACH bank account type, or null; always null for maintenance technicians.

achIsCorporateAccount
required
string
Enum: "0" "1"

1 if the ACH account is a corporate account.

holdPayments
required
string
Enum: "0" "1"

1 if payouts to the contact are on hold. Always 0 for tenants and maintenance technicians.

liabilityInsuranceName
required
string or null <= 100 characters

Liability insurer (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsurancePolicyNumber
required
string or null <= 50 characters

Liability policy number (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsuranceExpiresDate
required
string or null

Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), YYYY-MM-DD. A few rows store 0000-00-00.

workersCompInsuranceName
required
string or null <= 100 characters

Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsurancePolicyNumber
required
string or null <= 50 characters

Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsuranceExpiresDate
required
string or null <date>

Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save).

discountPercent
required
string or null <decimal>

Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save).

discountAmount
required
string or null <decimal>

Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with discountPercent.

discountAmountMin
required
string or null <decimal>

Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountAmountMax
required
string or null <decimal>

Largest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountGraceDays
required
string or null^-?[0-9]+$

Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save).

isActive
required
string
Enum: "0" "1"

1 if the contact is active, 0 if deactivated.

isInsuranceRequiredForPayment
required
string or null
Enum: "0" "1" null

1 if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store 0.

maxLineItemsOnPayment
required
string or null^-?[0-9]+$

Maximum number of bill line items allowed per payment, or null.

preventConsolidatedPayments
required
string
Enum: "0" "1"

1 to prevent consolidated payouts.

isFromImport
required
string
Enum: "0" "1"

1 if the record came from an import.

importSourceKey
required
string or null <= 100 characters

Key of the record in the import it came from, or null.

websiteUrl
required
string or null <= 500 characters

Website address, or null; always null for maintenance technicians.

applicantID
required
string or null^-?[0-9]+$

The applicant this contact was converted from, or null.

ownerPortalNameOverride
required
string or null <= 100 characters

Display name shown in the owner portal instead of name (vendors and associations; null for other contact types, which the API clears on save).

isBillApprovalExempt
required
string
Enum: "0" "1"

1 if bills for this contact skip the bill approval workflow.

isBillingSalesTaxEnabled
required
string
Enum: "0" "1"

1 if sales tax is enabled for invoices billed from this contact. Always 0 except for vendors and associations.

isQuickbooksExportEnabled
required
string
Enum: "0" "1"

1 if QuickBooks export is enabled for this contact. Always 0 except for vendors and managers.

quickbooksCustomerName
required
string or null <= 100 characters

Name used for the contact in QuickBooks; null except for vendors and managers.

invoiceAutofillTemplateID
required
string or null^-?[0-9]+$

ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians.

dateTimeCreated
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

contactType
required
string
Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead"

The contact type's label, computed in PHP: Owner, Tenant, Vendor, Association, Internal Technician (maintenance technicians), and Manager for a manager row a list adds.

Response samples

Content type
application/json
{
  • "contactID": "2937",
  • "contactTypeID": "5",
  • "vendorTypeID": null,
  • "code": "C-6afb87bc551d9",
  • "name": "Jordan Lee Rivera Jr.",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": "jordan.rivera@example.com",
  • "phone": "+19195550100",
  • "countryID": "US",
  • "address": "100 Main St",
  • "address2": "Suite 200",
  • "city": "Raleigh",
  • "stateID": "NC",
  • "postalCode": "27601",
  • "birthDate": "1980-04-12",
  • "defaultBillChargeAccountID": "1",
  • "payeeName": "Jordan Rivera",
  • "taxPayerName": "Jordan Rivera",
  • "taxFormTypeID": "1",
  • "identificationTypeID": "1",
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "payoutTypeID": "1",
  • "otherPayoutTypeID": "1",
  • "achDetailsCiphertextID": "356",
  • "achAccountNumberTruncated": "6789",
  • "achAccountTypeID": "2",
  • "achIsCorporateAccount": "0",
  • "holdPayments": "1",
  • "liabilityInsuranceName": "Acme Insurance",
  • "liabilityInsurancePolicyNumber": "L-1001",
  • "liabilityInsuranceExpiresDate": "2030-06-30",
  • "workersCompInsuranceName": "Acme Workers Comp",
  • "workersCompInsurancePolicyNumber": "W-2002",
  • "workersCompInsuranceExpiresDate": "2030-07-31",
  • "discountPercent": "2.5000",
  • "discountAmount": null,
  • "discountAmountMin": "1.00",
  • "discountAmountMax": "50.00",
  • "discountGraceDays": "10",
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": "12",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": "https://example.com",
  • "applicantID": null,
  • "ownerPortalNameOverride": "Rivera Holdings",
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "1",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": "348",
  • "dateTimeCreated": "2026-11-16 22:46:20",
  • "dateTimeModified": "2026-11-16 22:46:20",
  • "dateTimeDeactivated": null,
  • "contactType": "Association"
}

Activate Association

Activates an association: sets isActive to 1 and clears dateTimeDeactivated. Answers with the association's view: the same body as GET /associations/{contactID}, including the related records the includes parameter names.

Use Cases

  • Bring back an association who was deactivated

Business Rules

  • Requires the Update Association Details permission (Contacts › UpdateAssociation).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Activating an association that is already active answers 200 with the association; only its dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Association" entry to the association's activity log when the association was inactive, and saves its assignee record.
  • POST /associations/{contactID}/deactivate - deactivate the association
  • GET /associations/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Deactivate Association

Deactivates an association: sets isActive to 0 and dateTimeDeactivated to the time of the request. The association and everything recorded against it are kept; GET /associations and GET /associations/search filter on isActive. Answers with the association's view: the same body as GET /associations/{contactID}, including the related records the includes parameter names.

Use Cases

  • Retire an association the account no longer deals with, keeping its history

Business Rules

  • Requires the Update Association Details permission (Contacts › UpdateAssociation).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Deactivating an association that is already inactive answers 200 with the association; dateTimeDeactivated keeps its value and only dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Association" entry to the association's activity log when the association was active, and saves its assignee record.
  • POST /associations/{contactID}/activate - activate the association again
  • DELETE /associations/{contactID} - delete the association instead
  • GET /associations/{contactID} - get 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Maintenance Technicians

Maintenance technicians are your own staff who work on work orders, as opposed to outside vendors. List, search, create, read, update, activate, deactivate and delete them.

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an internal technician (a member of the account's own maintenance staff), with any emails, phone numbers, addresses and attached files the body lists, and answers with the new technician's view: the same body as GET /maintenance-technicians/{contactID}, including the related records the includes parameter names.

Use Cases

  • Add a member of the maintenance staff, with their contact details

Business Rules

  • Requires the Update Internal Technician Details permission (Contacts › UpdateMaintenanceTechnician).
  • name is required; the body can't be empty ({} counts as empty). Keys the body doesn't list are ignored, among them the vendor fields POST /vendors takes; isBillApprovalExempt is ignored too. Bank-account details this reference doesn't describe are read and checked, then cleared from the technician.
  • taxIdentifier, taxIdentifierTypeID and taxIdentifierCountryID are read only when the role also holds Manage Tax Info & Reporting (1099s) (Contacts › ManageTaxInfo). A technician keeps no taxPayerName or taxFormTypeID: both are cleared.
  • maxLineItemsOnPayment is taken only here: POST /maintenance-technicians/{contactID} ignores it.
  • The new technician is active, with payoutTypeID 2 (Check). A technician's firstName, middleName, lastName, suffix, websiteUrl, payeeName, insurance, discount and payout-detail fields are always null, and holdPayments is 0.
  • The first email, phone number and address become the technician's primary ones, copied to contact.email, contact.phone and the contact's address fields.
  • The technician's own fields are checked first, and the email, phone and address items only once they pass, so a request with errors in both reports only the technician's.
  • All of it is saved together: when any item fails validation, nothing is created.
  • The tax identifier is stored encrypted and never returned: contact.hasTaxIdentifier says one is stored.
  • Not limited by portfolio-group restrictions: a restricted user can create one.

Side Effects

  • Creates the contact's private-data row (the encrypted tax identifier, when one is sent), its assignee record, a log entry, "Internal Technician Created", and one log entry per email, phone and address added.
  • Copying the first email, phone number and address onto the contact writes an "Updated Internal Technician" log entry and saves the assignee record again, once for each.
  • Links each file in attachments to the new technician.
  • GET /maintenance-technicians/{contactID} - get the technician
  • POST /maintenance-technicians/{contactID} - update the technician
  • GET /maintenance-technicians/search - search technicians
Authorizations:
basicAuth
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.

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

The technician's name.

code
string or null <= 100 characters

The account's own reference code for the technician.

birthDate
string or null

The technician's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

maxLineItemsOnPayment
string or integer or null

The most bill lines one payment carries, as a whole number. Taken only on a create.

taxIdentifier
string or null

A tax identifier, stored encrypted and never returned. An identifier in the wrong form isn't refused: it is stored with isTaxIdentifierValid "0"; the view's hasTaxIdentifier, isTaxIdentifierValid and taxIdentifierTypeID describe it. Read only when the role holds Manage Tax Info & Reporting (1099s). A technician keeps no taxPayerName or taxFormTypeID: both are cleared.

taxIdentifierTypeID
string or integer (tax_identifier_types_request)
Enum: "1" "2" "3" "4" "99" 1 2 3 4 99

The kind of tax identifier. When it's missing, the type is worked out from the identifier. Read only when the role holds Manage Tax Info & Reporting (1099s).

  • 1 - SSN
  • 2 - ITIN
  • 3 - EIN
  • 4 - Foreign Tax ID
  • 99 - Unknown
taxIdentifierCountryID
string or null <= 2 characters

The two-letter code of the country that issued the tax identifier; leave it empty for the United States. Read only when the role holds Manage Tax Info & Reporting (1099s).

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

Files to attach to the technician, by file ID: upload one with POST /files, or take an ID from GET /files. Each must be an existing file.

Array of objects (contact_email_request)

Email addresses to add to the technician.

Array of objects (contact_phone_request)

Phone numbers to add to the technician.

Array of objects (contact_address_request)

Addresses to add to the technician.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
Example
{
  • "name": "Jordan Rivera",
  • "code": "TECH-1001",
  • "birthDate": "1980-04-12",
  • "maxLineItemsOnPayment": 12,
  • "emails": [
    ],
  • "phones": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 an internal technician's name, code and date of birth, and answers with the technician's view: the same body as GET /maintenance-technicians/{contactID}, including the related records the includes parameter names.

Use Cases

  • Correct a technician's name or code

Business Rules

  • Requires the Update Internal Technician Details permission (Contacts › UpdateMaintenanceTechnician).
  • Send only the fields to change; the others keep their values. The body can't be empty ({} counts as empty). Only name, code and birthDate are read; any other key is ignored.
  • A body of only keys this operation ignores isn't empty: it answers 200, and only dateTimeModified changes.
  • Not limited by portfolio-group restrictions: a restricted user can update any 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.

Side Effects

  • When a field changes, writes an "Updated Internal Technician" entry with the changes to the technician's activity log, and saves the technician's assignee record.
  • GET /maintenance-technicians/{contactID} - get the technician
  • POST /maintenance-technicians - create a technician
  • POST /maintenance-technicians/{contactID}/deactivate - deactivate the technician
  • POST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have the same phones and addresses routes
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 1042

The technician's contact ID. A well-formed ID that isn't a technician answers 400; one that isn't a whole number of digits, 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.

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

The technician's name.

code
string or null <= 100 characters

The account's own reference code for the technician.

birthDate
string or null

The technician's date of birth, as YYYY-MM-DD or MM/DD/YYYY. A value that isn't a date is refused.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

Request samples

Content type
application/json
{
  • "name": "Jordan A. Rivera",
  • "code": "TECH-2002",
  • "birthDate": "1981-05-13"
}

Response samples

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

Delete Maintenance Technician

Deletes a technician for good, with the records that belong only to it, and answers with the technician's row as it was. A technician with history can't be deleted: deactivate it instead with POST /maintenance-technicians/{contactID}/deactivate.

Use Cases

  • Remove a technician added by mistake, before anything was recorded against them

Business Rules

  • Requires the Update Internal Technician Details permission (Contacts › UpdateMaintenanceTechnician).
  • Refused with 400 when the technician logged materials or labor on a work order, or has work orders, bills, payouts, recurring bills, accounting transactions, tax adjustments, leases, recurring lease payments, a portfolio share, a withholding tax agency or a reminder it is assigned to. The first check that fails names its reason (see the examples); nothing is deleted.
  • Not limited by portfolio-group restrictions.
  • 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 response is the technician's row as it was before the delete, not wrapped in contact, with no tax-identifier keys.

Side Effects

  • Deletes the technician, its emails, addresses, payment methods, private data (the stored tax identifier), assignee record and vendor trades, and the invoices it is the payee of.
  • Deactivates the technician's phone numbers (they are kept, with isActive 0), so text threads stay linked.
  • Removes the technician from work-order technician assignments, and deletes the work-order templates, recurring work orders and property association links that name it.
  • Revokes the technician's maintenance portal invitations and portal accounts, so it can no longer sign in to the maintenance portal.
  • Deletes the technician's email conversations, activities, notes, alerts, file attachments, custom field values, letters, chat messages, reminders about it, watchers and dates, and writes a log entry, "Internal Technician Deleted".
  • Deletes each file attached to the technician that no other record has attached, so it is gone from GET /files/{fileID} too; a file still attached elsewhere is kept.
  • POST /maintenance-technicians/{contactID}/deactivate - deactivate the technician instead
  • GET /maintenance-technicians/{contactID} - get the technician
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 1042

The technician's contact ID. A well-formed ID that isn't a technician answers 400; one that isn't a whole number of digits, 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the contact.

contactTypeID
required
string (contact_types)
Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9"

Contact type: 1 Owner, 2 Tenant, 3 Vendor, 4 Manager, 5 Association, 6 Applicant, 7 Screening Prospect, 8 Internal Technician (maintenance technician), 9 Owner Lead. On a single-contact read, always the endpoint's type; a list can also hold the manager and maintenance-technician rows its includeManager, includeMaintenanceTechnician or contactIDs[] adds.

vendorTypeID
required
string or null^-?[0-9]+$

Vendor type, from GET /contacts/vendor-types (undocumented). Kept for vendors and maintenance technicians; null for other contact types.

code
required
string or null <= 100 characters

Optional short code or reference for the contact.

name
required
string <= 100 characters

Full display name.

firstName
required
string or null <= 100 characters

First name, parsed from name on every save for owners and tenants (and applicants); null for every other contact type.

middleName
required
string or null <= 100 characters

Middle name, parsed from name like firstName; null for types other than owners and tenants.

lastName
required
string or null <= 100 characters

Last name, parsed from name like firstName; null for types other than owners and tenants.

suffix
required
string or null <= 15 characters

Name suffix, parsed from name like firstName; null for types other than owners and tenants.

email
required
string or null <= 100 characters

Primary email address on the contact record.

phone
required
string or null <= 20 characters

Primary phone number on the contact record.

countryID
required
string or null <= 2 characters

Two-letter country code of the contact address.

address
required
string or null <= 100 characters

Street address.

address2
required
string or null <= 100 characters

Second address line.

city
required
string or null <= 45 characters

City.

stateID
required
string or null <= 3 characters

State or province code.

postalCode
required
string or null <= 30 characters

Postal code.

birthDate
required
string or null <date>

Date of birth. Personal data: store and show it only where your integration needs it.

defaultBillChargeAccountID
required
string or null^-?[0-9]+$

Default chart of accounts ID for bills charged to this contact (vendors and associations; null for other contact types, which the API clears on save).

payeeName
required
string or null <= 100 characters

Override name used on payout checks and ACH; null for maintenance technicians, which the API clears on save.

taxPayerName
required
string or null <= 100 characters

Name printed on tax forms; null for maintenance technicians.

required
form_types (string) or null

Tax form issued to the contact (1099-MISC or 1042), or null; always null for maintenance technicians.

required
identification_types (string) or null

Type of identification on file, or null.

identificationNumber
required
string or null <= 50 characters

The number of the contact's identification document, such as a driver's licence or passport. Personal data: store and show it only where your integration needs it.

identificationCountryID
required
string or null <= 2 characters

Two-letter code of the country that issued the identification.

identificationIssuingLocation
required
string or null <= 100 characters

Where the identification was issued.

identificationExpirationDate
required
string or null <date>

Identification expiry date.

required
payout_types (string) or string

How the contact is paid, or 0 when no payout type is set.

required
other_payout_types (string) or null

How the contact is paid outside Rentvine when payoutTypeID is 1 (Other), or null; always null for maintenance technicians.

achDetailsCiphertextID
required
string or null^-?[0-9]+$

Internal reference to the encrypted ACH bank details, or null; always null for maintenance technicians.

achAccountNumberTruncated
required
string or null <= 4 characters

Last 4 digits of the ACH account number; null for maintenance technicians.

required
bank_account_types (string) or null

ACH bank account type, or null; always null for maintenance technicians.

achIsCorporateAccount
required
string
Enum: "0" "1"

1 if the ACH account is a corporate account.

holdPayments
required
string
Enum: "0" "1"

1 if payouts to the contact are on hold. Always 0 for tenants and maintenance technicians.

liabilityInsuranceName
required
string or null <= 100 characters

Liability insurer (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsurancePolicyNumber
required
string or null <= 50 characters

Liability policy number (vendors and associations; null for other contact types, which the API clears on save).

liabilityInsuranceExpiresDate
required
string or null

Liability insurance expiry date (vendors and associations; null for other contact types, which the API clears on save), YYYY-MM-DD. A few rows store 0000-00-00.

workersCompInsuranceName
required
string or null <= 100 characters

Workers' comp insurer (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsurancePolicyNumber
required
string or null <= 50 characters

Workers' comp policy number (vendors and associations; null for other contact types, which the API clears on save).

workersCompInsuranceExpiresDate
required
string or null <date>

Workers' comp insurance expiry date (vendors and associations; null for other contact types, which the API clears on save).

discountPercent
required
string or null <decimal>

Discount percentage applied to bills (vendors and associations; null for other contact types, which the API clears on save).

discountAmount
required
string or null <decimal>

Flat discount amount applied to bills (vendors and associations; null for other contact types, which the API clears on save); never set together with discountPercent.

discountAmountMin
required
string or null <decimal>

Smallest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountAmountMax
required
string or null <decimal>

Largest discount applied (vendors and associations; null for other contact types, which the API clears on save).

discountGraceDays
required
string or null^-?[0-9]+$

Number of days within which the discount applies (vendors and associations; null for other contact types, which the API clears on save).

isActive
required
string
Enum: "0" "1"

1 if the contact is active, 0 if deactivated.

isInsuranceRequiredForPayment
required
string or null
Enum: "0" "1" null

1 if valid insurance is required before releasing payment (vendors and associations; null for other contact types, which the API clears on save). A few older rows of other types store 0.

maxLineItemsOnPayment
required
string or null^-?[0-9]+$

Maximum number of bill line items allowed per payment, or null.

preventConsolidatedPayments
required
string
Enum: "0" "1"

1 to prevent consolidated payouts.

isFromImport
required
string
Enum: "0" "1"

1 if the record came from an import.

importSourceKey
required
string or null <= 100 characters

Key of the record in the import it came from, or null.

websiteUrl
required
string or null <= 500 characters

Website address, or null; always null for maintenance technicians.

applicantID
required
string or null^-?[0-9]+$

The applicant this contact was converted from, or null.

ownerPortalNameOverride
required
string or null <= 100 characters

Display name shown in the owner portal instead of name (vendors and associations; null for other contact types, which the API clears on save).

isBillApprovalExempt
required
string
Enum: "0" "1"

1 if bills for this contact skip the bill approval workflow.

isBillingSalesTaxEnabled
required
string
Enum: "0" "1"

1 if sales tax is enabled for invoices billed from this contact. Always 0 except for vendors and associations.

isQuickbooksExportEnabled
required
string
Enum: "0" "1"

1 if QuickBooks export is enabled for this contact. Always 0 except for vendors and managers.

quickbooksCustomerName
required
string or null <= 100 characters

Name used for the contact in QuickBooks; null except for vendors and managers.

invoiceAutofillTemplateID
required
string or null^-?[0-9]+$

ID of the invoice autofill template the contact uses, or null; always null for maintenance technicians.

dateTimeCreated
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
string

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeDeactivated
required
string or null

Date and time in UTC, formatted YYYY-MM-DD HH:MM:SS.

contactType
required
string
Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead"

The contact type's label, computed in PHP: Owner, Tenant, Vendor, Association, Internal Technician (maintenance technicians), and Manager for a manager row a list adds.

Response samples

Content type
application/json
{
  • "contactID": "2873",
  • "contactTypeID": "8",
  • "vendorTypeID": "443",
  • "code": "C-6afb879d44d81",
  • "name": "Jordan Lee Rivera Jr.",
  • "firstName": null,
  • "middleName": null,
  • "lastName": null,
  • "suffix": null,
  • "email": "jordan.rivera@example.com",
  • "phone": "+19195550100",
  • "countryID": "US",
  • "address": "100 Main St",
  • "address2": "Suite 200",
  • "city": "Raleigh",
  • "stateID": "NC",
  • "postalCode": "27601",
  • "birthDate": "1980-04-12",
  • "defaultBillChargeAccountID": null,
  • "payeeName": null,
  • "taxPayerName": null,
  • "taxFormTypeID": null,
  • "identificationTypeID": "1",
  • "identificationNumber": "D1234567",
  • "identificationCountryID": "US",
  • "identificationIssuingLocation": "NC",
  • "identificationExpirationDate": "2030-01-31",
  • "payoutTypeID": "1",
  • "otherPayoutTypeID": null,
  • "achDetailsCiphertextID": null,
  • "achAccountNumberTruncated": null,
  • "achAccountTypeID": null,
  • "achIsCorporateAccount": "0",
  • "holdPayments": "0",
  • "liabilityInsuranceName": null,
  • "liabilityInsurancePolicyNumber": null,
  • "liabilityInsuranceExpiresDate": null,
  • "workersCompInsuranceName": null,
  • "workersCompInsurancePolicyNumber": null,
  • "workersCompInsuranceExpiresDate": null,
  • "discountPercent": null,
  • "discountAmount": null,
  • "discountAmountMin": null,
  • "discountAmountMax": null,
  • "discountGraceDays": null,
  • "isActive": "1",
  • "isInsuranceRequiredForPayment": null,
  • "maxLineItemsOnPayment": "12",
  • "preventConsolidatedPayments": "0",
  • "isFromImport": "0",
  • "importSourceKey": null,
  • "websiteUrl": null,
  • "applicantID": null,
  • "ownerPortalNameOverride": null,
  • "isBillApprovalExempt": "0",
  • "isBillingSalesTaxEnabled": "0",
  • "isQuickbooksExportEnabled": "0",
  • "quickbooksCustomerName": null,
  • "invoiceAutofillTemplateID": null,
  • "dateTimeCreated": "2026-11-16 22:45:49",
  • "dateTimeModified": "2026-11-16 22:45:49",
  • "dateTimeDeactivated": null,
  • "contactType": "Internal Technician"
}

Activate Maintenance Technician

Activates a technician: sets isActive to 1 and clears dateTimeDeactivated. Answers with the technician's view: the same body as GET /maintenance-technicians/{contactID}, including the related records the includes parameter names.

Use Cases

  • Bring back a technician who was deactivated

Business Rules

  • Requires the Update Internal Technician Details permission (Contacts › UpdateMaintenanceTechnician).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Activating a technician that is already active answers 200 with the technician; only its dateTimeModified changes.
  • 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.

Side Effects

  • Writes an "Updated Internal Technician" entry to the technician's activity log when the technician was inactive, and saves its assignee record.
  • POST /maintenance-technicians/{contactID}/deactivate - deactivate the technician
  • GET /maintenance-technicians/{contactID} - get the technician
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 1042

The technician's contact ID. A well-formed ID that isn't a technician answers 400; one that isn't a whole number of digits, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Deactivate Maintenance Technician

Deactivates a technician: sets isActive to 0 and dateTimeDeactivated to the time of the request. The technician and everything recorded against it are kept; GET /maintenance-technicians and GET /maintenance-technicians/search filter on isActive. Answers with the technician's view: the same body as GET /maintenance-technicians/{contactID}, including the related records the includes parameter names.

Use Cases

  • Retire a technician who no longer works for the account, keeping their history

Business Rules

  • Requires the Update Internal Technician Details permission (Contacts › UpdateMaintenanceTechnician).
  • Takes no body.
  • Not limited by portfolio-group restrictions.
  • Deactivating a technician that is already inactive answers 200 with the technician; dateTimeDeactivated keeps its value and only dateTimeModified changes.
  • 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.

Side Effects

  • Deletes every recurring work order the technician is assigned to, so no new work orders are generated for it.
  • Writes an "Updated Internal Technician" entry to the technician's activity log when the technician was active, and saves its assignee record.
  • POST /maintenance-technicians/{contactID}/activate - activate the technician again
  • DELETE /maintenance-technicians/{contactID} - delete the technician instead
  • GET /maintenance-technicians/{contactID} - get the technician
Authorizations:
basicAuth
path Parameters
contactID
required
integer
Example: 1042

The technician's contact ID. A well-formed ID that isn't a technician answers 400; one that isn't a whole number of digits, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Webhook Subscriptions

A webhook subscribes a URL you run to one kind of event in your account (a work order created, a lease updated, a payment returned and so on): each time that event happens, Rentvine sends it to the URL. List, register, read, change and delete webhooks. Registering, changing and deleting need the Manage Webhooks permission.

List Webhooks

Returns a page of the account's webhooks: each one's event type and the URL Rentvine sends that event to.

Use Cases

  • Check which events your integration is subscribed to before registering a webhook, so you don't register the same one twice
  • Find the webhookID to update or delete a webhook, or to filter the delivery log by

Business Rules

  • Filters combine: a webhook must match every one sent. An eventType that isn't one of the event types matches nothing.
  • The page size defaults to 25 and isn't capped. When some webhooks match, pagination-page-size reports the page size or the number that match, whichever is smaller. A pageSize of 0 or below 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.
  • Sorted by orderBy (default webhook.dateTimeCreated|desc, newest first), then webhookID ascending. An orderBy naming only columns that aren't sortable sorts by webhookID ascending alone.
  • POST /events/webhooks - register a webhook
  • GET /events/webhooks/{webhookID} - one webhook
  • GET /events/webhooks/calls - the delivery log
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). Not capped. 0 or a negative value is read as 15.

search
string
Example: search=example.com

Returns the webhooks whose event type or URL contains this text (case-insensitive). % and _ aren't escaped, so they match any run of characters and any one character.

eventType
string
Example: eventType=maintenance::workOrder::created

Returns only the webhooks for this event type, matched exactly (for example maintenance::workOrder::created; the values are listed under eventType in the response). A value that isn't one of the event types isn't refused; it matches nothing.

orderBy
string
Default: "webhook.dateTimeCreated|desc"
Example: orderBy=webhook.url|asc

Sort column, optionally followed by |asc or |desc (any letter case); anything else after the |, or nothing, sorts ascending. Several are separated by commas. A column not in the list below is ignored; when none of the columns sent is in the list, the default sort is dropped too and rows come back by webhookID ascending (oldest first). webhookID always breaks ties, ascending.

Columns: webhook.dateTimeCreated (the default, desc), webhook.eventType, webhook.url.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

When some webhooks 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A webhook: one event type and the HTTPS URL Rentvine sends that event to. An account can hold several webhooks for the same event, and the same URL can appear on several webhooks.

required
object

The webhook's most recent processed delivery, for an at-a-glance status on the list. Every field is null when the webhook has no processed call yet.

Response samples

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

Create Webhook

Registers a webhook: from now on, each time the event happens in the account, Rentvine sends it to url (two deleted-record types are never sent: see Side Effects). Returns the new webhook (same shape as GET /events/webhooks/{webhookID}).

Use Cases

  • Subscribe your integration to an event, such as new work orders, instead of polling for it
  • Send one event to several receivers by creating a webhook for each URL

Business Rules

  • Requires the Manage Webhooks permission (Administration › ManageWebhooks), checked first.
  • eventType and url are both required. url must be a valid URL starting with https://, in lowercase (HTTPS:// is refused).
  • Nothing stops a duplicate: the same event and URL can be registered twice, and each webhook then sends its own copy of every event.
  • The URL's length isn't validated: a URL longer than 1,000 characters is stored cut to its first 1,000.
  • Refused with a 400: a missing or empty body ({} counts as empty) or one that isn't JSON or is a JSON string or number (form fields, "x"), and a field that fails its check (see the examples). Keys other than eventType and url are ignored.

Side Effects

  • Each event of this type that Rentvine processes from now on is queued for url and sent in the background; each queued send gets a row in GET /events/webhooks/calls. A webhook takes at most 60 events in any 2 minutes: events beyond that aren't sent and get no row in the delivery log.
  • property::property::deleted and unit::unit::deleted events are queued but never sent: the property or unit is already deleted when the send runs, so their rows in the delivery log keep hasError and statusCode null for good.
  • Some event types (accounting::transaction::lease::payment::created, accounting::transaction::lease::paymentReturn::created, and the screening::application::* and screening::applicant::* types) are recorded only while the account has a webhook for them, so the first webhook for one of them starts their recording.
  • GET /events/webhooks - the webhooks already registered
  • POST /events/webhooks/{webhookID} - change a webhook's event or URL
  • DELETE /events/webhooks/{webhookID} - stop sending an event
Authorizations:
basicAuth
Request Body schema: application/json
required
non-empty
eventType
required
string (event_types)
Enum: "maintenance::workOrder::created" "maintenance::workOrder::updated" "lease::lease::created" "lease::lease::updated" "property::property::created" "property::property::updated" "property::property::deleted" "unit::unit::created" "unit::unit::updated" "unit::unit::deleted" "accounting::transaction::lease::charge::created" "accounting::transaction::lease::charge::updated" "accounting::transaction::lease::payment::created" "accounting::transaction::lease::paymentReturn::created" "screening::prospect::created" "screening::prospect::updated" "screening::application::created" "screening::application::updated" "screening::applicant::created" "screening::applicant::updated"

The event a webhook is subscribed to, as <area>::<record>::<what happened>:

  • maintenance::workOrder::created - Work Order Created
  • maintenance::workOrder::updated - Work Order Updated
  • lease::lease::created - Lease Created
  • lease::lease::updated - Lease Updated
  • property::property::created - Property Created
  • property::property::updated - Property Updated
  • property::property::deleted - Property Deleted
  • unit::unit::created - Unit Created
  • unit::unit::updated - Unit Updated
  • unit::unit::deleted - Unit Deleted
  • accounting::transaction::lease::charge::created - Lease Charge Created
  • accounting::transaction::lease::charge::updated - Lease Charge Updated
  • accounting::transaction::lease::payment::created - Lease Payment Created
  • accounting::transaction::lease::paymentReturn::created - Lease Payment Returned
  • screening::prospect::created - Prospect Created
  • screening::prospect::updated - Prospect Updated
  • screening::application::created - Application Created
  • screening::application::updated - Application Updated
  • screening::applicant::created - Applicant Created
  • screening::applicant::updated - Applicant Updated
url
required
string non-empty

The URL to send the event to. Must be a valid URL starting with https:// in lowercase. Send at most 1,000 characters; a longer URL is stored cut to 1,000.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (webhook)

A webhook: one event type and the HTTPS URL Rentvine sends that event to. An account can hold several webhooks for the same event, and the same URL can appear on several webhooks.

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Webhook

Returns one webhook: its event type and the URL Rentvine sends that event to.

Use Cases

  • Check a webhook's event type and URL before changing it

Business Rules

  • A webhookID with no webhook answers a 400 {"error": "Webhook <webhookID> not found"}; a value that isn't all digits (abc, -1) answers the stock 404.
  • GET /events/webhooks - every webhook
  • POST /events/webhooks/{webhookID} - change the webhook
  • GET /events/webhooks/calls - its delivery log, with webhookID
Authorizations:
basicAuth
path Parameters
webhookID
required
integer
Example: 42

The webhook's ID, from GET /events/webhooks. A value that isn't all digits (abc, -1) answers the stock 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (webhook)

A webhook: one event type and the HTTPS URL Rentvine sends that event to. An account can hold several webhooks for the same event, and the same URL can appear on several webhooks.

Response samples

Content type
application/json
{}

Update Webhook

Changes a webhook's event type, its URL, or both. Only the keys sent change: a key left out keeps its value. Returns the updated webhook (same shape as GET /events/webhooks/{webhookID}).

Use Cases

  • Point a webhook at a new receiver URL without deleting it, which keeps its delivery log

Business Rules

  • Requires the Manage Webhooks permission (Administration › ManageWebhooks), checked first: a key without it gets the 403 even for a webhook that doesn't exist.
  • Then refused with a 400, in this order: a missing or empty body ({} counts as empty) or one that isn't JSON or is a JSON string or number; a webhookID with no webhook; a field that fails its check (see the examples). A field sent empty ("url": "") is refused as missing.
  • Keys other than eventType and url are ignored: a body holding only other keys answers 200 and changes nothing.
  • url must be a valid URL starting with https:// in lowercase. Its length isn't validated: a URL longer than 1,000 characters is stored cut to its first 1,000.
  • A webhookID that isn't all digits (abc, -1) answers the stock 404.

Side Effects

  • Events Rentvine processes from now on are sent with the new values. Sends already queued keep the URL they were queued with, and the delivery log keeps each send's URL as it was.
  • Moving the account's last webhook for accounting::transaction::lease::payment::created, accounting::transaction::lease::paymentReturn::created or a screening::application::* or screening::applicant::* type to another event type stops Rentvine recording that type's events; events from the gap are never sent, even once a webhook subscribes to the type again.
  • GET /events/webhooks/{webhookID} - the webhook as it is now
  • DELETE /events/webhooks/{webhookID} - stop sending the event instead
Authorizations:
basicAuth
path Parameters
webhookID
required
integer
Example: 42

The webhook's ID, from GET /events/webhooks. A value that isn't all digits (abc, -1) answers the stock 404.

Request Body schema: application/json
required
non-empty
eventType
string (event_types)
Enum: "maintenance::workOrder::created" "maintenance::workOrder::updated" "lease::lease::created" "lease::lease::updated" "property::property::created" "property::property::updated" "property::property::deleted" "unit::unit::created" "unit::unit::updated" "unit::unit::deleted" "accounting::transaction::lease::charge::created" "accounting::transaction::lease::charge::updated" "accounting::transaction::lease::payment::created" "accounting::transaction::lease::paymentReturn::created" "screening::prospect::created" "screening::prospect::updated" "screening::application::created" "screening::application::updated" "screening::applicant::created" "screening::applicant::updated"

The event a webhook is subscribed to, as <area>::<record>::<what happened>:

  • maintenance::workOrder::created - Work Order Created
  • maintenance::workOrder::updated - Work Order Updated
  • lease::lease::created - Lease Created
  • lease::lease::updated - Lease Updated
  • property::property::created - Property Created
  • property::property::updated - Property Updated
  • property::property::deleted - Property Deleted
  • unit::unit::created - Unit Created
  • unit::unit::updated - Unit Updated
  • unit::unit::deleted - Unit Deleted
  • accounting::transaction::lease::charge::created - Lease Charge Created
  • accounting::transaction::lease::charge::updated - Lease Charge Updated
  • accounting::transaction::lease::payment::created - Lease Payment Created
  • accounting::transaction::lease::paymentReturn::created - Lease Payment Returned
  • screening::prospect::created - Prospect Created
  • screening::prospect::updated - Prospect Updated
  • screening::application::created - Application Created
  • screening::application::updated - Application Updated
  • screening::applicant::created - Applicant Created
  • screening::applicant::updated - Applicant Updated
url
string non-empty

The URL to send the event to. Must be a valid URL starting with https:// in lowercase. Send at most 1,000 characters; a longer URL is stored cut to 1,000.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (webhook)

A webhook: one event type and the HTTPS URL Rentvine sends that event to. An account can hold several webhooks for the same event, and the same URL can appear on several webhooks.

Request samples

Content type
application/json

Response samples

Content type
application/json
{}

Delete Webhook

Deletes a webhook, so its event is no longer sent to its URL, together with its delivery log. Returns the deleted webhook, not wrapped in a webhook key.

Use Cases

  • Stop sending an event to a receiver you no longer run

Business Rules

  • Requires the Manage Webhooks permission (Administration › ManageWebhooks), checked first: a key without it gets the 403 even for a webhook that doesn't exist.
  • A webhookID with no webhook answers a 400 {"error": "Webhook <webhookID> not found"}; a value that isn't all digits (abc, -1) answers the stock 404.
  • The delete is permanent: there's no undo. To send the event again, create a new webhook.

Side Effects

  • Deletes every row of the webhook's delivery log: GET /events/webhooks/calls?webhookID=<webhookID> returns nothing afterwards. Other webhooks' rows stay, even those sent to the same URL.
  • Sends already queued for the webhook are dropped rather than sent.
  • Deleting the account's last webhook for accounting::transaction::lease::payment::created, accounting::transaction::lease::paymentReturn::created or a screening::application::* or screening::applicant::* type stops Rentvine recording that type's events; events from the gap are never sent, even once a new webhook subscribes to the type.
  • GET /events/webhooks - the webhooks left
  • POST /events/webhooks/{webhookID} - change the URL instead, which keeps the delivery log
Authorizations:
basicAuth
path Parameters
webhookID
required
integer
Example: 42

The webhook's ID, from GET /events/webhooks. A value that isn't all digits (abc, -1) answers the stock 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier.

eventType
required
string (event_types)
Enum: "maintenance::workOrder::created" "maintenance::workOrder::updated" "lease::lease::created" "lease::lease::updated" "property::property::created" "property::property::updated" "property::property::deleted" "unit::unit::created" "unit::unit::updated" "unit::unit::deleted" "accounting::transaction::lease::charge::created" "accounting::transaction::lease::charge::updated" "accounting::transaction::lease::payment::created" "accounting::transaction::lease::paymentReturn::created" "screening::prospect::created" "screening::prospect::updated" "screening::application::created" "screening::application::updated" "screening::applicant::created" "screening::applicant::updated"

The event a webhook is subscribed to, as <area>::<record>::<what happened>:

  • maintenance::workOrder::created - Work Order Created
  • maintenance::workOrder::updated - Work Order Updated
  • lease::lease::created - Lease Created
  • lease::lease::updated - Lease Updated
  • property::property::created - Property Created
  • property::property::updated - Property Updated
  • property::property::deleted - Property Deleted
  • unit::unit::created - Unit Created
  • unit::unit::updated - Unit Updated
  • unit::unit::deleted - Unit Deleted
  • accounting::transaction::lease::charge::created - Lease Charge Created
  • accounting::transaction::lease::charge::updated - Lease Charge Updated
  • accounting::transaction::lease::payment::created - Lease Payment Created
  • accounting::transaction::lease::paymentReturn::created - Lease Payment Returned
  • screening::prospect::created - Prospect Created
  • screening::prospect::updated - Prospect Updated
  • screening::application::created - Application Created
  • screening::application::updated - Application Updated
  • screening::applicant::created - Applicant Created
  • screening::applicant::updated - Applicant Updated
url
required
string <uri> <= 1000 characters

The HTTPS URL the event is sent to, as registered.

dateTimeCreated
required
string

When the webhook was created. UTC, formatted YYYY-MM-DD HH:MM:SS. An update doesn't change it.

isActive
string
Enum: "0" "1"

Whether the webhook is active (1) or stopped (0). A stopped webhook was paused or auto-disabled; see webhookDisableReasonID.

dateTimeActivated
string or null

When the webhook was last activated. UTC, YYYY-MM-DD HH:MM:SS. Resuming a stopped webhook resets it.

dateTimeDisabled
string or null

When the webhook was stopped, or null while it is active. UTC, YYYY-MM-DD HH:MM:SS.

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

The user who stopped the webhook, or null. An auto-disable records the system user.

webhookDisableReasonID
string or null
Enum: "1" "2" null

Why the webhook is stopped - 1 paused by a user, 2 auto-disabled for repeated failures - or null while active.

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

The user who created the webhook, or null when it predates ownership tracking.

Response samples

Content type
application/json
{}

Webhook Deliveries

The delivery log: one row for each time an event was queued for a webhook, with the outcome once it was sent, so you can see whether your receiver got an event and what it answered.

List Webhook Calls

Returns a page of the delivery log: one row for each time an event was queued for a webhook, with the outcome once it has been sent (whether it failed, the HTTP status the receiver answered, its response body and any error).

Use Cases

  • Check whether your receiver got an event, and what it answered
  • Find failed deliveries (hasError=1) and see what the receiver answered, then fix the receiver

Business Rules

  • A row is written when an event is queued for a webhook, and filled in once it has been sent. Until then hasError, statusCode, responseBody and errorMessage are null. A send that can't run keeps them null for good: every property::property::deleted and unit::unit::deleted event (the record is already gone when the send runs), and a send whose record was deleted before it ran.
  • A row doesn't say which record the event was about, and the API has no route that reads events by eventID.
  • url is the webhook's URL when the event was queued; a later change to the webhook doesn't change it.
  • Deleting a webhook deletes its rows.
  • Filters combine: a row must match every one sent. A filter value the API can't read is ignored rather than refused: the request still answers 200, unfiltered by that value (a hasError other than 1/0/true/false/yes/no in any letter case, a webhookID that isn't a number, or 0).
  • The page size defaults to 25 and isn't capped. When some rows match, pagination-page-size reports the page size or the number that match, whichever is smaller. A pageSize of 0 or below 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.
  • Sorted by orderBy (default webhookCall.dateTimeCreated|desc, newest first), then webhookCallID ascending. An orderBy naming only columns that aren't sortable sorts by webhookCallID ascending alone.
  • GET /events/webhooks - the webhooks, and the IDs for webhookID
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). Not capped. 0 or a negative value is read as 15.

webhookID
integer
Example: webhookID=42

Returns only one webhook's rows. IDs come from GET /events/webhooks. 0 or a value that isn't a number is ignored, and the list isn't filtered.

eventType
string
Example: eventType=maintenance::workOrder::created

Returns only the rows for this event type, matched exactly (for example maintenance::workOrder::created; the values are listed under eventType in the response). A value that isn't one of the event types isn't refused; it matches nothing.

hasError
string
Example: hasError=1

1 (or true, yes) returns the sends that failed; 0 (or false, no) the sends that succeeded. In any letter case. Rows not sent yet match neither. Any other value is ignored: the list isn't filtered by it.

search
string
Example: search=example.com

Returns the rows whose event type or URL contains this text (case-insensitive). % and _ aren't escaped, so they match any run of characters and any one character.

orderBy
string
Default: "webhookCall.dateTimeCreated|desc"
Example: orderBy=webhookCall.url|asc

Sort column, optionally followed by |asc or |desc (any letter case); anything else after the |, or nothing, sorts ascending. Several are separated by commas. A column not in the list below is ignored; when none of the columns sent is in the list, the default sort is dropped too and rows come back by webhookCallID ascending (oldest first). webhookCallID always breaks ties, ascending.

Columns: webhookCall.dateTimeCreated (the default, desc), webhookCall.eventType, webhookCall.url.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

When some rows 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

One send of one event to one webhook.

Response samples

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

Files

Files are documents and images stored in Rentvine and attached to a record (a property, a unit, a lease, a work order and so on) by its object type and ID (Object Types). Upload a file, and attach it in the same request.

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. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 a 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 a 500 for any value it can use (see Business Rules); don't send it.

dateTimeCreatedMin
string

Fails with a 500 for any value it can use (see Business Rules); don't send it.

dateTimeCreatedMax
string

Fails with a 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A lease is a rental agreement on one unit, with its tenants, dates, rent and status. List, create, read, update and delete leases, change a lease's status, list the lease statuses, and manage a lease's tenants, recurring charges and pets. Lease charges, payments and other accounting are under Transactions.

List Lease Statuses

Returns the account's lease statuses, the system ones and the account's own, sorted by orderIndex. Each item wraps one leaseStatus object. Use a status's leaseStatusID when you change a lease's status. A system status can't be renamed, moved to another stage or deleted.

Use Cases

  • Listing the statuses a lease can be moved to
  • Finding the statuses that mark pending move-in, notice given or completed move-out

Business Rules

  • Any authenticated user can read the statuses; no permission is checked
  • Sorted by orderIndex, lowest first
  • Every status is returned on one page: page and pageSize aren't read
  • A move flag is 1 only on a status of its stage: isPendingMoveInStatus on a Pending status, isPendingMoveOutStatus on an Active one, isCompletedMoveOutStatus on a Closed one
  • POST /leases/{leaseID}/status - Change a lease's status
  • GET /leases/{leaseID} - A lease, with its status through the leaseStatus include
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Notice

Returns only the statuses whose name contains this text, ignoring case.

isSystemStatus
string
Example: isSystemStatus=0

1, true or yes returns only the system statuses; 0, false or no only the account's own. Any other value is ignored, and every status is returned.

Responses

Response Headers
pagination-page-size
integer
Example: "10"

The number of statuses returned; every status fits on one page.

pagination-total-items
integer
Example: "10"

Total number of matching statuses

pagination-total-pages
integer
Example: "1"

Total number of pages; 1 when any status matches

pagination-current-page
integer
Example: "1"

Current page number (always 1)

pagination-next-page
integer
Example: "1"

Next page number. With every status on one page, it repeats the last page number.

pagination-before-page
integer
Example: "1"

Previous page number (always 1)

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A lease status: one of the account's named, orderable statuses. primaryLeaseStatusID groups it under one of the three lifecycle stages (Pending, Active, Closed), and the three move flags mark the statuses the move-in and move-out workflows use. The system statuses (isSystemStatus 1) come with every account; the others are the account's own.

Response samples

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

List Leases

Returns a page of the account's leases, sorted by unit address. Each item holds the lease, its unit and, without the property include, a token; the property and propertyImage includes add the property and its main image.

Use Cases

  • Listing the leases of a property, a unit or a portfolio
  • Finding a lease by its unit's address or a tenant's name

Business Rules

  • Any authenticated user can list leases; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets only the leases in them, with a 200
  • Send search with includes=unit
  • Sorted by the unit's street address only: leases at the same address come in no set order, which can move a lease between pages while paging
  • propertyImage needs property as well: send them together. A property with no image of its own sends Rentvine's placeholder image (propertyImageID 1, title NoImage.jpg, filePath system)
  • Naming unit in includes adds no key (the unit is always sent); send it with search

Available Includes (2)

  • property - the lease's property, under property; the item then has no token
  • propertyImage - the property's main image, under propertyImage (send it with property)
  • GET /leases/{leaseID} - One lease, with its includes
  • GET /properties - The properties, for propertyID
  • GET /portfolios - The portfolios, for portfolioID
Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

Page number, from 1 (default 1).

pageSize
integer >= 1
Default: 25
Example: pageSize=25

Items per page, from 1 (default 25). Values above 5000 are served at 5000.

search
string
Example: search=Main St

Send with includes=unit: returns the leases whose unit's address or second address line, or whose list of tenant names, contains this text (case-insensitive).

propertyID
integer
Example: propertyID=152

Returns only the leases on this property. Non-digit characters are dropped before use (12abc reads as 12); a value with no digits is ignored.

unitID
integer
Example: unitID=152

Returns only the leases on this unit. Non-digit characters are dropped before use (12abc reads as 12); a value with no digits is ignored.

portfolioID
integer
Example: portfolioID=12

Returns only the leases on properties in this portfolio. Non-digit characters are dropped before use (12abc reads as 12); a value with no digits is ignored.

includes
string
Example: includes=property,unit

Comma-separated related data to add to each item, with no spaces; property and propertyImage (send it with property). unit adds nothing; send it with search.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used -- the requested pageSize (default 25), 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 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A lease, as the property and unit includes send it: every column of the lease row (the shared lease model lacks some). tenants is decoded from JSON.

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)

The lease's property. Sent with the property include.

object (property_image)

The property's main image, or Rentvine's placeholder (propertyImageID 1) when it has none. Sent with the property and propertyImage includes.

token
string^[0-9]+$

The time of the request as a Unix timestamp; carries no data. Sent when the property include isn't.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

Get Lease

Returns one lease under lease. Every other key is opt-in through includes: each include adds its own keys beside lease, so one request can fetch a lease page's related records.

Use Cases

  • Reading a lease with its property, unit, tenants and status
  • Reading the lease's money in one call: balances, outstanding charges, recurring charges and transactions
  • Reading the lease's Resident Experience Package (REP) enrollment, insurance and renewal state

Business Rules

  • Any authenticated user can read a lease; no permission is checked
  • A lease ID with no lease answers 400 {"error": "Lease <leaseID> not found"}. That check runs before the portfolio restriction, so a restricted user gets the 400 too
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them
  • includes names are comma-separated with no spaces; a name with a space before or after it, and an unknown name, are ignored
  • Some includes need another: portfolio needs property; postingSetting and portfolioOwners need portfolio and property; chargesForPayment needs property; propertyManager and filterDeliveryConfiguration need unit. Without the include they need, they add nothing
  • Four includes answer false, not null, when the lease has no record to return: propertyManager, leaseFeeTransaction, leaseFeeBill and leaseDocumentTransaction. Two keys are left out instead: application when the lease has no application, previousPropertyPortfolio when the property has had no other portfolio
  • The include lists aren't paginated: transactions returns every transaction on the lease

Available Includes (44)

  • property - the lease's property, under property
  • portfolio - the property's portfolio, under portfolio (needs property)
  • postingSetting - the portfolio's posting setting and operating account, under postingSetting and operatingAccount (needs portfolio)
  • portfolioOwners - the portfolio's owners, under portfolioOwners (needs portfolio)
  • chargesForPayment - the unpaid charges a payment would pay, under chargesForPayment (needs property)
  • previousPropertyPortfolio - the property's previous portfolio, under previousPropertyPortfolio
  • unit - the lease's unit, under unit
  • propertyManager - the unit's property manager, under propertyManager (needs unit)
  • filterDeliveryConfiguration - the unit's Filter Delivery setup, under filterDeliveryConfiguration (needs unit)
  • creditReportingConfiguration - the tenants' Positive Credit Reporting readiness, under creditReportingConfiguration
  • chargeNotificationEnabled - whether new charges notify tenants, under chargeNotificationEnabled
  • leaseStatus - the lease's status, under leaseStatus
  • tenants - the lease's tenants, under tenants
  • leaseRecurringPayments - the tenants' automatic payments, under leaseRecurringPayments
  • leaseRecurringCredits - the recurring credits, under leaseRecurringCredits
  • recurringCharges - the recurring charges, under recurringCharges
  • residentPackage - the REP package enrollment and its package, under leaseResidentPackage and residentPackage
  • residentServices - the REP services, under residentServices
  • occupants, vehicles, emergencyContacts - the lease's occupants, vehicles and emergency contacts, each under its own name
  • pets - the pets under pets, and for a lease with an application petScreeningEnabled, petscreeningData and, when an applicant said they have none, noPetData
  • moveOutContact - the move-out tenant's contact, under moveOutContact
  • outstandingCharges, outstandingCredits, outstandingPayments - the unpaid charges and unallocated credits and payments, each under its own name
  • transactions - every transaction on the lease, under transactions
  • renewals and activeRenewal - the renewals, and the one in progress, each under its own name
  • balances - the lease's balances, under balances
  • lateFeeSetting - the late fee setting, under lateFeeSetting
  • leaseFeeTransaction, leaseFeeBill, leaseFeeBillCharges - how the lease fee was billed, each under its own name
  • refundableTransactions - payments and credits that can still be refunded, under refundableTransactions
  • tenantAddresses - the active tenants' addresses, under tenantAddresses
  • application - the rental application, under application
  • tenantLiabilityInsuranceProvider, tenantLiabilityInsurance - the tenant liability insurance, each under its own name
  • rentersInsuranceFile, rentersInsuranceRequest, tenantPolicyStatus - the renters insurance, each under its own name
  • leaseDocumentTransaction - the lease document in Rentsign, under leaseDocumentTransaction
  • statementSetting - the lease's statement setting, under statementSetting
  • GET /leases - List leases
  • GET /leases/{leaseID}/tenants - The lease's tenants, with their portal access
  • GET /leases/{leaseID}/recurring-charges - The lease's recurring charges, paginated
  • POST /leases/{leaseID} - Update the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

ID of the lease. A well-formed ID with no lease answers 400; a value that isn't a whole number of digits (a letter, a minus sign), 404.

query Parameters
includes
string
Example: includes=leaseStatus,tenants,balances,residentPackage

Comma-separated related data to add, with no spaces; see Available Includes for each name and the keys it adds.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (lease_detail)

The lease, with its current rent and whether a month-to-month conversion is scheduled.

object (property)

The lease's property. Sent with the property include.

object (included_portfolio)

The property's portfolio. Sent with the portfolio and property includes.

object (included_posting_setting)

The portfolio's posting setting. Sent with the postingSetting, portfolio and property includes.

object (account)

The posting setting's operating bank account. Sent with the postingSetting include, beside postingSetting.

Array of objects

The portfolio's owners, each share with its owner contact. Sent with the portfolioOwners, portfolio and property includes.

Array of objects

The lease's unpaid charges, due or not yet due, in the order a payment would pay them. Only charges posted in the property's current portfolio are included. Sent with the chargesForPayment and property includes.

object

The portfolio that owned the property most recently before its current one. Sent with the previousPropertyPortfolio include, and left out when the property has had no other portfolio (or the caller's portfolio restrictions hide it).

object (unit)

The lease's unit. Sent with the unit include.

property_manager (object) or boolean

The unit's property manager, or false (not null) when the unit has none. Sent with the propertyManager and unit includes.

object

Whether the unit is set up for the Filter Delivery REP service. Sent with the filterDeliveryConfiguration and unit includes. Every value is a JSON boolean or number.

object

Whether the lease's tenants can be reported for Positive Credit Reporting, and which can't and why. Sent with the creditReportingConfiguration include. No tax identifier is returned.

chargeNotificationEnabled
boolean

true when the account notifies tenants of a new charge, so a charge created on this lease would notify its tenants. Sent with the chargeNotificationEnabled include.

object (lease_status)

The lease's status. Sent with the leaseStatus include.

Array of objects (tenant)

The lease's tenants, active and removed, sorted active first, then primary first. Sent with the tenants include.

Array of objects

The lease's automatic payments, each with the payment method it charges, sorted by next payment date. Sent with the leaseRecurringPayments include.

Array of objects

The lease's recurring credits, sorted by next credit date. Sent with the leaseRecurringCredits include.

Array of objects (recurring_charge_summary)

The lease's recurring charges, current first, then by start date and account. Sent with the recurringCharges include.

lease_resident_package (object) or null

The lease's REP package enrollment, or null when it isn't enrolled. Sent with the residentPackage include.

included_resident_package (object) or null

The catalog package the lease is enrolled in, or null. Sent with the residentPackage include.

Array of objects

The lease's REP services, each with its catalog service. Sent with the residentServices include.

Array of objects (occupant)

The lease's occupants, in no set order. Sent with the occupants include.

Array of objects (lease_pet_with_photos)

The lease's pets, in no set order. Sent with the pets include.

petScreeningEnabled
boolean

true when the lease's application used PetScreening. Sent with the pets include, only when the lease has an application.

Array of arrays or object

The applicants' PetScreening results. Sent with the pets include, only when the lease has an application: an empty list when no applicant has a user login, otherwise an object built from the latest PetScreening report of the applicants (when several applicants have one, the last one's profiles and statusID win).

object

An applicant's confirmation that they have no pets. Sent with the pets include, only when the lease has an application and an applicant answered that they have no pets.

Array of objects (vehicle)

The lease's vehicles, in no set order. Sent with the vehicles include.

Array of objects (emergency_contact)

The lease's emergency contacts, in no set order. Sent with the emergencyContacts include.

included_contact (object) or null

The contact of the tenant named as the lease's move-out contact, or null when none is named. Sent with the moveOutContact include.

Array of objects

The lease's unpaid charges, newest first. Sent with the outstandingCharges include.

Array of objects

The lease's credits not fully allocated, newest first. Sent with the outstandingCredits include.

Array of objects

The lease's payments not fully allocated and not returned, newest first. Sent with the outstandingPayments include.

Array of objects

Every transaction on the lease that isn't voided, newest first by posting date and then by creation. Not paginated. Sent with the transactions include.

Array of objects (renewal_row)

The lease's renewals, newest first (up to 2,500). Sent with the renewals include.

renewal_row (object) or null

The newest renewal that isn't complete (leaseRenewalStatusID other than 11), or null when every renewal is complete or there is none. Sent with the activeRenewal include.

object (lease_balances-2)

The lease's balances. Sent with the balances include.

object (included_late_fee_setting)

The lease's late fee setting. Sent with the lateFeeSetting include.

transaction_record (object) or boolean

The lease charge that billed the lease fee, or false (not null) when the lease has none. A lease has one only when the account bills management fees on the ledger. Sent with the leaseFeeTransaction include.

included_bill (object) or boolean

The bill that billed the lease fee, or false (not null) when the lease has none. A lease has one only when the account bills management fees by bill. Sent with the leaseFeeBill include.

Array of objects (transaction_record)

The charges on the lease-fee bill that aren't voided; empty when there is no bill. Sent with the leaseFeeBillCharges include.

Array of objects (transaction_record)

The lease's payments and credits (deposit-release credits included) with an amount not yet allocated, not returned and not voided, sorted by posting date; each is a transaction itself, not wrapped. Sent with the refundableTransactions include.

Array of objects (tenant_address)

The addresses on file for the lease's active tenants. Sent with the tenantAddresses include.

object (included_application)

The rental application the lease came from. Sent with the application include, and left out when the lease has no application.

tenant_liability_insurance_provider (object) or null

The tenant liability insurance provider the lease names, or null. Sent with the tenantLiabilityInsuranceProvider include.

file (object) or null

The uploaded proof of the tenants' renters insurance, or null. Always null for a policy bought through Rentvine (the lease has a rentersInsuranceProviderTypeID), whose document isn't stored. Sent with the rentersInsuranceFile include.

renters_insurance_request (object) or null

The tenants' pending renters insurance request, or null. Sent with the rentersInsuranceRequest include.

object or null

The status of the renters insurance policy bought through Rentvine, or null for a lease without one (or none synced from the provider yet). Sent with the tenantPolicyStatus include.

tenant_liability_insurance (object) or null

The lease's tenant liability insurance, or null when it has neither a Rentvine enrollment nor a provider of its own. Sent with the tenantLiabilityInsurance include.

included_document_transaction (object) or boolean

The lease's lease document in Rentsign, or false (not null) when the lease has none. Sent with the leaseDocumentTransaction include.

statement_setting-2 (object) or null

The lease's default statement setting, or null when it has none. A statement batch that names its own setting uses that one instead, and a lease with no default gets statements only from a batch that names one. Sent with the statementSetting include.

Response samples

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

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 every tenant on a lease, active and removed, each as a leaseTenant (the tenant's place on the lease) and a contact. Each contact carries the tenant's portal access: whether the tenant has a tenant-portal account, an unexpired invitation, or came from an applicant with a login.

Use Cases

  • Listing a lease's current and past tenants
  • Checking which tenants can sign in to the tenant portal or still have an invitation open

Business Rules

  • Any authenticated user can read a lease's tenants; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist
  • A lease ID with no lease answers 200 with an empty list; 0 answers 400 (a restricted user gets the 403 instead, since the restriction is checked first)
  • Sorted active first, then primary first, then in the lease's tenant order, then by leaseTenantID
  • Not paginated: every tenant comes back in one response, with no pagination headers
  • Of the tenant's tax identifier only the last four digits are returned (taxIdentifierTruncated)
  • POST /leases/{leaseID}/tenants - Add a tenant to the lease
  • DELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease
  • GET /tenants/{contactID} - A tenant's full contact record
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

query Parameters
isActive
string
Example: isActive=1

1, true or yes returns only the active tenants; 0, false or no only the removed ones. Any other value is ignored, and every tenant is returned.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A tenant's place on a lease (lease_tenants), linking the lease to the tenant's contact.

required
object (tenant_contact_with_portal_data)

The tenant's contact, with the portal data the lease's tenant list adds. Of the tenant's tax identifier (SSN or ITIN) only the last four digits are returned; the full value never is.

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} (undocumented) 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} (undocumented) - 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 page of a lease's recurring charges, sorted by the date each next posts. Each item holds the recurringCharge and the chart-of-accounts account it posts to; the lease and property includes add the lease and its property to every item.

Use Cases

  • Listing the rent and other charges that post to a lease every month
  • Finding the charges that post to one account, or whose description matches a word

Business Rules

  • Any authenticated user can read a lease's recurring charges; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist
  • A lease ID with no lease answers 200 with an empty list
  • Sorted by nextChargeDate, earliest first; charges on the same date come in no set order
  • account is always sent, whatever includes says. A list item has no recurringStatusID: read one charge for it

Available Includes (2)

  • lease - the lease, under lease
  • property - the lease's property, under property
  • GET /leases/{leaseID}/recurring-charges/{chargeID} - One recurring charge, with its computed status
  • POST /leases/{leaseID}/recurring-charges - Add a recurring charge to the lease
  • GET /accounting/accounts - The chart of accounts, for the accountID filter
Authorizations:
basicAuth
path Parameters
leaseID
required
integer >= 1
Example: 2213

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

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
Example: search=Rent

Returns only the charges whose description contains this text.

accountID
integer
Example: accountID=9

Returns only the charges that post to this chart-of-accounts account (GET /accounting/accounts). Non-digit characters are dropped before use (12abc reads as 12); a value with no digits is ignored.

includes
string
Example: includes=lease,property

Comma-separated related data to add to each item; lease and property. Unknown names 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 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A recurring charge on a lease (lease_recurring_charges): an amount posted to the lease's ledger every frequency months on dayDue, from startDate until endDate (or with no end).

required
object (account)

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.

object (included_lease)

The charge's lease. Sent with the lease include.

object (property)

The lease's property. Sent with the property include.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 one recurring charge of a lease, with its status computed for today (recurringStatusID), and the lease's recurring charge created just before it (previousCharge, the one with the next lower ID), or null.

Use Cases

  • Showing one recurring charge and whether it is current, future or past
  • Comparing a charge with the one added before it, for example the rent before a rent increase

Business Rules

  • Any authenticated user can read a lease's recurring charges; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist, before the charge is looked up
  • A charge ID with no charge on this lease (none at all, or a charge of another lease) answers 400 {"error": "Recurring Charge <chargeID> not found"}
  • previousCharge is the lease's charge with the highest ID below this one, whatever its account or status; null for the lease's first charge
  • account is sent only with includes=account

Available Includes (1)

  • account - the chart-of-accounts account the charge posts to, under account
  • GET /leases/{leaseID}/recurring-charges - The lease's recurring charges
  • 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

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

chargeID
required
integer
Example: 11546

The charge's leaseRecurringChargeID. A well-formed ID with no charge on this lease answers 400; a value that isn't a whole number of digits, 404.

query Parameters
includes
string
Example: includes=account

account adds the chart-of-accounts account the charge posts to. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (recurring_charge_detail)

A recurring charge on a lease, with its status computed for today.

required
recurring_charge (object) or null

The lease's recurring charge with the next lower ID, or null for its first charge.

object (account)

The account the charge posts to. Sent only with includes=account.

Response samples

Content type
application/json
Example
{
  • "recurringCharge": {
    },
  • "previousCharge": {
    }
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.
  • search matches any part of the pet's name (not its type); without it every pet of the lease is listed. % 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 >= 1
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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The resident package a lease is enrolled in; a lease has at most one. Read a lease's package, and enroll the lease or change its enrollment. The packages themselves are under Resident Experience.

Get Lease Resident Package

Returns the lease's Resident Experience Package (REP) enrollment and the catalog package it is enrolled in. A lease has at most one enrollment, so this read takes no enrollment ID: it is found by the lease. A lease that isn't enrolled answers 200 with both keys null.

Use Cases

  • Checking whether a lease is enrolled in a package, and in which one
  • Reading the recurring charge the package bills through

Business Rules

  • Any authenticated user can read it; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist
  • A lease that isn't enrolled, or a lease ID with no lease, answers 200 with leaseResidentPackage and residentPackage both null
  • A cancelled enrollment is still returned, with leaseResidentPackageStatusID 2
  • POST /leases/{leaseID}/resident-package - Enroll the lease, or change its enrollment
  • GET /leases/{leaseID}/resident-services - The services active on the lease
  • GET /resident/packages/{residentPackageID} - The package in the catalog
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The lease's enrollment, or null when it isn't enrolled.

required
included_resident_package (object) or null

The catalog package the enrollment points to, or null when the lease isn't enrolled.

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The resident services active on a lease, each with the catalog service it comes from. List and read a lease's services, add one, and update one. The service catalog is under Resident Experience.

List Lease Resident Services

Returns every Resident Experience Package (REP) service on the lease, each with its catalog service: the services the lease gets through its package (they carry the package's residentPackageID and no recurring charge of their own) and the ones added on their own (with their own leaseRecurringChargeID, which a cancelled one may no longer have). Cancelled services are included.

Use Cases

  • Listing the services a resident pays for, in the package or on their own

Business Rules

  • Any authenticated user can read it; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist
  • A lease ID with no lease answers 200 with an empty list
  • Sorted by leaseResidentServiceID, oldest first
  • Not paginated: every service comes back in one response, with no pagination headers
  • The catalog service here leaves out its salePrice, which GET /leases/{leaseID}/resident-services/{id} returns
  • POST /leases/{leaseID}/resident-services - Add a service to the lease on its own
  • GET /leases/{leaseID}/resident-services/{id} - One of the lease's services
  • GET /leases/{leaseID}/resident-package - The lease's package enrollment
Authorizations:
basicAuth
path Parameters
leaseID
required
integer >= 1
Example: 2213

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A Resident Experience Package (REP) service in the account's catalog, as the lease's resident-service list selects it: the catalog row without its sale price.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 one Resident Experience Package (REP) service on the lease, with its full catalog service.

Use Cases

  • Reading one service on the lease, and whether it is active or cancelled

Business Rules

  • Any authenticated user can read it; no permission is checked
  • Portfolio restrictions: a user restricted to some portfolios gets a 403 for a lease outside them, and for a lease ID that doesn't exist
  • An ID with no service on this lease (none at all, or a service on another lease) answers the stock 404 body
  • POST /leases/{leaseID}/resident-services/{id} - Turn the service off or back on
  • GET /leases/{leaseID}/resident-services - Every service on the lease
Authorizations:
basicAuth
path Parameters
leaseID
required
integer
Example: 2213

ID of the lease. A value that isn't a whole number of digits (a letter, a minus sign) answers 404.

id
required
integer
Example: 41

The service's leaseResidentServiceID. An ID with no service on this lease, or a value that isn't a whole number of digits, answers 404.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 (included_resident_service)

A Resident Experience Package (REP) service in the account's catalog (resident_services): one of Rentvine's built-in services or one the account defined, offered to residents on its own or inside a package. The full row, as a lease's resident-service read returns it.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A work order is a maintenance job on a property or unit, assigned to a vendor or technician and tracked through its statuses. Create, list, read, update, delete and print 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns a page of work orders, newest first, each with its assigned vendor contact.

Use Cases

  • List a property's or a unit's work orders
  • Find the work orders assigned to a vendor or a maintenance technician
  • List the work orders created in a date range

Business Rules

  • Needs no permission beyond a valid API key.
  • A portfolio-restricted key gets only the work orders in its portfolios.
  • Sorted by dateTimeCreated, newest first. Work orders created in the same second have no fixed order between them, so a page boundary that falls inside such a tie can repeat or skip one of them.
  • An ID filter (propertyID, unitID, workOrderStatusID, vendorContactID) keeps only the digits it finds: a value with none (abc) is ignored, so the list comes back unfiltered by it, and 12abc filters by 12.
  • Filters combine with AND. search matches any part of the description or the work order number.
  • isOwnerApproved filters only for 1, true or yes (owner-approved work orders); 0, false, no or any other value is ignored.
  • vendorContactID matches the contact the work order is assigned to (vendorContactID), and on an internal work order any of its technicians.
  • startDate keeps the work orders created from midnight UTC of its date; endDate leaves out the work orders created after its date. A value the API can't read as a date matches no work order.
  • Each row's workOrder is the stored row: an internal work order with technicians keeps its appointment windows on the technicians, so its appointmentWindowStartDateTime and appointmentWindowEndDateTime are null here; GET /maintenance/work-orders/{workOrderID} returns the window in effect and each technician's in technicianData.
  • GET /maintenance/work-orders/search takes more filters (several statuses, priorities, modified dates) and sorting.
  • GET /maintenance/work-orders/{workOrderID} - Get one work order
  • GET /maintenance/work-orders/search - Search work orders with more filters
  • GET /maintenance/work-order/statuses - The values of workOrderStatusID
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
Example: search=leak

Returns the work orders whose description or work order number contains this text.

propertyID
integer
Example: propertyID=993

Returns the work orders of this property, from GET /properties.

unitID
integer
Example: unitID=383

Returns the work orders of this unit, from GET /properties/{propertyID}/units.

workOrderStatusID
integer
Example: workOrderStatusID=4

Returns the work orders in this status, from GET /maintenance/work-order/statuses.

isOwnerApproved
string
Example: isOwnerApproved=1

1, true or yes for owner-approved work orders only.

vendorContactID
integer
Example: vendorContactID=522

Returns the work orders assigned to this contact (vendorContactID), usually a vendor from GET /vendors or a maintenance technician from GET /maintenance-technicians, and the internal work orders that list this contact as one of their technicians.

startDate
string
Example: startDate=2026-02-27

Returns the work orders created on or after this date (YYYY-MM-DD or MM/DD/YYYY, read as midnight UTC; digits alone are read as a Unix timestamp, then cut to its date). A value the API can't read as a date matches no work order.

endDate
string
Example: endDate=2026-02-27

Leaves out the work orders created after this date (YYYY-MM-DD or MM/DD/YYYY; digits alone are read as a Unix timestamp, then cut to its date). A value the API can't read as a date matches no work order.

leaseID
integer
Example: leaseID=184

Returns the work orders of this lease, from GET /leases.

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 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The work order, every column of its row.

required
object (included_work_order_contact)

The work order's assigned contact (vendorContactID); every key is null when nobody is assigned.

Response samples

Content type
application/json
[
  • {
    }
]

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns one work order by ID: every column of the row, with how overdue it is, who is assigned and their appointment windows, and its scheduling status.

Use Cases

  • Read a work order's details, status, dates and assignee
  • Check whether a work order is overdue, and who is scheduled to do it

Business Rules

  • Needs no permission beyond a valid API key.
  • A portfolio-restricted key gets 403 (Work Order Access Not Allowed) for a work order outside its portfolios.
  • A well-formed ID with no work order answers 400 with Work Order {workOrderID} not found.
  • A path ID that isn't all digits (a negative number or a word) answers 404, except a word that is another route's (search, explore, stats, windows, estimates, templates, projects or labor-entries), which that route answers instead.
  • daysOverdue counts from dateDue in the account's time zone. It is null when the work order has no due date or has a dateClosed (set when it moves to a Closed status); a cancelled or on-hold work order past its due date still counts. isOverdue is 1 when daysOverdue is above 0.
  • GET /maintenance/work-orders - List work orders
  • GET /maintenance/work-orders/{workOrderID}/print - The work order as a PDF
  • POST /maintenance/work-orders/{workOrderID} - Update the work order
Authorizations:
basicAuth
path Parameters
workOrderID
required
integer
Example: 1116

The work order ID, from GET /maintenance/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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (work_order_detail)

A work order as GET /maintenance/work-orders/{workOrderID} returns it: every column of the row, the appointment window in effect, and four computed keys (daysOverdue, isOverdue, technicianContactIDs, technicianData).

schedulingStatusID
required
integer
Enum: 1 2 3 4

Where scheduling the work stands (a JSON number):

  • 1 - Time Choice Required by Vendor
  • 2 - Confirmation Required by Vendor: also any work order with no appointment window, no appointment request and vendorWorkOrderStatusID still Pending, assigned or not, open or closed
  • 3 - Time Choice Required by Tenant
  • 4 - Other: a window is set, an appointment request was answered, or the vendor status has moved past Pending

Response samples

Content type
application/json
{
  • "workOrder": {
    },
  • "schedulingStatusID": 4
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns the manager's version of the work order as a PDF, to print or archive. It includes the tenant's details and the manager-only sections a vendor's copy leaves out.

Use Cases

  • Print a work order for the office or a site visit
  • Archive a completed work order as a PDF

Business Rules

  • Needs no permission beyond a valid API key.
  • A portfolio-restricted key gets 403 (Access Denied) for a work order outside its portfolios.
  • A well-formed ID with no work order answers 400 with Work Order not found.
  • A path ID that isn't all digits (a negative number or a word) matches no route and answers 404.
  • GET /maintenance/work-orders/{workOrderID} - The work order as JSON
Authorizations:
basicAuth
path Parameters
workOrderID
required
integer
Example: 1116

The work order ID, from GET /maintenance/work-orders.

Responses

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

Always 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/pdf
string <binary>

Response samples

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

Work Order Statuses

The statuses a work order moves through: Rentvine's system statuses and your account's custom statuses, each under one primary status. List and read them, and create, update and delete custom 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier.

primaryWorkOrderStatusID
required
string (primary_statuses)
Enum: "1" "2" "3" "4" "5"
  • 1 - Pending
  • 2 - Open
  • 3 - Closed
  • 4 - On Hold
  • 5 - Cancelled
isSystemStatus
required
string
Enum: "0" "1"

1 for one of the seven system statuses, 0 for a status the account created.

name
required
string <= 100 characters

The status label shown on work orders.

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

Position in the account's status list; the list is sorted by it, lowest first.

Request samples

Content type
application/json
{
  • "primaryWorkOrderStatusID": "1",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "workOrderStatusID": "5",
  • "primaryWorkOrderStatusID": "1",
  • "isSystemStatus": "1",
  • "name": "On Hold",
  • "orderIndex": "5"
}

List Work Order Statuses

Returns every work-order status in the account, system and custom, in one response sorted by orderIndex.

Use Cases

  • Find the workOrderStatusID values a work order can carry, and the primary status each belongs to
  • List only the custom statuses an account created (isSystemStatus=0)

Business Rules

  • Needs no permission beyond a valid API key.
  • Every status comes back in one page: the list takes no page or pageSize, and the pagination headers always describe page 1.
  • Sorted by orderIndex, lowest first.
  • search matches any part of the name.
  • isSystemStatus reads 1, true or yes as system statuses only and 0, false or no as custom statuses only; any other value is ignored and every status is returned.
  • GET /maintenance/work-order/statuses/{workOrderStatusID} - Get one status
  • GET /maintenance/work-orders - List work orders, filterable by workOrderStatusID
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Hold

Returns the statuses whose name contains this text.

isSystemStatus
string
Example: isSystemStatus=0

1, true or yes for system statuses only; 0, false or no for custom statuses only. Any other value is ignored.

Responses

Response Headers
pagination-page-size
integer
Example: "8"

The number of statuses returned; 15 when nothing matches

pagination-total-items
integer
Example: "8"

Total number of matching statuses

pagination-total-pages
integer
Example: "1"

Total number of pages; 1 when anything matches, 0 when nothing does

pagination-current-page
integer
Example: "1"

Always 1

pagination-next-page
integer
Example: "1"

The last page number; there is never a next page

pagination-before-page
integer
Example: "1"

Always 1

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A work-order status: the label a work order carries (workOrderStatusID on a work order), grouped under one of the five primary statuses. Every account has the seven system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected) and any custom statuses it adds.

Response samples

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

Get Work Order Status

Returns one work-order status, system or custom.

Use Cases

  • Look up the name and primary status of a workOrderStatusID a work order carries

Business Rules

  • Needs no permission beyond a valid API key.
  • A well-formed ID with no status answers 400 with Work Order Status {workOrderStatusID} not found.
  • A path ID that isn't all digits (a negative number or a word) matches no route and answers 404.
  • GET /maintenance/work-order/statuses - List every status
Authorizations:
basicAuth
path Parameters
workOrderStatusID
required
integer
Example: 5

The status ID, from GET /maintenance/work-order/statuses.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (work_order_status)

A work-order status: the label a work order carries (workOrderStatusID on a work order), grouped under one of the five primary statuses. Every account has the seven system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected) and any custom statuses it adds.

Response samples

Content type
application/json
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (work_order_status)

A work-order status: the label a work order carries (workOrderStatusID on a work order), grouped under one of the five primary statuses. Every account has the seven system statuses (Open, Completed, Cancelled, Requested, On Hold, Estimating, Rejected) and any custom statuses it adds.

Request samples

Content type
application/json
{
  • "name": "Tech Completed",
  • "primaryWorkOrderStatusID": 2
}

Response samples

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

Vendor Trades

Trades are the maintenance categories, such as plumbing or HVAC, that classify work orders and vendors. List, create, read and update them.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier.

name
required
string <= 500 characters

Name of the vendor trade

isVisibleTenantPortal
required
string
Enum: "0" "1"

1 when residents can pick this trade when they submit a work order in the resident portal.

Request samples

Content type
application/json
{
  • "name": "string",
  • "isVisibleTenantPortal": "0"
}

Response samples

Content type
application/json
{
  • "vendorTradeID": "string",
  • "name": "string",
  • "isVisibleTenantPortal": "0"
}

List Vendor Trades

Returns every vendor trade (maintenance category) in the account, sorted by name, in one unpaginated array.

Use Cases

  • Find the vendorTradeID to file a work order under, or to filter vendors by

Business Rules

  • Needs no permission beyond a valid API key.
  • Not paginated: every match comes back in one response, with no pagination headers.
  • Trades hidden from the resident portal (isVisibleTenantPortal 0) are listed too.
  • search matches any part of the name.
  • GET /maintenance/vendor-trades/{vendorTradeID} - Get one trade, with its vendors
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Plumb

Returns the trades whose name contains this text.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A vendor trade (shown as a maintenance category in the app): a kind of work, such as Plumbing or HVAC, that vendors and technicians are linked to and a work order is filed under (vendorTradeID).

token
required
string^[0-9]+$

The time the list was read, as a Unix timestamp, sent on every row. It carries no data about the trade.

Response samples

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

Get Vendor Trade

Returns one vendor trade (a maintenance category) by ID, and with includes=vendors every contact linked to it.

Use Cases

  • Find the vendors and technicians who do a kind of work, through the vendors include

Business Rules

  • Needs no permission beyond a valid API key.
  • The vendors include lists every contact linked to the trade, vendors and maintenance technicians alike, active or not, ordered by contactID.
  • A well-formed ID with no trade answers 400 with Maintenance Category {vendorTradeID} not found.
  • A path ID that isn't all digits (a negative number or a word) answers 404, except a word that is another route's (search), which that route answers instead.

Available Includes (1)

  • vendors - Every contact linked to the trade: the link (contactVendorTrade) and the contact's record (contact); an empty array when none is
  • GET /maintenance/vendor-trades - List all vendor trades
  • GET /vendors/{contactID} - Get one of the vendors
  • POST /maintenance/vendor-trades/{vendorTradeID} - Update a vendor trade
Authorizations:
basicAuth
path Parameters
vendorTradeID
required
integer
Example: 84

The trade ID, from GET /maintenance/vendor-trades.

query Parameters
includes
string
Example: includes=vendors

Comma-separated related records to add, with no spaces. Available value, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (vendor_trade)

A vendor trade (shown as a maintenance category in the app): a kind of work, such as Plumbing or HVAC, that vendors and technicians are linked to and a work order is filed under (vendorTradeID).

Array of objects

Every contact linked to the trade, ordered by contactID. Sent only with includes=vendors.

Response samples

Content type
application/json
Example
{
  • "vendorTrade": {
    },
  • "vendors": [
    ]
}

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} (undocumented) - 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (vendor_trade)

A vendor trade (shown as a maintenance category in the app): a kind of work, such as Plumbing or HVAC, that vendors and technicians are linked to and a work order is filed under (vendorTradeID).

Request samples

Content type
application/json
{
  • "name": "Plumbing",
  • "isVisibleTenantPortal": "1"
}

Response samples

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

Inspections

An inspection records the condition of a property or unit at a point in time (before move-in, at move-in, at move-out, or a routine inspection), area by area. Create, list and read 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier.

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

The inspected unit's property.

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

The inspected unit.

leaseID
required
string or null^-?[0-9]+$

The lease the inspection is for, or null.

assignedToUserID
required
string or null^-?[0-9]+$

The user the inspection is assigned to, or null.

inspectionTypeID
required
string (inspection_types)
Enum: "1" "2" "3" "4"
  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
required
string (inspection_statuses)
Enum: "1" "2" "3" "4"
  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
description
required
string or null

Notes on the inspection.

scheduledDate
required
string or null <date>

The date the inspection is scheduled for.

inspectionDate
required
string or null <date>

The date the inspection was done.

dateTimeCreated
required
string <date>

The date the inspection was created (a date, despite the name).

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",
  • "unitID": "string",
  • "leaseID": "string",
  • "assignedToUserID": "string",
  • "inspectionTypeID": "1",
  • "inspectionStatusID": "1",
  • "description": "string",
  • "scheduledDate": "2019-08-24",
  • "inspectionDate": "2019-08-24",
  • "dateTimeCreated": "2019-08-24"
}

List Inspections

Returns a page of inspections, newest first, filterable by property, unit, lease, assignee, type and status.

Use Cases

  • List the inspections of a unit or a lease
  • Find the inspections assigned to a user, or the ones still pending

Business Rules

  • Needs no permission beyond a valid API key.
  • A portfolio-restricted key gets only the inspections whose property is in its portfolios.
  • Sorted by creation date, newest first. dateTimeCreated is a date, so inspections created the same day have no fixed order between them.
  • Each filter matches its column exactly; filters combine with AND. A filter keeps only the digits it finds: a value with none (abc) is ignored, so the list comes back unfiltered by it, and 12abc reads as 12.

Available Includes (3)

  • property - The inspection's property
  • unit - The inspected unit
  • lease - The inspection's lease; every key null when it has none
  • GET /maintenance/inspections/{inspectionID} - Get one inspection, with its areas, items and photos
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.

propertyID
integer
Example: propertyID=880

Returns the inspections of this property, from GET /properties.

unitID
integer
Example: unitID=311

Returns the inspections of this unit, from GET /properties/{propertyID}/units.

leaseID
integer
Example: leaseID=128

Returns the inspections of this lease, from GET /leases.

assignedToUserID
integer
Example: assignedToUserID=586

Returns the inspections assigned to this user (a user ID from the account's users; no lookup route is documented).

inspectionTypeID
integer
Enum: 1 2 3 4
Example: inspectionTypeID=3

Returns the inspections of this type:

  • 1 - Pre-Inspection
  • 2 - Move In
  • 3 - Move Out
  • 4 - Inspection
inspectionStatusID
integer
Enum: 1 2 3 4
Example: inspectionStatusID=4

Returns the inspections in this status:

  • 1 - Pending
  • 2 - In Progress
  • 3 - Pending Maintenance
  • 4 - Completed
includes
string
Example: includes=property,unit,lease

Comma-separated related records to add to each row, with no spaces: property, unit, lease.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

An inspection of a unit: a pre-inspection, move-in, move-out or routine walkthrough, who it is assigned to, and when it is scheduled and done.

object (included_property)

The inspection's property. Sent only with the property include.

object (included_unit)

The inspected unit. Sent only with the unit include.

object (included_lease_left_joined)

The inspection's lease, every key null when it has none. Sent only with the lease include.

token
string^[0-9]+$

The time the list was read, as a Unix timestamp. Sent on each row when includes names none of property, unit and lease; it carries no data about the inspection.

Response samples

Content type
application/json
[
  • {
    }
]

Get Inspection

Returns one inspection by ID, and with includes its property, unit, lease, work orders and the areas checked, each with its items, follow-up actions and photos.

Use Cases

  • Read a move-out inspection's findings: each area's items, their condition and comments, and the photos
  • Find the work orders an inspection led to

Business Rules

  • Needs no permission beyond a valid API key.
  • A portfolio-restricted key gets 403 (Access Denied) for an inspection whose property is outside its portfolios.
  • A well-formed ID with no inspection answers 400 with Inspection not found; the ID 0 answers 400 with Invalid Request.
  • A path ID that isn't all digits (a negative number or a word) answers 404, except a word that is another route's (search, explore, upcoming or files), which that route answers instead.
  • items and files only add to areas: without the areas include they add nothing.

Available Includes (7)

  • property - The inspection's property
  • unit - The inspected unit
  • lease - The inspection's lease, or null when it has none
  • workOrders - The work orders created from the inspection; an empty array when there are none
  • areas - The areas checked; an empty array when there are none
  • items - With areas: each area's items, sorted by name, each with its follow-up action
  • files - With areas: the photos of each area, and with items the photos of each item
  • GET /maintenance/inspections - List inspections
  • GET /maintenance/work-orders/{workOrderID} - Get one of the inspection's work orders
Authorizations:
basicAuth
path Parameters
inspectionID
required
integer
Example: 215

The inspection ID, from GET /maintenance/inspections.

query Parameters
includes
string
Example: includes=areas,items,files

Comma-separated related records to add, with no spaces: property, unit, lease, workOrders, areas, items, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (inspection)

An inspection of a unit: a pre-inspection, move-in, move-out or routine walkthrough, who it is assigned to, and when it is scheduled and done.

object (included_property)

The inspection's property. Sent only with the property include.

object (included_unit)

The inspected unit. Sent only with the unit include.

included_lease (object) or null

The inspection's lease, or null when it has none. Sent only with the lease include.

Array of objects (included_work_order)

The work orders created from the inspection. Sent only with the workOrders include.

Array of objects (inspection_area)

The areas checked. Sent only with the areas include.

Response samples

Content type
application/json
{
  • "inspection": {
    },
  • "areas": [
    ]
}

Materials

Your account's catalog of maintenance materials, with each one's purchase and sell price, for use on work orders. List, create, read, update and delete materials.

List Materials

Returns a page of the price-book materials that aren't deleted, each with the name, type and size of its image file.

Use Cases

  • Search the price book by name, description or UPC
  • List only the active (or only the inactive) materials

Business Rules

  • Needs no permission beyond a valid API key.
  • Deleted materials are never listed; GET /maintenance/materials/{materialID} still returns one.
  • search matches any part of name, description or upc.
  • isActive reads 1, true or yes as active only and 0, false or no as inactive only; any other value is ignored.
  • Sorted by orderBy, then by materialID. Without orderBy, by name; an orderBy with no known key sorts by materialID alone.
  • GET /maintenance/materials/{materialID} — get one material, deleted or not
  • POST /maintenance/materials — create a material
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). There is no cap. Only the digits are kept (5abc is read as 5); 0, a negative value or a value with no digits is read as 15.

search
string
Example: search=Register

Returns the materials whose name, description or UPC contains this text.

isActive
string
Example: isActive=1

1, true or yes for active materials only; 0, false or no for inactive only. Any other value is ignored.

orderBy
string
Default: "material.name"
Example: orderBy=material.sellPrice|desc

Comma-separated sort keys, each <key> or <key>|desc (|asc is the default): material.name, material.description, material.isActive, material.upc, material.purchasePrice, material.sellPrice. An unknown key is ignored, and materialID always breaks ties, so an orderBy with no known key sorts by materialID alone. Default (no orderBy) material.name. A leading - is not a direction: -material.name is an unknown key.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

The requested pageSize (default 25), or the total item count when that 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 (a value below 1 reads as 1), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A material as GET /maintenance/materials lists it: the material's columns without isDeleted, since the list returns only materials that aren't deleted.

required
object

The material's image file. Every key is null when the material has no image.

Response samples

Content type
application/json
Example
[
  • {
    }
]

Create Material

Adds a material to the account's price book and returns it, in the same shape as GET /maintenance/materials/{materialID}.

Use Cases

  • Add an item to the price book so it can be used on work orders
  • Import a supplier's catalog, one material per request

Business Rules

  • name and sellPrice are required. The fields are validated together, so one 400 can list several fields. It doesn't always list them all: when imageFileID names no file, a missing name isn't reported in the same response.
  • name must be unique among the account's materials that aren't deleted. Names are compared as Swedish text: case and most accents are ignored (Café matches Cafe), but å, ä, ö and ø are letters of their own, æ matches ä, and ü matches y. A deleted material's name can be used again.
  • There is no idempotency key. Once a create has answered, sending the same request again doesn't create a second material: the repeat answers 400 with A material already exists with this name, and the material the first request created is unchanged. To confirm a create whose response was lost, look the name up with the search parameter of GET /maintenance/materials.
  • A new material is created active (isActive 1) and not deleted.
  • includes=file adds the image's file record to the response, as on GET /maintenance/materials/{materialID}.

Side Effects

  • None besides the new material.

Available Includes (1)

  • file - The image's file record, or null when the material has no image
  • GET /maintenance/materials — list materials, or find one by name
  • GET /maintenance/materials/{materialID} — get the created material
  • POST /maintenance/materials/{materialID} — update it, for example to make it inactive
  • POST /files — upload the image file whose ID imageFileID takes
Authorizations:
basicAuth
query Parameters
includes
string
Example: includes=file

Related records to add to the response, as one comma-separated string. Available value, file.

Request Body schema: application/json
required
non-empty
name
required
string [ 1 .. 200 ] characters ^\S(.*\S)?$

Display name of the material, in Windows-1252 characters (Latin-1, so accented letters such as á, plus a few more such as €), with no leading or trailing spaces. It must be unique among the account's materials that aren't deleted, compared as Swedish text: floor register, Floor Register and Flóor Register are the same name, but å, ä, ö and ø are letters of their own (Mortel and Mörtel are two names), æ matches ä, and ü matches y (Müller and Myller are the same name). A deleted material's name can be used again.

sellPrice
required
string or number <decimal> ( 0 .. 9999999.99 ] ^(?=.*[1-9])[0-9]{1,7}(\.[0-9]{1,2})?$

What the material is charged at when used on a work order: greater than 0 and up to 9999999.99, with up to 2 decimals.

description
string or null <= 4000 characters

Optional description or supplier note, in Windows-1252 characters, as name. Leading and trailing spaces are removed, and an empty or blank string is stored as null.

isActive
string or integer
Default: "1"
Enum: "1" 1

A new material is created active: leave this out or send 1. To make a material inactive, update it after creating it.

upc
string or null^([0-9]{12})?$

Universal Product Code, exactly 12 digits. An empty string or null stores no UPC.

purchasePrice
string or number or null <decimal> [ 0 .. 9999999.99 ] ^[0-9]{1,7}(\.[0-9]{1,2})?$

What the material costs to buy: from 0 to 9999999.99, with up to 2 decimals. null or leaving it out stores no purchase price.

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

The ID of an existing file to use as the material's image (an upload from POST /files), or null for no 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (material)

A price-book material: an inventory item that can be added to a work order, with what it costs and what it is sold for. Deleting a material only flags it (isDeleted 1).

file (object) or null

The material's image file, or null when it has none. Sent only with includes=file.

Request samples

Content type
application/json
Example
{
  • "name": "Smoke Detector",
  • "sellPrice": "19.99"
}

Response samples

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

Get Material

Returns one price-book material by ID, with its image's file record when includes=file is sent.

Use Cases

  • Display a material's prices and image
  • Read a material a work order uses, deleted or not

Business Rules

  • Needs no permission beyond a valid API key.
  • A deleted material is still returned, with isDeleted 1.
  • A well-formed ID with no material answers 400 with Material {materialID} not found.
  • A path ID that isn't all digits (a negative number or a word) answers 404, except a word that is another route's (explore, locations or quantities), which that route answers instead.

Available Includes (1)

  • file - The material's image file record, or null when it has none
  • GET /maintenance/materials — list materials
  • POST /maintenance/materials/{materialID} — update this material
  • DELETE /maintenance/materials/{materialID} — delete this material
Authorizations:
basicAuth
path Parameters
materialID
required
integer
Example: 236

The material ID, from GET /maintenance/materials.

query Parameters
includes
string
Example: includes=file

Comma-separated related records to add, with no spaces. Available value, file.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (material)

A price-book material: an inventory item that can be added to a work order, with what it costs and what it is sold for. Deleting a material only flags it (isDeleted 1).

file (object) or null

The material's image file, or null when it has none. Sent only with includes=file.

Response samples

Content type
application/json
Example
{
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (material)

A price-book material: an inventory item that can be added to a work order, with what it costs and what it is sold for. Deleting a material only flags it (isDeleted 1).

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Your account's rates for maintenance labor, for use on work orders. List, create, read, update and delete labor rates.

List Labor Rates

Returns a page of the price-book labor rates. Deleted labor rates are left out unless isDeleted asks for them.

Use Cases

  • Find the labor types a technician can log on a work order, with the owner and hourly rates
  • Look up several labor rates by ID in one call

Business Rules

  • Needs no permission beyond a valid API key.
  • isDeleted defaults to 0, so only labor rates that aren't deleted are listed.
  • search matches any part of name or description.
  • rateMin and rateMax include the bound itself.
  • laborRateIDs[] wins over laborRateID when both are sent.
  • Sorted by orderBy, then by name. Rows with the same sort value and the same name have no fixed order, so sort by laborRate.laborRateID to page through a stable order.
  • GET /maintenance/labor-rates/{laborRateID} — get one labor rate, deleted or not
  • POST /maintenance/labor-rates — create a labor rate
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). There is no cap. Only the digits are kept (5abc is read as 5); 0, a negative value or a value with no digits is read as 15.

search
string
Example: search=Plumber

Returns the labor rates whose name or description contains this text.

laborRateID
integer
Example: laborRateID=166

Returns only this labor rate. Ignored when laborRateIDs[] is sent.

laborRateIDs[]
Array of integers
Example: laborRateIDs[]=166&laborRateIDs[]=167

Returns only these labor rates. Send each ID as its own laborRateIDs[]=.

rateMin
number
Example: rateMin=40

Returns the labor rates whose rate is at least this amount.

rateMax
number
Example: rateMax=100

Returns the labor rates whose rate is at most this amount.

isDeleted
integer
Default: 0

0 (the default) for labor rates that aren't deleted, 1 for deleted ones only. Any other number returns both. Only the digits are kept (1abc is read as 1); a value with no digits is read as 0.

orderBy
string
Default: "laborRate.name"
Example: orderBy=laborRate.rate|desc

Comma-separated sort keys, each <key> or <key>|desc (|asc is the default): laborRate.laborRateID, laborRate.name, laborRate.rate, laborRate.dateTimeCreated, laborRate.dateTimeModified. An unknown key is ignored, and the name always breaks ties. Default laborRate.name.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

The requested pageSize (default 25), or the total item count when that 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 (a value below 1 reads as 1), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A price-book labor rate: a kind of labor a technician logs on a work order, with the rate the owner is charged and the technician's hourly rate. A rate of 0.00 is a non-billable labor type. Deleting a labor rate only flags it (isDeleted 1).

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the labor rate

name
required
string <= 200 characters

Display name of the labor rate

description
required
string or null <= 4000 characters

Optional description of the labor rate

rate
required
string <decimal>

Rate charged to the owner for this labor type (decimal as string). 0.00 means non-billable.

hourlyRate
required
string or null <decimal>

The technician's hourly rate (decimal as string), or null when not set.

isDeleted
required
string
Enum: "0" "1"

Soft-delete flag. 0 = active record, 1 = deleted

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.

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

Returns one labor rate by ID, as a flat object with no wrapper key.

Use Cases

  • Read the owner rate and technician hourly rate of a labor type a work order's labor entry uses

Business Rules

  • Needs no permission beyond a valid API key.
  • A deleted labor rate is still returned, with isDeleted 1.
  • A well-formed ID with no labor rate answers 400 with Labor Rate {laborRateID} not found.
  • A path ID that isn't all digits (a negative number or a word) answers 404, except a word that is another route's (explore), which that route answers instead.
  • GET /maintenance/labor-rates — list 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: 219

The labor rate ID, from GET /maintenance/labor-rates.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the labor rate

name
required
string <= 200 characters

Display name of the labor rate

description
required
string or null <= 4000 characters

Optional description of the labor rate

rate
required
string <decimal>

Rate charged to the owner for this labor type (decimal as string). 0.00 means non-billable.

hourlyRate
required
string or null <decimal>

The technician's hourly rate (decimal as string), or null when not set.

isDeleted
required
string
Enum: "0" "1"

Soft-delete flag. 0 = active record, 1 = deleted

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.

Response samples

Content type
application/json
{
  • "laborRateID": "219",
  • "name": "Licensed Electrician",
  • "description": "Licensed electrician, per visit",
  • "rate": "110.00",
  • "hourlyRate": "85.00",
  • "isDeleted": "0",
  • "dateTimeCreated": "2026-11-16 19:30:45",
  • "dateTimeModified": "2026-11-16 19:30:45"
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the labor rate

name
required
string <= 200 characters

Display name of the labor rate

description
required
string or null <= 4000 characters

Optional description of the labor rate

rate
required
string <decimal>

Rate charged to the owner for this labor type (decimal as string). 0.00 means non-billable.

hourlyRate
required
string or null <decimal>

The technician's hourly rate (decimal as string), or null when not set.

isDeleted
required
string
Enum: "0" "1"

Soft-delete flag. 0 = active record, 1 = deleted

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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A portfolio groups the properties that the same owners own, with its own ledger, reserve and owner statement settings. List, search, create, read, update, activate and deactivate portfolios, set and read their owners, and search and read owner statements and statement batches.

List Portfolios

Returns a paginated list of portfolios, sorted by name. Each item wraps the full portfolio row under portfolio, with a token beside it. Use GET /portfolios/search for more filters, sorting, and the owner names and latest statement of each portfolio.

Use Cases

  • List the active portfolios in the account
  • Find a portfolio by name or code
  • List the portfolios that do or don't send owner statements
  • Exclude one portfolio from the list (for example, the portfolio being reassigned from)

Business Rules

  • Only active portfolios are returned unless isActive says otherwise
  • Sorted by name only: portfolios with the same name come in no fixed order, so paging through them can repeat or skip one
  • search matches the portfolio's name or code, not its owners' names
  • A user restricted to portfolio groups sees only the portfolios in those groups; the others are left out, not refused
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • token is the current Unix time (in seconds) as a string, the same on every item of a response
  • GET /portfolios/search - Filtered, sortable search with owner names, property counts and the latest statement
  • GET /portfolios/{portfolioID} - One portfolio, with optional includes
Authorizations:
basicAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

Page number, from 1 (default 1).

pageSize
integer >= 1
Default: 25
Example: pageSize=25

Items per page, from 1 (default 25). Values above 5000 are served at 5000.

search
string
Example: search=Main St

Text to find anywhere in the portfolio's name or code. Owner names are not searched.

isActive
string
Default: "1"
Example: isActive=0

1, true or yes (the default) returns only active portfolios; 0, false or no only inactive ones. Any other value returns both.

sendStatements
string
Example: sendStatements=1

1, true or yes returns only portfolios that send owner statements; 0, false or no only those that don't. Absent or any other value doesn't filter.

excludePortfolioID
integer
Example: excludePortfolioID=150

Leave this portfolio out of the results.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used -- the requested pageSize (default 25), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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^[0-9]+$

The current Unix time in seconds, the same on every item.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Searches portfolios with filters and sorting, one page at a time. Each row holds a summary of the portfolio under portfolio (with its active property count and its owners' names), the name of its statement setting under statementSetting, and its latest statement's name and dates under lastStatement.

Use Cases

  • Find portfolios by name, code, or an owner's name or code
  • Filter by reserve amount, distribution hold, statement sending, tags, portfolio groups or property groups
  • Find the portfolios paid in one payout batch
  • Pick up the portfolios changed since a point in time

Business Rules

  • Active and inactive portfolios both come back unless isActive filters them
  • Filters combine with AND; the values of one list filter combine with OR
  • A filter value that can't be read (a non-numeric amount, an unparseable date, a word other than the yes and no forms for a flag) is ignored: the results aren't filtered by it. The list filters take integer IDs only
  • Sorted by name when orderBy is absent, then by portfolioID
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • A user restricted to portfolio groups sees only the portfolios in those groups; the others are left out, not refused
  • GET /portfolios - Paginated list of full portfolio rows
  • GET /portfolios/{portfolioID} - One portfolio, with optional includes
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). A value of 0 or below is read as 15. There is no upper limit.

search
string
Example: search=Main St

Text to find in the portfolio's name or code, or in the name or code of any of its owners.

isActive
string
Example: isActive=1

1, true or yes returns only active portfolios; 0, false or no only inactive ones. Absent or any other value returns both.

portfolioIDs[]
Array of integers
Example: portfolioIDs[]=150

Only these portfolios. Send each ID as a separate portfolioIDs[]=; a single portfolioIDs= value also works.

postingSettingIDs[]
Array of integers
Example: postingSettingIDs[]=3

Only portfolios on these posting settings (GET /settings/postings (undocumented) lists them). Send each ID as a separate postingSettingIDs[]=.

statementSettingIDs[]
Array of integers
Example: statementSettingIDs[]=12

Only portfolios on these statement settings (GET /settings/statements (undocumented) lists them). Send each ID as a separate statementSettingIDs[]=.

portfolioGroupIDs[]
Array of integers
Example: portfolioGroupIDs[]=5

Only portfolios in any of these portfolio groups (GET /portfolios/groups (undocumented) lists them). Send each ID as a separate portfolioGroupIDs[]=.

propertyGroupIDs[]
Array of integers
Example: propertyGroupIDs[]=8

Only portfolios with at least one property in any of these property groups (GET /properties/groups (undocumented) lists them). Send each ID as a separate propertyGroupIDs[]=.

tagIDs[]
Array of integers
Example: tagIDs[]=22

Only portfolios tagged with any of these tags (GET /tags (undocumented) lists them). Send each ID as a separate tagIDs[]=.

reserveAmountMin
number
Example: reserveAmountMin=500

Only portfolios whose reserveAmount is at least this. A non-numeric value is ignored.

reserveAmountMax
number
Example: reserveAmountMax=5000

Only portfolios whose reserveAmount is at most this. A non-numeric value is ignored.

holdDistributions
string
Example: holdDistributions=0

1, true or yes returns only portfolios whose distributions are on hold; 0, false or no only those that are not.

hasAdditionalReserve
string
Example: hasAdditionalReserve=1

1, true or yes returns only portfolios with an additionalReserveAmount above 0; 0, false or no only those with none.

sendStatements
string
Example: sendStatements=1

1, true or yes returns only portfolios that send owner statements; 0, false or no only those that do not.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2024-01-01T10:00:00Z

Only portfolios 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.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2024-12-31 23:59:59

Only portfolios last modified on or before this date and time, in UTC, in the forms dateTimeModifiedMin takes.

dateClosedMin
string
Example: dateClosedMin=2024-01-01

Only portfolios closed on or after this date (YYYY-MM-DD or MM/DD/YYYY).

dateClosedMax
string
Example: dateClosedMax=2024-12-31

Only portfolios closed on or before this date (YYYY-MM-DD or MM/DD/YYYY).

portfolioAssignedToUserIDs[]
Array of integers
Example: portfolioAssignedToUserIDs[]=42

Only portfolios assigned to any of these users (GET /users (undocumented) lists them). Send each ID as a separate portfolioAssignedToUserIDs[]=.

propertyAssignedToUserIDs[]
Array of integers
Example: propertyAssignedToUserIDs[]=42

Only portfolios with at least one property assigned to any of these users (GET /users (undocumented) lists them). Send each ID as a separate propertyAssignedToUserIDs[]=.

payoutBatchID
integer
Example: payoutBatchID=300

Only portfolios with a payout in this payout batch (GET /accounting/payouts/batches (undocumented) lists them).

orderBy
string
Example: orderBy=portfolio.reserveAmount|desc,portfolio.name

Sort order: a comma-separated list of column or column|asc / column|desc (ascending when no direction is given). The columns are portfolio.isActive, portfolio.name, portfolio.contacts (the owners' names), portfolio.postingSettingID, portfolio.minimumDistributionAmount, portfolio.maximumDistributionAmount, portfolio.reserveAmount, portfolio.additionalReserveAmount, portfolio.sendStatements, portfolio.holdDistributions, portfolio.dateClosed, portfolio.propertyCount and statementSetting.name. A column not in this list is ignored. When orderBy is absent the sort is portfolio.name; when it names no listed column at all, rows come in portfolioID order. Ties are always broken by portfolioID, ascending.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used on a page that holds items -- the requested pageSize (default 25), or the number of matching items when fewer match.

pagination-total-items
integer
Example: "84"

Total number of items across all pages

pagination-total-pages
integer
Example: "4"

Total number of pages; 0 when nothing matches

pagination-current-page
integer
Example: "1"

The page requested (1 for a value below 1), even past the last page

pagination-next-page
integer
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

A summary of the portfolio row, with two computed columns.

required
object

The portfolio's statement setting.

required
object

The portfolio's latest statement (by end date, then statement ID); every field null when it has none.

Response samples

Content type
application/json
[
  • {
    }
]

Get Portfolio

Returns one portfolio under portfolio, the full row. Related records are added on request through includes.

Use Cases

  • Load a portfolio's settings, reserves and owners
  • Read a portfolio's ledger balances and available funds before paying owners
  • Read its property, lease, occupancy and unpaid-bill counts

Business Rules

  • A user restricted to portfolio groups gets 403 for a portfolio outside them
  • A well-formed ID with no portfolio answers 400, as does 0
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • isLiveLedgerEnabled of null means the account-level default applies
  • includes is a comma-separated list; unknown names are ignored, and each include adds one key to the response

Available Includes (6)

  • owners - The portfolio's owners, each with its contact record
  • ledger - The portfolio's ledger, or null when it has none
  • posting - The portfolio's posting setting
  • balances - The portfolio ledger's balances, or null when the portfolio has no ledger. A ledger with no entries yet gets a shorter object whose balances are the number 0
  • statistics - Counts of active properties, units, occupied units and active leases, and the unpaid bills' count and total
  • statementSetting - The portfolio's statement setting template
  • GET /portfolios - Paginated portfolio list
  • GET /portfolios/{portfolioID}/owners - The portfolio's owners
  • GET /portfolios/{portfolioID}/statements - The portfolio's statements
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 150

The ID of the portfolio to retrieve.

query Parameters
includes
string
Example: includes=owners,balances,statementSetting

Comma-separated list of related data to add to the response: owners, ledger, posting, balances, statistics, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The portfolio's owners, ordered by portfolioOwnerID; empty when it has none. Requires the owners include.

included_ledger (object) or null

The portfolio's ledger, or null when it has none. Requires the ledger include.

object

The portfolio's posting setting. Requires the posting include.

Ledger with entries (object) or Ledger with no entries (object) or null

The portfolio ledger's balances as of now, or null when the portfolio has no ledger. Requires the balances include. A ledger with entries gets every balance as a decimal string, with availableFunds; a ledger with no entries yet gets a shorter object whose balances are the JSON number 0, and no availableFunds.

object

Rollup counts for the portfolio. Requires the statistics include.

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": {
    },
  • "owners": [
    ],
  • "ledger": {
    },
  • "posting": {
    },
  • "balances": {
    },
  • "statistics": {
    },
  • "statementSetting": {
    }
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 every owner of a portfolio, ordered by portfolioOwnerID, in one unpaginated array. Each item holds the owner record under owner; the contact and portfolio includes add the owner's contact and the portfolio beside it. With no include, each item has a token instead.

Use Cases

  • Show who owns a portfolio, with ownership and distribution percentages
  • Read each owner's payout settings (payee name, payout type, saved ACH account type)
  • Find an owner by name

Business Rules

  • The list is not paginated: every owner comes back, and no pagination headers are sent
  • search matches the owner contact's name; send it with the contact include
  • A portfolio ID with no portfolio returns an empty list; 0 answers 400
  • A user restricted to portfolio groups gets 403 for a portfolio outside them, and for a portfolio ID with no portfolio
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • token, sent only when no include is requested, is the current Unix time (in seconds) as a string, the same on every item

Available Includes (2)

  • contact - The owner's contact record, every column
  • portfolio - The portfolio, every column (the same on every item)
  • GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - One owner
  • GET /portfolios/{portfolioID} - The portfolio, whose owners include returns the same owners with their contacts
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio whose owners to list.

query Parameters
search
string
Example: search=Smith

Text to find in the owner contact's name. Send it with the contact include.

includes
string
Example: includes=contact

Comma-separated list of related data to add to each item: contact, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

object (included_contact)

The owner's contact. Requires the contact include.

object (portfolio)

The portfolio. Requires the portfolio include.

token
string^[0-9]+$

The current Unix time in seconds, the same on every item. Sent only when no include is requested.

Response samples

Content type
application/json
Example
[
  • {
    }
]

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 one owner of a portfolio under portfolioOwner: the ownership and distribution percentages and the owner's payout settings for this portfolio. The portfolio and contact includes add those records beside it.

Use Cases

  • Read one owner's percentages and payout settings
  • Load the owner's contact record in the same call

Business Rules

  • The owner must belong to the portfolio in the path: an owner of another portfolio answers 400, as does an ID with no owner and an owner ID of 0
  • A user restricted to portfolio groups gets 403 for a portfolio outside them, checked before the owner is looked up
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • The saved ACH account number shows here only as its last four digits

Available Includes (2)

  • portfolio - The portfolio, every column
  • contact - The owner's contact record, every column
  • GET /portfolios/{portfolioID}/owners - Every owner of the portfolio
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer
Example: 279

The ID of the portfolio.

portfolioOwnerID
required
integer
Example: 536

The ID of the portfolio owner record (owner.portfolioOwnerID in GET /portfolios/{portfolioID}/owners).

query Parameters
includes
string
Example: includes=contact

Comma-separated list of related data to add to the response: 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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)

The portfolio. Requires the portfolio include.

object (included_contact)

The owner's contact. Requires the contact include.

Response samples

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

Search Statements

Searches owner statements across portfolios, one page at a time, newest first (by start date, then statement ID). Each row holds a summary of the statement under statement (with counts of its files and attachments), the portfolio's ID, name and owners under portfolio, and the statement setting's ID and name under statementSetting.

Use Cases

  • List the statements of one batch (statementBatchID)
  • Find the statements in a status, such as those waiting in Review
  • List the statements of some portfolios in a date range

Business Rules

  • Filters combine with AND
  • A statementStatusID or date that can't be read is ignored: the results aren't filtered by it. portfolioIDs takes integer IDs only
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • A user restricted to portfolio groups sees only the statements of portfolios in those groups; the others are left out, not refused
  • Sorted by startDate, newest first, then by statementID, highest first, so statements with the same start date keep one order from page to page. No parameter changes the order
  • GET /portfolios/{portfolioID}/statements - One portfolio's statements, full rows
  • GET /portfolios/statements/{statementID} - One statement, with its files
  • GET /portfolios/statements/batches/search - Statement batches
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). A value of 0 or below is read as 15. There is no upper limit.

statementBatchID
integer >= 1
Example: statementBatchID=812

Only statements in this batch (GET /portfolios/statements/batches/search lists batches).

statementStatusID
integer
Enum: 1 2 3 4 5
Example: statementStatusID=4

Only statements in this status.

  • 1 - Processing
  • 2 - Published
  • 3 - Failed
  • 4 - Review
  • 5 - Publishing
startDate
string
Example: startDate=2026-01-01

Only statements whose period starts on or after this date (YYYY-MM-DD or MM/DD/YYYY).

endDate
string
Example: endDate=2026-03-31

Only statements whose period ends on or before this date (YYYY-MM-DD or MM/DD/YYYY).

portfolioIDs[]
Array of integers
Example: portfolioIDs[]=150

Only the statements of these portfolios. Send each ID as a separate portfolioIDs[]=; a single portfolioIDs= value also works.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used on a page that holds items -- the requested pageSize (default 25), or the number of matching items when fewer 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 (1 for a value below 1), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

A summary of the statement row, with two counts.

required
object

The statement's portfolio.

required
object

The statement's statement setting.

Response samples

Content type
application/json
[
  • {
    }
]

List Portfolio Statements

Returns a portfolio's owner statements, one page at a time, newest first (by end date, then statement ID). Each item holds the statement under statement and its statement setting template under statementSetting; the portfolio include adds the portfolio. Use GET /portfolios/statements/search to search across portfolios.

Use Cases

  • Show a portfolio's statement history
  • Find a portfolio's latest statement and its public link

Business Rules

  • A portfolio ID with no portfolio returns an empty list
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • A user restricted to portfolio groups gets 403 for a portfolio outside them, and for a portfolio ID with no portfolio
  • search is accepted but ignored
  • Sorted by endDate, newest first, then by statementID, highest first, so statements with the same end date keep one order from page to page. A statement with no endDate comes after every dated one. No parameter changes the order

Available Includes (1)

  • portfolio - The portfolio, every column
  • GET /portfolios/statements/search - Statements across portfolios, with filters
  • GET /portfolios/statements/{statementID} - One statement, with its files
  • GET /portfolios/statements/{statementID}/download - A statement's files as a ZIP archive
Authorizations:
basicAuth
path Parameters
portfolioID
required
integer >= 1
Example: 279

The ID of the portfolio whose statements to list.

query Parameters
page
integer >= 1
Default: 1
Example: page=1

Page number, from 1 (default 1).

pageSize
integer >= 1
Default: 25
Example: pageSize=25

Items per page, from 1 (default 25). Values above 5000 are served at 5000.

includes
string
Example: includes=portfolio

Comma-separated list of related data to add to each item: portfolio.

search
string

Accepted but ignored; the list isn't filtered by it.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used -- the requested pageSize (default 25), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

object (portfolio)

The portfolio. Requires the portfolio include.

Response samples

Content type
application/json
[
  • {
    }
]

Get Statement

Returns one owner statement under statement, the full row: its period, status, money summary and public link. The portfolio, statementFiles and fileAttachments includes add the portfolio, the statement's generated files and the files attached to it by hand.

Use Cases

  • Show a statement's financial summary and status
  • List the files to download with a statement
  • Read the statement's public link (publicUUID) and the code it asks for

Business Rules

  • A well-formed ID with no statement answers 400
  • A user restricted to portfolio groups gets 403 for a statement of a portfolio outside them
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • publicUUID and publicVerificationCode open the statement's public page without signing in; treat them as secrets

Available Includes (3)

  • portfolio - The statement's portfolio, every column
  • statementFiles - The statement's generated files (the statement PDF, and its report, work-order and bill files); empty when there are none
  • fileAttachments - The files attached to the statement by hand, each with its file record (fileAttachment.objectTypeID is always 15, a statement); empty when there are none
  • GET /portfolios/statements/{statementID}/download - The statement's files as a ZIP archive
  • GET /portfolios/statements/{statementID}/download-pdf (undocumented) - The statement's files merged into one PDF
  • GET /portfolios/statements/files/{statementFileID}/download (undocumented) - One generated file, by its statementFileID
  • GET /portfolios/{portfolioID}/statements - The portfolio's statements
  • GET /portfolios/statements/search - Statements across portfolios
Authorizations:
basicAuth
path Parameters
statementID
required
integer
Example: 5012

The ID of the statement to retrieve.

query Parameters
includes
string
Example: includes=statementFiles,fileAttachments

Comma-separated list of related data to add to the response: 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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)

The statement's portfolio. Requires the portfolio include.

Array of objects

The statement's generated files. Requires the statementFiles include.

Array of objects

The files attached to the statement by hand. Requires the fileAttachments include. Each fileAttachment.objectTypeID is 15 (a statement).

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "portfolio": {
    },
  • "statementFiles": [
    ],
  • "fileAttachments": [
    ]
}

Download Statement

Downloads a statement's files as one ZIP archive: its generated files (the statement PDF, and its report, work-order and bill files, each named after its title and the statement period) and the files attached to it by hand. The archive is named Owner Packet {start}-{end}.zip, with the period's dates as MM-DD-YYYY.

Use Cases

  • Save a statement's whole owner packet
  • Archive statements, or send them to a third party

Business Rules

  • A well-formed ID with no statement answers 400
  • A user restricted to portfolio groups gets 403 for a statement of a portfolio outside them
  • A statement with no files is not refused: it answers 200 with the download headers and an empty body (0 bytes, which ZIP tools don't open as an archive)
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • If any of the statement's files is missing from storage, the request fails with 400 Could not add "{title}" to the zip. The file is missing. and no archive
  • GET /portfolios/statements/{statementID} - The statement, with its statementFiles and fileAttachments
  • GET /portfolios/{portfolioID}/statements - The portfolio's statements
Authorizations:
basicAuth
path Parameters
statementID
required
integer
Example: 5012

The ID of the statement to download.

Responses

Response Headers
Content-Disposition
string
Example: "attachment; filename=\"Owner Packet 04-01-2026-04-30-2026.zip\""

attachment; filename="Owner Packet {start}-{end}.zip"

Rentvine-Filename
string
Example: "Owner Packet 04-01-2026-04-30-2026.zip"

The archive's file name, as in Content-Disposition.

RateLimit-Policy
string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,...
Example: "\"account\";q=10000;w=60, \"user\";q=1200;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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/zip
string <binary>

Response samples

Content type
application/json
Example
{
  • "error": "Statement 999999999 not found"
}

Search Statement Batches

Searches statement batches, one page at a time, newest first (by creation time, then batch ID). Each row holds a summary of the batch under statementBatch, with the number of statements in it, and the batch's statement setting under statementSetting.

Use Cases

  • List the statement batches with their status and statement count
  • Find the batches waiting in Review, or still processing
  • Find the batches created in a date range

Business Rules

  • Filters combine with AND
  • search matches the batch's name, or the name of a portfolio in it or of one of that portfolio's owners, and finds a batch only when it holds a statement of a portfolio with at least one owner
  • A user restricted to portfolio groups sees only the batches holding at least one statement of a portfolio in those groups; statementCount still counts every statement in the batch
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • A date filter value that can't be read is ignored: the results aren't filtered by it; statementStatusIDs takes the listed integers only
  • Sorted by dateTimeCreated, newest first, then by statementBatchID, highest first, so batches created in the same second keep one order from page to page. No parameter changes the order
  • GET /portfolios/statements/batches/{statementBatchID} - One batch, with its statements
  • GET /portfolios/statements/search - Statements, filterable by batch
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). A value of 0 or below is read as 15. There is no upper limit.

search
string
Example: search=April

Text to find in the batch's name, or in the name of a portfolio in the batch or of one of its owners.

statementStatusIDs[]
Array of integers
Items Enum: 1 2 3 4 5
Example: statementStatusIDs[]=4

Only batches in any of these statuses. Send each as a separate statementStatusIDs[]=; a single statementStatusIDs= value also works.

  • 1 - Processing
  • 2 - Published
  • 3 - Failed
  • 4 - Review
  • 5 - Publishing
dateTimeCreatedMin
string
Example: dateTimeCreatedMin=2026-04-01

Only batches created on or after this date (YYYY-MM-DD or MM/DD/YYYY), from midnight in the account's time zone.

dateTimeCreatedMax
string
Example: dateTimeCreatedMax=2026-04-30

Only batches created before a cut-off this date sets (YYYY-MM-DD or MM/DD/YYYY): the date's next local midnight in the account's time zone, moved to UTC and cut back to that UTC day's 00:00. For an account west of UTC that is midnight UTC after this date, so batches from the last hours of this local day are left out; for an account east of UTC it is midnight UTC at the start of this date, so the whole day is left out.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Page size used on a page that holds items -- the requested pageSize (default 25), or the number of matching items when fewer 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 (1 for a value below 1), 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

A summary of the batch row, with its statement count.

required
object

The batch's statement setting; both fields are null when the batch has none (each statement then uses its portfolio's).

Response samples

Content type
application/json
[
  • {
    }
]

Get Statement Batch

Returns one statement batch under statementBatch, the full row. The statements include adds every statement in the batch, each with its statement setting, its portfolio and a restricted flag; the restrictions include says whether the user can reach all of the batch's portfolios.

Use Cases

  • Show a batch's status, period and combined-PDF progress
  • List the batch's statements with their portfolios and statuses

Business Rules

  • A well-formed ID with no batch answers 400
  • A user restricted to portfolio groups gets 403 unless the batch holds at least one statement of a portfolio in those groups, so a batch with no statements answers them 403 too
  • The statements include is documented for a user with no portfolio restriction; a user restricted to portfolio groups reads the batch's statements of their own portfolios through GET /portfolios/statements/search with statementBatchID
  • No role permission is checked: any API key can call it, within its portfolio restrictions
  • includes is a comma-separated list; unknown names are ignored

Available Includes (2)

  • statements - Every statement in the batch, newest end date first (then by statement ID), each with its statement setting, its portfolio and a restricted flag (0 for a user with no portfolio restriction); empty when the batch has none
  • restrictions - access: full when the user can reach every portfolio in the batch (always for an unrestricted user), partial otherwise
  • GET /portfolios/statements/batches/search - Statement batches, with filters
  • GET /portfolios/statements/search - Statements, filterable by statementBatchID
  • GET /portfolios/statements/{statementID} - One statement
Authorizations:
basicAuth
path Parameters
statementBatchID
required
integer
Example: 812

The ID of the statement batch to retrieve.

query Parameters
includes
string
Example: includes=statements,restrictions

Comma-separated list of related data to add to the response: 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

object

Whether the user can reach every portfolio in the batch. Requires the restrictions include.

Array of objects

Every statement in the batch. Requires the statements include.

Response samples

Content type
application/json
{
  • "statementBatch": {
    },
  • "restrictions": {
    },
  • "statements": [
    ]
}

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.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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, or token when none of them is.

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 (true/false and yes/no are read the same way as 1/0); 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. Send a pageSize and a page of at least 1.
  • To page through every unit, stop once pagination-current-page is at or past pagination-last-page.
  • propertyImage needs property as well: send them together.
  • Unknown include names are ignored, and names are not trimmed: send them without spaces (property, image drops image).

Available Includes (4)

  • property - the unit's property
  • image - the unit's primary image
  • propertyImage - the property's primary image (send it with property)
  • 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 >= 1
Example: 707

The property's ID, from GET /properties or GET /properties/search.

query Parameters
page
integer >= 1
Default: 1

The page number, at least 1 (default 1).

pageSize
integer >= 1
Default: 20
Example: pageSize=50

Items per page, at least 1 (default 20). Values above 5000 are served at 5000.

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, with no spaces: property, image, propertyImage (send it with property), propertyManager. Other values are ignored.

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; 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 none of property, image, propertyImage and propertyManager is included; 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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, owners and managementFeeSetting need property as well: send them together (without it, the first four are not sent). portfolioBalances needs property and portfolio, and leaseBalances needs lease and a current lease; without them they are not sent.
  • 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 (send it with 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, from GET /properties or GET /properties/search.

unitID
required
integer
Example: 585

The unit's ID, from GET /properties/{propertyID}/units.

query Parameters
includes
string
Example: includes=property,lease,listing

Comma-separated related records to add, with no spaces (property, lease drops lease): 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.

property_image (object) or null

The property's primary image, or null when its image row no longer exists. 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.

property_image (object) or null

The unit's primary image, or null when its image row no longer exists. 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.

object (included_management_fee_setting)

The property's management fee setting. Requires the property and managementFeeSetting includes.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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]+$

The first word of address when it is all digits, stored as a number, so leading zeros are dropped (09463 Oak Ln gives 9463); null when that word holds anything else (109/111 SE 2nd Ave, 123-A Main St).

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Your account's catalog of resident services: the Resident Experience add-ons you offer tenants, such as filter delivery, pest control, ID protection, credit reporting, group internet or resident rewards. Each is one of Rentvine's service types or a custom service you define, offered on its own or as part of a package. List, create, read, update and delete services. The catalog is account-wide: Pods don't limit it.

List Resident Services

Returns the account's whole REP service catalog (resident_services), each service under service, ordered by name.

Use Cases

  • Show the services a property manager can offer, with their status and pricing
  • Find the services available to add to a package or a lease (residentServiceStatusID=1)

Business Rules

  • Requires only authentication; no permission is checked.
  • Per-account configuration: portfolio restrictions don't apply, so a user restricted to portfolio groups sees the whole catalog.
  • Not paginated: every matching service is returned in one array, with no pagination headers.
  • search matches any part of the service name. Without filters, every service is returned whatever its status.
  • A filter is read by its digits: 3x filters on 3, while 0 and a value with no digits are ignored.
  • 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

Only services whose name contains this text.

residentServiceStatusID
string or integer (resident_service_statuses_request)
Enum: "1" "2" "3" 1 2 3
Example: residentServiceStatusID=1

Only services with this status. Read by its digits (1x is 1); 0 and a value with no digits are ignored.

serviceTypeID
string or integer (resident_service_types_request)
Enum: "1" "2" "3" "4" "5" "6" "7" 1 2 3 4 5 6 7
Example: serviceTypeID=3

Only services of this type. Read by its digits (3x is 3); 0 and a value with no digits 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
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
[
  • {
    },
  • {
    }
]

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the service.

serviceTypeID
required
string (resident_service_types)
Enum: "1" "2" "3" "4" "5" "6" "7"
  • 1 - Custom Service
  • 2 - Filter Delivery
  • 3 - Pest Control
  • 4 - ID Protection
  • 5 - Positive Credit Reporting
  • 6 - Group Internet
  • 7 - Resident Rewards
name
required
string <= 100 characters

Display name, unique within the account.

description
required
string or null <= 1000 characters

Optional resident-facing description of the service.

recurringChargeDescription
required
string or null <= 255 characters

Ledger-line text for the resident's recurring charge.

recurringChargeAccountID
required
string or null^-?[0-9]+$

GL account (chart-of-accounts) the recurring charge posts to, or null until the service is configured. Returned as the bare account ID; the response does not embed the account.

defaultRecurringChargeAmount
required
string <decimal>

Default monthly retail amount charged to the resident. Never negative; greater than $0.00 once the service is Active or Inactive.

salePrice
required
string <decimal>

Rentvine's wholesale rate for the service, per enrollment per month, maintained by Rentvine. 0.00 means Rentvine charges nothing for it.

residentServiceStatusID
required
string (resident_service_statuses)
Enum: "1" "2" "3"
  • 1 - Active
  • 2 - Inactive
  • 3 - Unconfigured
dateTimeCreated
required
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
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": "1",
  • "name": "Pest Control",
  • "description": "Monthly pest control treatment.",
  • "recurringChargeDescription": "Pest Control",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "8.00",
  • "salePrice": "4.25",
  • "residentServiceStatusID": "1",
  • "dateTimeCreated": "2026-06-01 12:00:00",
  • "dateTimeModified": "2026-06-01 12:00:00"
}

Get Resident Service

Returns one REP service from the account catalog: the service row itself, with no wrapper key.

Use Cases

  • Show a service's configuration: its status, pricing and the GL account its recurring charge posts to

Business Rules

  • Requires only authentication; no permission is checked.
  • Per-account configuration: portfolio restrictions don't apply.
  • A well-formed ID with no service, and an ID that isn't a whole number of digits, both answer the stock 404.
  • GET /resident/services - list the catalog
  • POST /resident/services/{residentServiceID} - update the service
  • DELETE /resident/services/{residentServiceID} - delete the service
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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the service.

serviceTypeID
required
string (resident_service_types)
Enum: "1" "2" "3" "4" "5" "6" "7"
  • 1 - Custom Service
  • 2 - Filter Delivery
  • 3 - Pest Control
  • 4 - ID Protection
  • 5 - Positive Credit Reporting
  • 6 - Group Internet
  • 7 - Resident Rewards
name
required
string <= 100 characters

Display name, unique within the account.

description
required
string or null <= 1000 characters

Optional resident-facing description of the service.

recurringChargeDescription
required
string or null <= 255 characters

Ledger-line text for the resident's recurring charge.

recurringChargeAccountID
required
string or null^-?[0-9]+$

GL account (chart-of-accounts) the recurring charge posts to, or null until the service is configured. Returned as the bare account ID; the response does not embed the account.

defaultRecurringChargeAmount
required
string <decimal>

Default monthly retail amount charged to the resident. Never negative; greater than $0.00 once the service is Active or Inactive.

salePrice
required
string <decimal>

Rentvine's wholesale rate for the service, per enrollment per month, maintained by Rentvine. 0.00 means Rentvine charges nothing for it.

residentServiceStatusID
required
string (resident_service_statuses)
Enum: "1" "2" "3"
  • 1 - Active
  • 2 - Inactive
  • 3 - Unconfigured
dateTimeCreated
required
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
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": "40",
  • "serviceTypeID": "1",
  • "name": "Contract Window Washing",
  • "description": "Soluta dolorum et maxime porro et nihil.",
  • "recurringChargeDescription": "ullam quidem aut",
  • "recurringChargeAccountID": "132",
  • "defaultRecurringChargeAmount": "17.70",
  • "salePrice": "4.25",
  • "residentServiceStatusID": "1",
  • "dateTimeCreated": "2026-11-16 19:26:37",
  • "dateTimeModified": "2026-11-16 19:26:37"
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the service.

serviceTypeID
required
string (resident_service_types)
Enum: "1" "2" "3" "4" "5" "6" "7"
  • 1 - Custom Service
  • 2 - Filter Delivery
  • 3 - Pest Control
  • 4 - ID Protection
  • 5 - Positive Credit Reporting
  • 6 - Group Internet
  • 7 - Resident Rewards
name
required
string <= 100 characters

Display name, unique within the account.

description
required
string or null <= 1000 characters

Optional resident-facing description of the service.

recurringChargeDescription
required
string or null <= 255 characters

Ledger-line text for the resident's recurring charge.

recurringChargeAccountID
required
string or null^-?[0-9]+$

GL account (chart-of-accounts) the recurring charge posts to, or null until the service is configured. Returned as the bare account ID; the response does not embed the account.

defaultRecurringChargeAmount
required
string <decimal>

Default monthly retail amount charged to the resident. Never negative; greater than $0.00 once the service is Active or Inactive.

salePrice
required
string <decimal>

Rentvine's wholesale rate for the service, per enrollment per month, maintained by Rentvine. 0.00 means Rentvine charges nothing for it.

residentServiceStatusID
required
string (resident_service_statuses)
Enum: "1" "2" "3"
  • 1 - Active
  • 2 - Inactive
  • 3 - Unconfigured
dateTimeCreated
required
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
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": "1",
  • "name": "Pest Control",
  • "description": "Monthly pest control treatment.",
  • "recurringChargeDescription": "Pest Control",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "8.00",
  • "salePrice": "4.25",
  • "residentServiceStatusID": "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the service.

serviceTypeID
required
string (resident_service_types)
Enum: "1" "2" "3" "4" "5" "6" "7"
  • 1 - Custom Service
  • 2 - Filter Delivery
  • 3 - Pest Control
  • 4 - ID Protection
  • 5 - Positive Credit Reporting
  • 6 - Group Internet
  • 7 - Resident Rewards
name
required
string <= 100 characters

Display name, unique within the account.

description
required
string or null <= 1000 characters

Optional resident-facing description of the service.

recurringChargeDescription
required
string or null <= 255 characters

Ledger-line text for the resident's recurring charge.

recurringChargeAccountID
required
string or null^-?[0-9]+$

GL account (chart-of-accounts) the recurring charge posts to, or null until the service is configured. Returned as the bare account ID; the response does not embed the account.

defaultRecurringChargeAmount
required
string <decimal>

Default monthly retail amount charged to the resident. Never negative; greater than $0.00 once the service is Active or Inactive.

salePrice
required
string <decimal>

Rentvine's wholesale rate for the service, per enrollment per month, maintained by Rentvine. 0.00 means Rentvine charges nothing for it.

residentServiceStatusID
required
string (resident_service_statuses)
Enum: "1" "2" "3"
  • 1 - Active
  • 2 - Inactive
  • 3 - Unconfigured
dateTimeCreated
required
string

Timestamp when the service was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
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": "1",
  • "name": "Pest Control",
  • "description": "Monthly pest control treatment.",
  • "recurringChargeDescription": "Pest Control",
  • "recurringChargeAccountID": "9",
  • "defaultRecurringChargeAmount": "8.00",
  • "salePrice": "4.25",
  • "residentServiceStatusID": "1",
  • "dateTimeCreated": "2026-06-01 12:00:00",
  • "dateTimeModified": "2026-06-01 12:00:00"
}

Resident Packages

Your account's resident packages: bundles of resident services that a lease bills as one recurring charge. List, create, read, update and delete packages. Packages are account-wide: Pods don't limit them.

List Resident Packages

Returns the account's whole REP package catalog (resident_packages), each package under package, ordered by name. Each package carries the services it bundles in package.services.

Use Cases

  • Show the packages a property manager offers, with the services in each
  • Find the active packages to offer on a lease (isActive=1)

Business Rules

  • Requires only authentication; no permission is checked.
  • Per-account configuration: portfolio restrictions don't apply, so a user restricted to portfolio groups sees the whole catalog.
  • Not paginated: every matching package is returned in one array, with no pagination headers.
  • search matches any part of the package name. Without isActive, active and inactive packages are both returned.
  • package.services is built from a JSON column: its IDs and amounts are JSON numbers, unlike the strings in the rest of the row.
  • POST /resident/packages - create a package
  • GET /resident/packages/{residentPackageID} - retrieve a single package, with each bundled service's full row through includes=packageServices
  • GET /resident/services - the services a package bundles
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Essentials

Only packages whose name contains this text.

isActive
integer
Enum: 0 1
Example: isActive=1

Only active packages (1) or only inactive ones (0). Omit it for both. Read by its digits, so any value with no digits, true and yes included, is read as 0 and returns only inactive packages.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

A package as the list returns it, with its services folded into the row.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns one REP package under package, whether it is the account's default package under isDefault, and the services it bundles when includes=packageServices is sent.

Use Cases

  • Show a package's configuration and whether new leases get it by default
  • Load the package's services, each with its membership row and the service's details, in the same request

Business Rules

  • Requires only authentication; no permission is checked.
  • Per-account configuration: portfolio restrictions don't apply.
  • isDefault is true when the package is the account's default package for leases.
  • A well-formed ID with no package, and an ID that isn't a whole number of digits, both answer the stock 404.
  • Unlike the list, package here has no services key: request the packageServices include for them.

Available Includes (1)

  • packageServices - the services the package bundles, ordered by membership row ID, each as packageService (the membership row) and service; an empty array when it bundles none
  • GET /resident/packages - list the catalog
  • POST /resident/packages/{residentPackageID} - update the package
  • DELETE /resident/packages/{residentPackageID} - delete the package
  • GET /resident/services/{residentServiceID} - a bundled service's full row, with its sale price
Authorizations:
basicAuth
path Parameters
residentPackageID
required
integer
Example: 1

ID of the resident package.

query Parameters
includes
string
Example: includes=packageServices

Related data to add: 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

isDefault
required
boolean

Whether the package is the account's default package for leases.

Array of objects (package_service_row)

The services the package bundles, ordered by membership row ID. Requires the packageServices include.

Response samples

Content type
application/json
{
  • "package": {
    },
  • "isDefault": true,
  • "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the package.

name
required
string <= 100 characters

Display name of the package, unique within the account.

recurringChargeDescription
required
string or null <= 255 characters

Ledger-line text for the resident's bundled recurring charge.

recurringChargeAccountID
required
string or null^-?[0-9]+$

GL account (chart-of-accounts) the bundled charge posts to, or null when none is set. Returned as the bare account ID; the response does not embed the account.

defaultRecurringChargeAmount
required
string <decimal>

Monthly retail amount charged to the resident for the bundle (must be greater than $0.00).

isActive
required
string
Enum: "0" "1"

Whether the PM offers this package (1 = active, 0 = inactive).

dateTimeCreated
required
string

Timestamp when the package was created. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeModified
required
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 number or a date it can't parse).
  • The latitude/longitude box applies only when all four of latitudeMin, latitudeMax, longitudeMin and longitudeMax are sent.
  • 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; a pageSize of 0 or below is read as 15. On a page that holds items, pagination-page-size reports the page size or the number of matching items, whichever is smaller.
  • To page through every match, stop once pagination-current-page is at or past pagination-last-page.
  • Sorted by orderBy (default unit.address), then propertyListingID. orderBy takes only the columns listed under it.
  • dateTimeModifiedMin and dateTimeModifiedMax are compared in UTC: send them in UTC.
  • 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; any other direction is read as asc); several are separated by commas. Use only the columns below. 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

Matches the listing's acceptDogs and acceptCats; a value that is null (unspecified) never counts as allowed or as refused.

  • 1 - Dogs allowed (acceptDogs 1)
  • 2 - Cats allowed (acceptCats 1)
  • 3 - Dogs and cats allowed (both 1)
  • 4 - No pets: both 0, so a listing with either one unspecified is left out
city
string
Example: city=Fort Myers

Substring match on the unit's city.

stateID
string
Example: stateID=FL

The unit's state code, matched as a whole code and regardless of case (fl matches FL); % and _ act as wildcards.

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
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 (from GET /portfolios/groups (undocumented)).

propertyGroupIDs[]
Array of integers
Example: propertyGroupIDs[]=1

Only listings of properties in one of these property groups (from GET /properties/groups (undocumented)).

propertyManagerIDs[]
Array of integers
Example: propertyManagerIDs[]=1

Only listings of units with one of these property manager records (from GET /properties/managers (undocumented)).

assignedToUserIDs[]
Array of integers
Example: assignedToUserIDs[]=2

Only listings of properties assigned to one of these users (from GET /users (undocumented)).

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 (the configured provider with isDefault 1 in GET /property/settings/showing-providers (undocumented)), 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, 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 listings 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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.jpg",
    "large": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/large.jpg"
  }
}

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.

The file name's extension is the image's own file type as it was uploaded (jpg, jpeg, png, gif and others; HEIC and JFIF uploads are converted to jpg), so build a URL only from a returned one, never by assuming .jpeg.

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 or /large).

size
required
string
Enum: "small" "large"
Example: small

small for the thumbnail version, large for the full-size version.

fileType
required
string
Example: jpg

The image's file extension, as it appears at the end of the image.small and image.large URLs.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema:
string <binary>

Response samples

Content type
application/json
{
  • "code": "429",
  • "error": "Too Many Requests",
  • "message": "Rate limit exceeded."
}

Email Conversations

Email threads Rentvine has sent and received about a record, such as a lease, a property or a contact. List a record's conversations, read one with its messages, and send an email, which starts a conversation or replies in one.

List Email Conversations

Lists the email conversations on one record (a lease, a contact, a work order and others), most recently updated first, each with its message count. Read one conversation's messages with GET /contacts/conversations/{id}.

Use Cases

  • Show the email threads of a lease or a contact
  • Find the threads that changed since a sync, by dateTimeUpdated
  • Pick the conversation whose messages to read next

Business Rules

  • Both objectTypeID and objectID are required: without either (or with 0) the request answers 400.
  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups gets a 403 (Access Denied) for a record outside its groups' portfolios. For most record types that are tied to a portfolio (leases, contacts, portfolios, work orders, applications, applicants and others), it also gets that 403 for a record that doesn't exist. An unrestricted key gets [] for a record with no conversations, whether the record exists or not.
  • Ordered by dateTimeUpdated, newest first; conversations whose dateTimeUpdated is 0000-00-00 00:00:00 come last.
  • Paging: 25 conversations per page by default, with no upper limit. A pageSize of 0 fails with a 500, and so does a negative one when anything matches (with no matches it answers []).
  • GET /contacts/conversations/{id} - one conversation, with its messages
  • POST /contacts/conversations - send an email, starting or continuing a conversation
Authorizations:
basicAuth
query Parameters
objectTypeID
required
integer >= 1
Example: objectTypeID=4

The type of the record whose conversations to list, as an object type ID (no lookup route): one of the types the manager portal's emails keep conversations on.

  • 3 - Contact (an owner, tenant, vendor, association or owner lead)
  • 4 - Lease
  • 11 - Portfolio
  • 16 - Work Order
  • 20 - Application
  • 21 - Applicant
  • 53 - Rent Increase
  • 55 - Lease Charge Notification
  • 79 - Screening Prospect
  • 88 - Lease Renewal
objectID
required
integer >= 1
Example: objectID=1050

The ID of the record, of the type objectTypeID names. Where to find it, by type:

  • 3 - a contact's ID from GET /tenants, GET /owners or GET /vendors
  • 4 - a lease's ID from GET /leases
  • 11 - a portfolio's ID from GET /portfolios
  • 16 - a work order's ID from GET /maintenance/work-orders
  • 20 - an application's ID from GET /screening/applications
  • 21 - an applicant's ID, in the applicants of GET /screening/applications/{applicationID}/summary
  • 53 - a rent increase's ID from GET /leases/rent-increases (undocumented)
  • 55 - a lease charge notification's ID (no lookup route)
  • 79 - a screening prospect's ID from GET /screening/prospects (undocumented)
  • 88 - a lease renewal's ID from GET /leases/renewals (undocumented)
page
integer
Default: 1

The page number for pagination

pageSize
integer >= 1
Default: 25
Example: pageSize=25

Conversations per page (default 25). There is no upper limit. Send 1 or more: 0 fails with a 500, and so does a negative value when anything matches.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

On a page with results: the page size in effect (the requested pageSize, default 25, no upper limit), or the number of matching conversations when that is smaller.

pagination-total-items
integer
Example: "2"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The conversation's ID (GET /contacts/conversations/{id}).

objectTypeID
required
string (object_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" "26" "27" "28" "29" "30" "31" "32" "33" "34" "35" "36" "37" "38" "39" "40" "41" "42" "43" "44" "45" "46" "47" "48" "49" "50" "51" "52" "53" "54" "55" "56" "57" "58" "59" "60" "61" "62" "63" "64" "65" "66" "67" "68" "69" "70" "71" "72" "73" "74" "75" "76" "77" "78" "79" "80" "81" "82" "83" "84" "85" "86" "87" "102" "88" "89" "90" "91" "92" "93" "94" "95" "96" "97" "98" "99" "100" "101" "103" "104" "105" "106" "107"
  • 1 - Account
  • 2 - User
  • 3 - Contact
  • 4 - Lease
  • 5 - Bill
  • 6 - Property
  • 7 - Unit
  • 8 - Deposit
  • 9 - Accounting Transaction
  • 10 - Accounting Transaction Entry
  • 11 - Portfolios
  • 12 - Accounting Payouts
  • 13 - Bank Adjustments
  • 14 - Company
  • 15 - Statement
  • 16 - Work Orders
  • 17 - Inspections
  • 18 - Inspection Areas
  • 19 - Inspection Items
  • 20 - Application
  • 21 - Applicant
  • 22 - Bank Transfer
  • 23 - Listing
  • 24 - Appliance
  • 25 - Text Message
  • 26 - Email Message
  • 27 - Work Order Estimate
  • 28 - Settlement
  • 29 - Lease Tenant
  • 30 - Email Template
  • 31 - Note
  • 32 - File Attachment
  • 33 - Invoice
  • 34 - Document Transaction
  • 35 - Document Envelope
  • 36 - Application Template
  • 37 - Recurring Bill
  • 38 - Chat Message
  • 39 - Reconciliation
  • 40 - Path
  • 41 - Accounting Payout Returns
  • 42 - Management Fee Setting
  • 43 - Additional Management Fee Setting
  • 44 - Accounting Setting
  • 45 - Posting Setting
  • 46 - Late Fee Setting
  • 47 - Statement Setting
  • 48 - Payout Batch
  • 49 - Letter
  • 50 - Reminder
  • 51 - Review
  • 52 - Landlord Verification
  • 53 - Rent Increase
  • 54 - Accounting Account
  • 55 - Lease Charge Notification
  • 56 - Started Application
  • 57 - Saved Report
  • 58 - Tag
  • 59 - Tag Object
  • 60 - Contact Phone
  • 61 - Contact Email
  • 62 - Contact Address
  • 63 - Vendor Type
  • 64 - Vendor Trade
  • 65 - Contact Vendor Trade
  • 66 - Portfolio Owner
  • 67 - Property Association
  • 68 - Occupant
  • 69 - Vehicle
  • 70 - Emergency Contact
  • 71 - Property Feature
  • 72 - Property Custom Feature
  • 73 - Property Portfolio
  • 74 - Work Order Project
  • 75 - Ledger
  • 76 - Portfolio Group
  • 77 - Screening Report
  • 78 - Screening Report Document
  • 79 - Screening Prospect
  • 80 - Screening Prospect Source
  • 81 - Lease Statement
  • 82 - Lease Statement Setting
  • 83 - Document Setting
  • 84 - PetScreening Pet
  • 85 - Lease Pet
  • 86 - Owner Lead
  • 87 - Additional Field Answer
  • 102 - Owner Lead Address
  • 88 - Lease Renewal
  • 89 - Reconciliation Bank Statement
  • 90 - Pending Reconciliation
  • 91 - Bulk Payment
  • 92 - Portal Invitation
  • 93 - Portal Account
  • 94 - Insurance Setting
  • 95 - Month-to-Month Premium Setting
  • 96 - Month-to-Month Premium Recurring Charge
  • 97 - Month-to-Month Premium One-Time Charge
  • 98 - Resident Package
  • 99 - Resident Service
  • 100 - Resident Service
  • 101 - Resident Package
  • 103 - Magic Link
  • 104 - Lease Recurring Charge
  • 105 - Access Point
  • 106 - Access Point Credential
  • 107 - Owner Lead Source
objectID
required
string^-?[0-9]+$

The ID of the record the conversation is on.

subject
required
string or null <= 300 characters

The thread's subject.

dateTimeCreated
required
string

When the conversation was started. UTC, formatted YYYY-MM-DD HH:MM:SS.

dateTimeUpdated
required
string

When the conversation last changed. UTC, formatted YYYY-MM-DD HH:MM:SS; some older conversations send 0000-00-00 00:00:00 instead of a date.

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

The number of messages in the conversation, as a string of digits.

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.
  • When creating a new conversation, objectTypeID must be a record type that can hold email (lease, contact, work order, application, owner lead, prospect, portfolio or renewal) and objectID must exist, else 400 (Invalid objectTypeID / Object not found).
  • sentByUserID sends the email as another manager: it is sent from them, shows them as the sender on the record's Messages tab, and replies thread back as usual. It is accepted only from an API key (403 otherwise) whose role holds the Contacts: Send Messages as Another User (API) permission (403 Permission Denied otherwise), and must name an active manager on the account (400 with {"sentByUserID": ["sentByUserID must be an active manager on this account"]} otherwise). Each such send is recorded in the account Activity Feed as the manager "(via {API user})". Omit it, or pass the API user's own ID, to send as the API user.
  • 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.

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

API keys only. The userID of an active manager on the account to send the email as, instead of the API user. Requires the Contacts: Send Messages as Another User (API) permission. See Business Rules.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Returns one email conversation. With includes=messages it also returns every message in it, newest first, each with its HTML body, its sender and its file attachments, and the conversation's recipients.

Use Cases

  • Render an email thread with its messages and attachments
  • Archive a conversation for record-keeping
  • Read the recipients before replying with POST /contacts/conversations

Business Rules

  • A well-formed ID with no conversation answers 400 (Email Conversation Not Found), for a key restricted to portfolio groups too; a value that isn't a number answers 404.
  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups gets a 403 (Access Denied) for a conversation on a record outside its groups' portfolios.
  • Without includes=messages, only emailConversation is returned.
  • With it, messages lists the messages newest first (by emailMessageID), and isPrimary is true on the first (the newest) only. Each message's html is read from file storage when the request runs: if any message's stored body can't be read, the whole request fails with a 500.

Available Includes (1)

  • messages - adds messages (each with message, fromRecipient and attachments) and recipients
  • GET /contacts/conversations - the conversations on a record
  • POST /contacts/conversations - send an email, starting or continuing a conversation
Authorizations:
basicAuth
path Parameters
id
required
integer
Example: 301

The conversation's ID (emailConversationID), from GET /contacts/conversations.

query Parameters
includes
string
Example: includes=messages

Comma-separated related data to add. Available: messages (which also adds recipients). Other 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (email_conversation)

An email thread on a record (a lease, a contact, a work order and others), as stored.

Array of objects (email_conversation_recipient)

Every participant in the conversation, removed ones included. Requires the messages include.

Array of objects

The conversation's messages, newest first; an empty list when it has none. Requires the messages include.

Response samples

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

Chat Messages

The chat on a work order, lease, portfolio, vendor or applicant, between your team and the tenants, owners, vendors or applicants on that record, who see it in their Rentvine portal. List a record's messages and post a new one.

List Chat Messages

Lists chat messages, newest first: the messages of one chat thread when chatObjectTypeID and objectID name it, else every thread's. A chat thread belongs to a work order, a lease, a portfolio, a vendor or an applicant, and holds the messages between the office and that record's tenants, cosigners, owners, vendor or applicant.

Reading a page marks it read for the office, as opening the thread in the manager portal does, unless markRead=false is sent (see Side Effects).

Use Cases

  • Render or archive the chat thread of a lease or a work order
  • Read a thread without clearing the office's unread state (markRead=false), for a sync or a notification bot
  • Filter a thread to the messages shared with one party (tenant, cosigner, owner, vendor)

Business Rules

  • Needs no permission: any API key on the account can call it, whatever its role.
  • A key restricted to portfolio groups must name the thread: without both chatObjectTypeID and objectID it gets a 400. It then gets a 403 (Access Denied) for a thread whose record is outside its groups' portfolios, or doesn't exist (a lease, work order or portfolio thread); vendor and applicant threads are checked through the contact and the applicant.
  • An unrestricted key may leave out chatObjectTypeID and objectID to list every thread's messages; a thread with no messages, or whose record doesn't exist, answers [].
  • Ordered newest first (by creation time, then by messageID).
  • search matches messages whose text contains it; the isSharedWith* filters match the message's sharing flag. Every filter narrows the result. The sharing flags follow the thread's type: a portfolio thread's messages are always shared with its owners and a vendor thread's with the vendor, and a party the thread's type doesn't include (an owner on a lease thread) is never shared with.
  • message.isRead and message.isReadByManager show the read state from before this call: a message this call marks read still shows 0 in this response.
  • Paging: 20 messages per page by default, with no upper limit; 0 or a negative pageSize is served at 15.

Side Effects

  • Unless markRead is false, 0 or no: every message on the returned page that the office hadn't read is marked read by the office (isReadByManager 1, as GET /chat/messages/{id} (undocumented) shows it), which clears it from the office's unread counts in the manager portal, and its entry in the record's activity feed is refreshed. Only the returned page is marked, and a failure to mark is ignored: the page is still returned.
  • POST /chat/messages - post a message to a thread
  • GET /chat/messages/stats (undocumented) - unread counts
Authorizations:
basicAuth
query Parameters
chatObjectTypeID
integer
Enum: 1 2 3 4 5
Example: chatObjectTypeID=2

The type of record the thread belongs to. With objectID, names one thread; required for a key restricted to portfolio groups.

  • 1 - Work Order
  • 2 - Lease
  • 3 - Portfolio
  • 4 - Vendor (objectID is the vendor's contact ID)
  • 5 - Applicant (objectID is the applicant's ID)
objectID
integer
Example: objectID=1050

The ID of the record the thread belongs to, of the type chatObjectTypeID names. Required for a key restricted to portfolio groups.

markRead
boolean
Default: true

Whether to mark the returned messages read by the office (default true). Send false (or 0, no) to read the thread without changing its unread state; any value that isn't one of true/false/1/0/yes/no counts as true.

search
string
Example: search=renew

Only messages whose text contains this string.

isSharedWithTenant
integer
Enum: 0 1
Example: isSharedWithTenant=1

1 for messages shared with the tenants only, 0 for messages not shared with them.

isSharedWithCosigner
integer
Enum: 0 1

1 for messages shared with the cosigners only, 0 for messages not shared with them.

isSharedWithVendor
integer
Enum: 0 1

1 for messages shared with the vendor only, 0 for messages not shared with it.

isSharedWithOwner
integer
Enum: 0 1

1 for messages shared with the owners only, 0 for messages not shared with them.

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 20
Example: pageSize=20

Messages per page (default 20). There is no upper limit; 0 or a negative value is served at 15.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

On a page with results: the page size in effect (the requested pageSize, default 20, no upper limit), or the number of matching messages when that is smaller.

pagination-total-items
integer
Example: "2"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The message itself.

required
object

The account user who sent the message. Every field is null when the user has no record on the account.

required
object

The contact who sent the message. Every field is null for a message from the office.

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} (undocumented) — 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} (undocumented) — 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

SMS text messages Rentvine sends and receives for your account. Send a text, and list the texts exchanged with one phone number.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Lists the text messages (SMS) sent to or received from one phone number, newest first.

The phoneNumber path parameter is the number's digits in E.164 form without the + (12025550101 for +1 202-555-0101): the API adds the + and matches messages whose from or to is exactly that number. A tenant's numbers are in GET /tenants/{contactID} with includes=phones, and each lease's tenants' primary numbers in GET /leases/export (lease.tenants[].phone).

Use Cases

  • Show the text conversation with a tenant, owner or vendor
  • Archive a phone number's text history
  • Find a message in a conversation (search)

Business Rules

  • Needs no permission.
  • Matches the number exactly: send the country code (1 for the US and Canada), and no spaces, dashes or +. A number with no messages answers []; 0 answers 400, and a value that isn't digits 404.
  • Ordered by dateTimeSent, newest first, with no tie-break: messages sent in the same second can come back in either order, and can move between pages from one request to the next.
  • search matches messages whose text contains it.
  • Paging: 15 messages per page by default, with no upper limit. A pageSize of 0 fails with a 500, and so does a negative one when anything matches (with no matches it answers []).
  • POST /messages/texts/send - send a text message
  • GET /messages/texts/phone/{phoneNumber}/load (undocumented) - the messages after a given one
Authorizations:
basicAuth
path Parameters
phoneNumber
required
integer
Example: 12025550101

The phone number's digits in E.164 form, without the + (12025550101).

query Parameters
search
string
Example: search=inspection

Only messages whose text contains this string.

page
integer
Default: 1

The page number for pagination

pageSize
integer >= 1
Default: 15
Example: pageSize=15

Messages per page (default 15). There is no upper limit. Send 1 or more: 0 fails with a 500, and so does a negative value when anything matches.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

On a page with results: the page size in effect (the requested pageSize, default 15, no upper limit), or the number of matching messages when that is smaller.

pagination-total-items
integer
Example: "2"

Total number of rows 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, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

The message's ID.

isInbound
required
string
Enum: "0" "1"

1 for a message the account received, 0 for one it sent.

from
required
string <= 100 characters

The sending number, in E.164 form.

to
required
string <= 100 characters

The receiving number, in E.164 form.

message
required
string or null

The message text, exactly as stored when it was sent or received; the API doesn't reformat it.

fileAttachments
required
string or null

The files sent with the message, as a JSON-encoded string (not an array): decode it to get a list of objects with fileAttachmentID, fileID, title, fileName, fileType and fileSize, each a string. null when the message has none.

sentByUserID
required
string or null^-?[0-9]+$

The office user who sent the message; null for a received message or one the system sent.

dateTimeSent
required
string

When the message was sent or received. UTC, formatted YYYY-MM-DD HH:MM:SS.

Response samples

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

Screening

Rental applications and tenant screening. List and read applications, read an application's summary and an applicant's answers, move an application through its statuses, order screening reports for its applicants, and read the account's screening settings.

Get Screening Settings

Returns the account's screening settings: who takes its rental applications, whether applicants can apply without a unit and with which template, how prospects are notified, and the rules for suggesting similar homes.

Use Cases

  • Check whether the Rentvine applicant portal is taking applications before sending prospects to it
  • Find the template used for applications without a unit
  • Read the similar-homes rules

Business Rules

  • Requires only authentication; no permission is checked. There are no portfolio restrictions: the settings belong to the account.
  • An account that has never saved its settings gets the defaults, as JSON numbers rather than the strings a saved record sends (the second schema).
  • GET /screening/templates - the application templates genericApplicationTemplateID names
  • GET /screening/applications - list applications
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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
One of
screeningSettingID
required
string
Value: "1"

Always 1; an account has one settings record.

applicationProviderID
required
string (application_providers)
Enum: "1" "2"

Who takes the account's rental applications:

  • 1 - Rentvine, through its applicant portal
  • 2 - Other, an outside application at applicationUrl
isApplicationEnabled
required
string
Enum: "0" "1"

Whether the Rentvine applicant portal takes applications. Always 0 while applicationProviderID is 2.

applicationUrl
required
string or null <= 500 characters

The outside application's address, used when applicationProviderID is 2, or null.

isGenericApplicationEnabled
required
string
Enum: "0" "1"

Whether applicants can apply without choosing a unit.

genericApplicationTemplateID
required
string or null^-?[0-9]+$

ID of the application template for applications without a unit, or null. Cleared when isGenericApplicationEnabled is switched off.

isAvailableUnitsOnly
required
string
Enum: "0" "1"

Whether applicants can only pick units marked available.

autoAssignApplicationFromProperty
required
string
Enum: "0" "1"

Whether an application submitted for a unit is assigned to the user its property is assigned to.

autoSendProspectConfirmationEmail
required
string
Enum: "0" "1"

Whether a new prospect (other than one a manager entered, or one without an email) gets an automatic thank-you email.

sendProspectNotificationForStartedApplications
required
string
Enum: "0" "1"

Whether managers are notified of prospects created when someone starts an application.

similarHomesEnabled
required
string
Enum: "0" "1"

Whether similar homes are suggested to households.

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

How far, in dollars, a similar home's rent may be from the unit's (0 to 5000).

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

How far away, in miles, a similar home may be (1 to 200).

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

How many bedrooms more or fewer a similar home may have (0 to 3).

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

How many bathrooms more or fewer a similar home may have (0 to 3).

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

How many homes are suggested to each household (1 to 10).

similarHomesIncomeToRentTarget
required
string <decimal>

The income-to-rent ratio a suggested home must fit (1 to 10, one decimal).

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

How many days a similar-home offer link lasts (1 to 60).

genericApplicationTemplateName
required
string or null

The name of the template genericApplicationTemplateID names, or null.

manualPaymentLedgerID
required
string or null^-?[0-9]+$

The corporate portfolio's ledger a Manual Payment's Other Receipt posts to, or null when not set.

manualPaymentChargeAccountID
required
string or null^-?[0-9]+$

The income account a Manual Payment's Other Receipt records the fee as, or null when not set.

manualPaymentBankAccountID
required
string or null^-?[0-9]+$

The bank account a Manual Payment's Other Receipt deposits to, or null for the portfolio's default bank account.

manualPaymentLedgerName
required
string or null

The name of the ledger manualPaymentLedgerID names, or null.

Response samples

Content type
application/json
Example
{
  • "screeningSettingID": "1",
  • "applicationProviderID": "1",
  • "isApplicationEnabled": "1",
  • "isGenericApplicationEnabled": "1",
  • "genericApplicationTemplateID": "434",
  • "isAvailableUnitsOnly": "1",
  • "autoAssignApplicationFromProperty": "0",
  • "autoSendProspectConfirmationEmail": "0",
  • "sendProspectNotificationForStartedApplications": "1",
  • "similarHomesEnabled": "1",
  • "similarHomesRentRange": "500",
  • "similarHomesRadiusMiles": "30",
  • "similarHomesBedsRange": "1",
  • "similarHomesBathsRange": "1",
  • "similarHomesSuggestionLimit": "3",
  • "similarHomesIncomeToRentTarget": "2.5",
  • "similarHomesOfferExpiresDays": "14",
  • "genericApplicationTemplateName": "Contract Generic Template",
  • "manualPaymentLedgerID": "61",
  • "manualPaymentChargeAccountID": "88",
  • "manualPaymentBankAccountID": null,
  • "manualPaymentLedgerName": "Corporate Ledger"
}

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. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Lists the account's rental applications, newest first, one page at a time. Each item carries the application, its status, the unit and property it was made for, and the lease made from it, each under its own key.

Use Cases

  • Show a queue of applications to review, filtered by status or assignee
  • Find the applications for one unit, property group or portfolio group
  • Sync applications into an outside leasing workflow, paging by dateTimeModifiedMin

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups sees the applications whose unit is in one of the groups' portfolios, plus every application with no unit; other applications are left out of the list and its counts.
  • An application with no applicant is never listed.
  • Sorted by dateTimeCreated, newest first; applications created in the same second come in applicationID order, lowest first.
  • Filters combine with AND. A value a single-value filter can't read (numberMin, numberMax, applicationStatusID or unitID that isn't a number, a boolean that isn't true/false/1/0/yes/no, a date it can't parse) is ignored, and the list comes back as if the filter weren't sent.
  • The list filters (the parameters ending in []) take one name[]= per value. A single value sent without the brackets is read as a list of one. Their values are used as sent, not checked: a value that isn't an ID matches no application (apart from the word null described under assignedToUserIDs[] and propertyAssignedToUserIDs[]), so it narrows the list instead of being ignored.
  • When the application has no unit, unit and property are still sent, with every field null; when no lease was made from it, lease is sent with leaseID, startDate and endDate null and tenants empty.
  • GET /screening/applications/{applicationID} - one application
  • GET /screening/applications/{applicationID}/summary - the review summary of one application
  • POST /screening/applications/{applicationID}/status - change an application's status
Authorizations:
basicAuth
query Parameters
page
integer
Default: 1
Example: page=1

Page number (default 1). A value below 1 is read as 1.

pageSize
integer
Default: 25
Example: pageSize=25

Items per page (default 25). There is no upper limit: a large value returns every match on one page. A value of 0 or below, or one that isn't a number, is read as 15.

search
string
Example: search=Example Way

Matches applications whose address, city, postal code or application number contains the text, whose state is exactly the text, or that have an applicant whose first or last name contains it. Case-insensitive.

primaryApplicationStatusIDs[]
Array of strings or integers (primary_application_statuses_request)
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8
Example: primaryApplicationStatusIDs[]=2&primaryApplicationStatusIDs[]=3

Only applications in any of these primary statuses. One primaryApplicationStatusIDs[]= per value.

applicationStatusID
integer
Example: applicationStatusID=2

Only applications in this status (an account status, from GET /screening/statuses (undocumented)). When sent, it replaces applicationStatusIDs[].

applicationStatusIDs[]
Array of integers
Example: applicationStatusIDs[]=2&applicationStatusIDs[]=6

Only applications in any of these statuses (account statuses, from GET /screening/statuses (undocumented)). One applicationStatusIDs[]= per value. Ignored when applicationStatusID is sent.

excludeUnassigned
boolean
Example: excludeUnassigned=true

true leaves out applications assigned to no user. false or absent lists them.

assignedToUserIDs[]
Array of strings[ items^([0-9]+|null)$ ]
Example: assignedToUserIDs[]=12

Only applications assigned to any of these users (from GET /users (undocumented)). One assignedToUserIDs[]= per value. When the first value is the word null, only applications assigned to no user are listed, and the other values are ignored.

propertyAssignedToUserIDs[]
Array of strings[ items^([0-9]+|null)$ ]
Example: propertyAssignedToUserIDs[]=12

Only applications whose property is assigned to any of these users (from GET /users (undocumented)). One propertyAssignedToUserIDs[]= per value. When the first value is the word null, only applications whose property is assigned to no user are listed, applications with no unit included, and the other values are ignored.

watcherUserIDs[]
Array of integers
Example: watcherUserIDs[]=12

Only applications watched by any of these users (from GET /users (undocumented)). One watcherUserIDs[]= per value.

numberMin
integer
Example: numberMin=100001

Only applications whose number is at least this.

numberMax
integer
Example: numberMax=100250

Only applications whose number is at most this.

dateTimeCreatedMin
string
Example: dateTimeCreatedMin=2026-01-01 00:00:00

Only applications created at or after this time, in UTC. Accepts YYYY-MM-DD HH:MM:SS, YYYY-MM-DDTHH:MM:SS or MM/DD/YYYY HH:MM:SS; a date alone means midnight.

dateTimeCreatedMax
string
Example: dateTimeCreatedMax=2026-12-31 23:59:59

Only applications created at or before this time, in UTC. Accepts the forms dateTimeCreatedMin does.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2026-11-01 00:00:00

Only applications last changed at or after this time, in UTC. Accepts the forms dateTimeCreatedMin does.

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2026-11-30 23:59:59

Only applications last changed at or before this time, in UTC. Accepts the forms dateTimeCreatedMin does.

unitID
integer
Example: unitID=229

Only applications for this unit (from GET /properties/{propertyID}/units).

unitIDs[]
Array of integers
Example: unitIDs[]=229&unitIDs[]=230

Only applications for any of these units. One unitIDs[]= per value.

hasLease
boolean

true lists only applications a lease was made from; false only those with none.

propertyGroupIDs[]
Array of integers
Example: propertyGroupIDs[]=3

Only applications whose property is in any of these property groups (from GET /properties/groups (undocumented)). One propertyGroupIDs[]= per value.

portfolioGroupIDs[]
Array of integers
Example: portfolioGroupIDs[]=2

Only applications whose property's portfolio is in any of these portfolio groups (from GET /portfolios/groups (undocumented)). One portfolioGroupIDs[]= per value.

Responses

Response Headers
pagination-page-size
integer
Example: "25"

Items per page. On a page with results, the requested pageSize (default 25), or the number of matches when that is smaller.

pagination-total-items
integer
Example: "84"

Total number of matching applications 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
Example: "2"

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: "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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The application.

required
object

The application's status.

required
object

The unit applied for; every field is null when the application has no unit.

required
object

The unit's property; every field is null when the application has no unit.

required
object

The lease made from the application; leaseID, startDate and endDate are null and tenants empty when there is none.

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 a 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 one rental application: the application record under application, and its status under status.

Use Cases

  • Read an application's status, assignee and the address applied for
  • Check an application before changing its status

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups can read an application whose unit is in one of the groups' portfolios, and any application with no unit. Another application answers 403.
  • An ID with no application answers 400 with Application not found.
  • GET /screening/applications - list applications
  • GET /screening/applications/{applicationID}/summary - the review summary, with each applicant's screening results
  • POST /screening/applications/{applicationID}/status - change the application's status
Authorizations:
basicAuth
path Parameters
applicationID
required
integer
Example: 641

The application'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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object (application)

A rental application: the address applied for, the unit when there is one, its status and who is assigned to review it. The applicants who filled it in are separate records.

required
object (application_status)

One of the account's application statuses. Each belongs to a built-in primary status; the built-in ones (isSystemStatus 1) exist on every account, and an account can add its own under any primary status.

Response samples

Content type
application/json
{
  • "application": {
    },
  • "status": {
    }
}

Get Application Summary

Returns the review summary of one application: the household's figures (rent, combined income, income ratio, applicants, occupants, animals and activity counts), every applicant with their screening tiles and weighted score, the co-applicants invited but not yet submitted (pendingApplicants), the screening packages ordered for it (legacyReports), and the account's screening report mode.

Use Cases

  • Show the application review screen
  • Check an applicant's screening steps (identity, income, credit, criminal, eviction, rental history) at a glance
  • Find each applicant's applicantID to read their form with GET /screening/applicants/{applicantID}/tab/application

Business Rules

  • Requires only authentication; no permission is checked for the summary itself.
  • A credit, criminal or eviction report that has been run shows on its tile as Restricted, with no badge, unless the caller holds the View Reports permission (Screening › ViewReports).
  • A user restricted to portfolio groups can read an application whose unit is in one of the groups' portfolios, and any application with no unit. Another application answers 403.
  • summary.rent is the unit's rent in whole dollars, "0" for a unit with no rent, and null when the application has no unit. summary.incomeRatio is combinedIncome divided by that rent, to two decimals with a comma between thousands (1,666.50); it is null when rent is null or "0". expectedRatio is always 2.5.
  • summary.requestedMoveIn is the earliest move-in date any applicant asked for, as Mon DD, YYYY, or -- when none did.
  • Only the last four digits of an applicant's Social Security number are returned.
  • scoringTemplate is an empty array when the application has no scoring template.
  • An ID with no application answers 400 with Application not found.
  • GET /screening/applications/{applicationID} - the application record alone
  • GET /screening/applicants/{applicantID}/tab/application - one applicant's application form
  • POST /screening/reports - order screening reports for applicants
  • POST /screening/applications/{applicationID}/status - change the application's status
Authorizations:
basicAuth
path Parameters
applicationID
required
integer
Example: 643

The application'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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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": {
    }
}

List Applicants

Lists applicants, the people on rental applications (an application has one or more), newest first. Each row has the address and rent applied for, the application's ID and number, and its status; names and contact details are in GET /screening/applicants/{applicantID}.

Use Cases

  • Finding the applicants on an application (applicationID) or for a unit (unitID, unitIDs[]).
  • Syncing applicants added or changed since a given time (dateTimeModifiedMin).

Business Rules

  • No permission is checked: any API key can list applicants.
  • A user restricted to portfolio groups sees only applicants on applications for a unit in one of their groups' portfolios, plus every application with no unit.
  • Filters combine with AND. A filter value the API can't read is ignored, except in unitIDs[], where a value that isn't a unit's ID simply matches nothing.
  • dateTimeCreatedMin and dateTimeCreatedMax take a date only; a value with a time is ignored like any unreadable value. The bound is midnight at the start of that day, so dateTimeCreatedMax=2025-06-15 leaves out an applicant created on June 15. dateTimeModifiedMin and dateTimeModifiedMax take a date and time, or a date alone (read as midnight).
  • pageSize has no cap. A page size of 0 or less is served at 15.
  • Sorted by dateTimeCreated, newest first, and by nothing else: applicants created in the same second come in no set order, which can move one between pages while paging. No parameter changes the order. To read every applicant a filter matches without that risk, ask for them in one page: pageSize has no cap, so send one at least pagination-total-items.
  • GET /screening/applicants/{applicantID} - Read one applicant in full.
  • GET /screening/applications - List the applications.
Authorizations:
basicAuth
query Parameters
search
string
Example: search=Estero

Text to look for. Matches part of the applicant's first name, last name, email, address, city or postal code, or the application's number, or the whole of the state code.

applicationID
integer
Example: applicationID=1702

Only the applicants on this application, from GET /screening/applications.

unitID
integer
Example: unitID=709

Only applicants for this unit, from GET /properties/{propertyID}/units. Replaces unitIDs[] when both are sent.

unitIDs[]
Array of integers
Example: unitIDs[]=709&unitIDs[]=710

Only applicants for any of these units. Send each as a separate unitIDs[]=.

dateTimeCreatedMin
string
Example: dateTimeCreatedMin=2026-11-01

Only applicants added on or after this date, YYYY-MM-DD or MM/DD/YYYY. A value with a time is ignored.

dateTimeCreatedMax
string
Example: dateTimeCreatedMax=2026-11-30

Only applicants added before the start of this date, YYYY-MM-DD or MM/DD/YYYY, so the day itself is left out. A value with a time is ignored.

dateTimeModifiedMin
string
Example: dateTimeModifiedMin=2026-11-01 00:00:00

Only applicants last changed at or after this time, YYYY-MM-DD HH:MM:SS (UTC) or a date alone (midnight).

dateTimeModifiedMax
string
Example: dateTimeModifiedMax=2026-11-30 23:59:59

Only applicants last changed at or before this time, YYYY-MM-DD HH:MM:SS (UTC) or a date alone (midnight).

page
integer
Default: 1

The page number for pagination

pageSize
integer
Default: 25

Items per page (default 25). There is no cap; 0 or a negative value is served at 15.

Responses

Response Headers
pagination-page-size
integer
Example: "2"

Page size used: the requested pageSize (default 25), or the total number of matching applicants when that is smaller; 15 when nothing matches.

pagination-total-items
integer
Example: "2"

Total number of matching applicants 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. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
required
object

The applicant's address applied for and rent.

required
object

The applicant's application.

required
object

The application's status.

Response samples

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

Get Applicant

Returns one applicant in full: their name and identifiers, the application form their template builds (builder), every answer they gave (applicantData), the addenda they signed, their income verification (transactions) and their identity verification (identityVerification). The answers include personal and financial details: date of birth, phone numbers, addresses, employers and salaries, the last four digits of a Social Security number, and an identity document's number.

Use Cases

  • Reviewing an applicant's application, with each answer labelled by the template's field labels.
  • Reading an applicant's verified income estimate and identity check results.

Business Rules

  • A user restricted to portfolio groups can read an applicant only when the application is for a unit in one of their groups' portfolios, or has no unit; otherwise 403 {"error": "Application 1702: Access Denied"} (with the application's ID).
  • An applicant ID that doesn't exist answers 400 {"error": "Applicant not found"}, not a 404. A path value that isn't a number answers the stock 404.
  • transactions and identityVerification send different keys for each status; their descriptions list them. Some statuses are sent as JSON numbers and the rest as strings.
  • When the identity check is still processing and the provider can't be reached, the read answers 400 with the body []. When the income report is still processing and the provider can't be reached, it answers 500.

Side Effects

  • When the income report or the identity check is still processing (or the identity check was resent), reading the applicant first fetches it from the provider (Plaid) and stores it, completed when it has finished.

From the code, not covered by a contract test:

  • A finished identity check's document and selfie images are downloaded from the provider and stored as files on the applicant.
  • The applicant's cached income or identity score, whichever report was refreshed, is cleared, so the next screening decision recomputes it.
  • POST /screening/applicants/{applicantID} - Change the applicant's answers.
  • GET /screening/applicants - Find an applicant.
  • GET /screening/applications/{applicationID} - Read the application.
Authorizations:
basicAuth
path Parameters
applicantID
required
integer
Example: 1664

ID 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
required
object

The applicant's identifiers and name.

required
object (application_builder)

The applicant's application template as the application form is built from it: its steps, each step's sections, each section's fields, and the addenda the applicant signs. Use it to label and order the values in applicantData: each section's name is a key there, and each field's name a key inside that section.

required
object (applicant_data)

The applicant's answers, one key per section of the template that is shown when the application is read (each builder section with includedForView 1), keyed by the section's name. Which sections appear, and the fields inside them, depend on the template.

  • A section of fields (applyingFor, leaseInfo, personalInfo, currentAddress, reviewSign) is an object of the fields that have a value, keyed by field name; fields with no value are left out, and a section with none is an empty list []. A Social Security number is shown as its last four digits (ssn).
  • A list section (vehicles, occupants, pets, employmentHistory and the like) is the list as stored: {"items": [...]}, each entry keyed by the section's field names; [] when the applicant has none.
  • questions and terms are lists of the applicant's answers and acceptances; [] when there are none.
required
Array of objects (applicant_addendum)

The addenda the applicant signed.

required
object (applicant_income_verification)

The applicant's income verification: a bank-transaction report from the provider (Plaid), the income it estimates, and the documents uploaded instead. Which keys are sent depends on statusID:

  • Not Enabled (4, sent as the number 4): statusID and verificationActive only.
  • Any status with no report stored (no provider token), usually Skipped or Resent (5, 6): plus files; a Resent one also hostedLinkUrl and dateTimeResent.
  • Failed (3): plus verificationErrors.
  • Processing (1): reading the applicant asks the provider for the report first, and answers with what it gets (a finished report arrives as Completed).
  • Completed (2): estimate, byMonth, movingAverage, transactions and accountInfo.
required
object (applicant_identity_verification)

The applicant's identity verification: a document and selfie check run by the provider (Plaid), and the documents uploaded instead. Which keys are sent depends on statusID:

  • Not Enabled (4, sent as the number 4), Failed (3): statusID and verificationActive only.
  • Any status with no check stored (no provider token), usually Skipped (5): plus files.
  • Processing (1) or Resent (6): reading the applicant asks the provider for the check first. A finished check arrives as Completed. A resent check the applicant hasn't finished arrives as the number 6 with identity only (no verificationActive).
  • Completed (2): identity, verificationActive and files. identity has the check results and the document's details, or, for a check that ended without a document, success false and the reasons.

Response samples

Content type
application/json
{
  • "applicant": {
    },
  • "builder": {
    },
  • "applicantData": {
    },
  • "addenda": [
    ],
  • "transactions": {
    },
  • "identityVerification": {
    }
}

Update Applicant

Changes an applicant's answers and returns the applicant's whole stored record. The body has the same shape as application in POST /screening/applications: one key per section of the template, named as in builder.

The update replaces the answers rather than merging them. Send every field the applicant should keep: in each section the template has on, a field the body leaves out is cleared, even in a section the body doesn't send. List sections are the exception: one the body leaves out keeps its entries, and one it sends replaces them. Sections the template has off are left as they are.

Use Cases

  • Correcting an applicant's contact details, address or employment before screening.
  • Adding a vehicle, an occupant or a pet to an applicant's application.

Business Rules

  • Requires the Modify Applications permission (Screening › ModifyApplications); without it the API answers 403 {"error": "Permission Denied"}.
  • A user restricted to portfolio groups can change an applicant only when the application is for a unit in one of their groups' portfolios, or has no unit; otherwise 403 {"error": "Application 1702: Access Denied"}.
  • The body is checked against the template as a manager-created application is: the four sections a template can't turn off (applyingFor, leaseInfo, personalInfo, currentAddress) and their required fields must be sent, so a body with one section is refused. Every error is reported at once, nested by section and field.
  • personalInfo.ssn is saved only for a key with the Manage Ssn permission (Screening › ManageSsn). Without it the SSN is skipped silently, and the rest of the update is saved. With it, an SSN that isn't nine digits answers 400 {"ssn": ["ssn is invalid"]}, and nothing is saved.
  • For an applicant on a unit, the address sent under applyingFor is replaced by the unit's address.
  • Numbers sent as JSON numbers (rent, deposit and the like) come back as JSON numbers in the response.
  • An applicant ID that doesn't exist answers 400 {"error": "Applicant not found"}, not a 404. A path value that isn't a number answers the stock 404.

Side Effects

  • The applicant's stored record is rewritten as described above, and its dateTimeModified set.

From the code, not covered by a contract test:

  • The applicant's contact record takes the new name, email and phone numbers; clearing the email removes the contact's email.
  • Landlord verifications still waiting for an answer are voided when their landlord's email changed.
  • An "Updated Applicant" entry is added to the application's log, an applicant update event is recorded, and the application's last-activity date is updated.
  • The applicant's cached rental-history and animals scores are cleared, so the next screening decision recomputes them.
  • GET /screening/applicants/{applicantID} - Read the applicant, with builder naming the sections and fields.
  • POST /screening/applications - Create an application, with the same application shape.
Authorizations:
basicAuth
path Parameters
applicantID
required
integer
Example: 1664

ID of the applicant to change.

Request Body schema: application/json
required

The applicant's answers. {} is refused as empty.

non-empty
required
object

The address applied for. Required; for an applicant on a unit (the applicant's unitID), the address sent is replaced by the unit's.

required
object (leaseInfo)

Lease Info.

required
object

Personal Info.

required
object (currentAddress)

Current Address.

object (emergencyContacts)

Emergency Contacts (a template can turn this section off).

object (references)

References (a template can turn this section off).

object (vehicles)

Vehicles (a template can turn this section off).

object (occupants)

Occupants (a template can turn this section off).

object

Animals (a template can turn this section off).

object (addressHistory)

Address History (a template can turn this section off).

object (employmentHistory)

Employment History.

object (income)

Other Sources of Income (a template can turn this section off).

object (bankAccounts)

Bank Accounts (a template can turn this section off).

object (creditCards)

Credit Cards (a template can turn this section off).

object (assistance)

Assistance (a template can turn this section off).

Array of objects (questions)

Answers to the template's questions, when its questions section is on. Each question's variableFieldID and label are in GET /screening/templates/{templateID}/submission (undocumented). Only the answers sent are checked; a question left out of the list isn't asked for.

Array of objects (terms)

Acceptances of the template's terms, when its terms section is on. Each term's variableFieldID and text are in GET /screening/templates/{templateID}/submission (undocumented). Only the acceptances sent are checked; a term left out of the list isn't asked for.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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
string or null^-?[0-9]+$

The applicant's number on the account, assigned when it is created.

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 when there is none.

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

The applicant's contact record, created with the application from its name, email and phones.

unitID
required
string or null^-?[0-9]+$

The unit applied for, as stored (the update can't change it); null for an application to an address.

countryID
required
string or null <= 2 characters

Country of the address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

address
required
string or null <= 100 characters

The address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

address2
required
string or null <= 100 characters

Second line of the address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

city
required
string or null <= 50 characters

City of the address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

stateID
required
string or null <= 3 characters

State of the address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

postalCode
required
string or null <= 20 characters

Postal code of the address applied for: the unit's address for an applicant on a unit, otherwise as sent under applyingFor.

rent
required
string or number or null <decimal>

Rent amount, as sent under leaseInfo: a JSON number when sent as one, otherwise a string.

deposit
required
string or number or null <decimal>

Security deposit, as sent: a JSON number when sent as one, otherwise a string; null when not sent.

moveInDate
required
string or null <date>

Move In Date, as sent under leaseInfo.moveInDate; null when not sent.

leaseMonths
required
string or number or null <= 100 characters

Length of the lease in months, as sent: a JSON number when sent as one, otherwise a string; null when not sent.

agentName
required
string or null <= 100 characters

Agent, as sent under leaseInfo.agentName; null when not sent.

agentContactInformation
required
string or null <= 100 characters

Contact Info, as sent under leaseInfo.agentContactInformation; null when not sent.

firstName
required
string or null <= 50 characters

First Name, as sent under personalInfo.firstName; null when not sent.

middleName
required
string or null <= 50 characters

Middle Name, as sent under personalInfo.middleName; null when not sent.

lastName
required
string or null <= 50 characters

Last Name, as sent under personalInfo.lastName; null when not sent.

email
required
string or null <= 75 characters

Email, as sent under personalInfo.email; null when not sent.

homePhone
required
string or null <= 20 characters

Home Phone, as sent under personalInfo.homePhone; null when not sent.

cellPhone
required
string or null <= 20 characters

Cell Phone, as sent under personalInfo.cellPhone; null when not sent.

workPhone
required
string or null <= 20 characters

Work Phone, as sent under personalInfo.workPhone; null when not sent.

birthDate
required
string or null <date>

Date of Birth, as sent under personalInfo.birthDate; null when not sent.

birthPlace
required
string or null <= 50 characters

Birth Place, as sent under 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 personalInfo.licenseNumber; null when not sent.

licenseState
required
string or null <= 50 characters

License State, as sent under personalInfo.licenseState; null when not sent.

passportID
required
string or null <= 50 characters

Passport #, as sent under personalInfo.passportID; null when not sent.

studentID
required
string or null <= 50 characters

Student #, as sent under personalInfo.studentID; null when not sent.

maidenName
required
string or null <= 50 characters

Maiden Name, as sent under personalInfo.maidenName; null when not sent.

height
required
string or null <= 25 characters

Height, as sent under personalInfo.height; null when not sent.

weight
required
string or null <= 25 characters

Weight, as sent under personalInfo.weight; null when not sent.

eyeColor
required
string or null <= 25 characters

Eye Color, as sent under personalInfo.eyeColor; null when not sent.

hairColor
required
string or null <= 25 characters

Hair Color, as sent under personalInfo.hairColor; null when not sent.

maritalStatus
required
string or null <= 200 characters

Marital Status, as sent under personalInfo.maritalStatus; null when not sent.

citizenship
required
string or null <= 100 characters

Citizenship, as sent under personalInfo.citizenship; null when not sent.

referredBy
required
string or null <= 1000 characters

How were you referred to us?, as sent under personalInfo.referredBy; null when not sent.

assistanceAgency
required
string or null <= 45 characters

Agency, as sent under assistance.assistanceAgency; null when not sent.

assistanceCounty
required
string or null <= 100 characters

County, as sent under assistance.assistanceCounty; null when not sent.

assistanceTechnician
required
string or null <= 100 characters

Technician, as sent under assistance.assistanceTechnician; null when not sent.

assistancePhone
required
string or null <= 20 characters

Phone, as sent under assistance.assistancePhone; null when not sent.

assistanceAmount
required
string or number or null <decimal>

Assistance amount, as sent when the template's assistance section is on: a JSON number when sent as one, otherwise a string; otherwise null.

assistanceUtility
required
string or null <= 200 characters

Utilities Included, as sent under assistance.assistanceUtility; null when not sent.

assistanceBeds
required
string or number or null^-?[0-9]+$

Bedrooms the assistance covers, as sent when the template's assistance section is on: a JSON number when sent as one, otherwise a string; otherwise null.

applicantType
required
string or null <= 200 characters

I Am The, as sent under personalInfo.applicantType; null when not sent.

primaryAddress
required
string or null <= 100 characters

Address, as sent under currentAddress.primaryAddress; null when not sent.

primaryAddress2
required
string or null <= 100 characters

Unit/Apt #, as sent under currentAddress.primaryAddress2; null when not sent.

primaryCity
required
string or null <= 100 characters

City, as sent under currentAddress.primaryCity; null when not sent.

primaryStateID
required
string or null <= 3 characters

State, as sent under currentAddress.primaryStateID; null when not sent.

primaryPostalCode
required
string or null <= 20 characters

Postal Code, as sent under currentAddress.primaryPostalCode; null when not sent.

primaryCountryID
required
string or null <= 2 characters

Country of the applicant's current address, a two-letter code, as sent under currentAddress.primaryCountryID; null when not sent.

primaryRentOwn
required
string or null <= 200 characters

Rent / Own, as sent under currentAddress.primaryRentOwn; null when not sent.

primaryMonthlyPayment
required
string or number or null^-?[0-9]+$

Monthly payment at the current address, as sent: a JSON number when sent as one, otherwise a string; null when not sent.

primaryMoveInDate
required
string or null <date>

Move In Date, as sent under currentAddress.primaryMoveInDate; null when not sent.

primaryManagerName
required
string or null <= 100 characters

Manager Name, as sent under currentAddress.primaryManagerName; null when not sent.

primaryManagerPhone
required
string or null <= 20 characters

Manager Phone, as sent under currentAddress.primaryManagerPhone; null when not sent.

primaryManagerEmail
required
string or null <= 75 characters

Manager Email, as sent under currentAddress.primaryManagerEmail; null when not sent.

primaryReasonForLeaving
required
string or null

Reason for Leaving, as sent under currentAddress.primaryReasonForLeaving; null when not sent.

signature
required
string or null <= 100 characters

The applicant's signature; null when there is none.

required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
required
null or object (applicant_stored_list)
questions
required
Array of objects or null

The answers to the template's questions, as sent under questions; null when there are none.

terms
required
Array of objects or null

The acceptances of the template's terms, as sent under terms; null when there are none.

addendumSignature
required
string or null <= 100 characters

The applicant's signature on the addenda; null when there is none.

addendumInitials
required
string or null <= 100 characters

The applicant's initials on the addenda; null when there is none.

incomeVerificationReportToken
required
string or null <= 200 characters

Income verification's report token; null when there is none.

required
verification_report_statuses (string) or null

Income verification status; null when there is none.

incomeVerificationReportData
required
object or null

The income report from the provider (Plaid), cut down to the keys a response may carry: transactions (the deposits found), accountInfo (the accounts read), bypass (set when the verification was skipped), and for a resent request hostedLinkUrl, linkToken, verificationToken and dateTimeResent; only those the stored report has. Null until the applicant runs it.

incomeVerificationReportError
required
object or string or null

The provider's error when the income report failed, as received; null otherwise.

required
verification_report_statuses (string) or null

Identity verification status; null when there is none.

identityVerificationReportData
required
object or null

The identity verification the provider returned (Plaid), as received: identity_verifications, each with its steps, document checks and the document's extracted data (type, number, expiration, issuing country). No fixed set of keys; null until the applicant runs it.

identityVerificationReportToken
required
string or null <= 200 characters

Identity verification's report token; null when there is none.

identityVerificationPlaidTemplate
required
string or null <= 200 characters

The identity verification template used; null when there is none.

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]+$

The started application in the applicant portal the applicant came from, or null.

creditReportDocumentID
required
string or null^-?[0-9]+$

The stored credit report document, or null when none has been run.

criminalReportDocumentID
required
string or null^-?[0-9]+$

The stored criminal background report document, or null when none has been run.

evictionReportDocumentID
required
string or null^-?[0-9]+$

The stored eviction report document, or null when none has been run.

Request samples

Content type
application/json
{
  • "applyingFor": {
    },
  • "leaseInfo": {
    },
  • "personalInfo": {
    },
  • "currentAddress": {
    },
  • "vehicles": {
    }
}

Response samples

Content type
application/json
{
  • "applicantID": "177",
  • "applicationID": "174",
  • "number": "100001",
  • "templateID": "83",
  • "userID": null,
  • "applicantContactID": "725",
  • "unitID": null,
  • "countryID": "US",
  • "address": "123 Main St",
  • "address2": null,
  • "city": "Springfield",
  • "stateID": "FL",
  • "postalCode": "12345",
  • "rent": "1650.00",
  • "deposit": "1650.00",
  • "moveInDate": "2026-12-01",
  • "leaseMonths": "12",
  • "agentName": null,
  • "agentContactInformation": null,
  • "firstName": "Jane",
  • "middleName": "Q",
  • "lastName": "Doe",
  • "email": "jane.doe@example.com",
  • "homePhone": null,
  • "cellPhone": "+12395550100",
  • "workPhone": null,
  • "birthDate": "1990-01-01",
  • "birthPlace": null,
  • "ssnCiphertextID": null,
  • "ssnTruncated": null,
  • "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": "123 Main St",
  • "primaryAddress2": null,
  • "primaryCity": "Springfield",
  • "primaryStateID": "FL",
  • "primaryPostalCode": "12345",
  • "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": null,
  • "income": null,
  • "occupants": {
    },
  • "pets": {
    },
  • "references": null,
  • "vehicles": {
    },
  • "questions": null,
  • "terms": null,
  • "addendumSignature": null,
  • "addendumInitials": null,
  • "incomeVerificationReportToken": "f3c9a72a-3908-32db-b990-815088260d08",
  • "incomeVerificationReportStatusID": "2",
  • "incomeVerificationReportData": {
    },
  • "incomeVerificationReportError": null,
  • "identityVerificationReportStatusID": "2",
  • "identityVerificationReportData": {
    },
  • "identityVerificationReportToken": "idv-token-123",
  • "identityVerificationPlaidTemplate": null,
  • "dateTimeCreated": "2026-11-16 20:18:04",
  • "dateTimeModified": "2026-11-16 20:18:04",
  • "startedApplicationID": null,
  • "creditReportDocumentID": null,
  • "criminalReportDocumentID": null,
  • "evictionReportDocumentID": null
}

Get Applicant Application Tab

Returns what one applicant entered on the application form: their contact, identity and address details, the lists they filled in (prior addresses, employers, occupants, vehicles), every section's answers under applicantData, the layout of the template they used under builder, and the addenda they signed.

Use Cases

  • Show an applicant's submitted application on a review screen
  • Read the employment and address history to underwrite an application

Business Rules

  • Requires only authentication; no permission is checked.
  • A user restricted to portfolio groups can read an applicant whose application's unit is in one of the groups' portfolios, or whose application has no unit. Another applicant answers 403.
  • Only the last four digits of the Social Security number are returned. With them on file they come as ssn; without, the response carries ssnTruncated as null instead, and no ssn.
  • An ID with no applicant answers 400 with Applicant not found. A 400 also comes when the applicant's application is missing (Application not found) or building the tab fails (the failure's message).
  • GET /screening/applications/{applicationID}/summary - every applicant of an application, with their screening results
  • GET /screening/applications/{applicationID} - the application
Authorizations:
basicAuth
path Parameters
applicantID
required
integer
Example: 765

The applicant's ID, from applicants[].applicantID of GET /screening/applications/{applicationID}/summary.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier of the applicant.

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

ID of the application the applicant is on.

number
required
string or null^-?[0-9]+$

The applicant's reference number.

userID
required
string or null^-?[0-9]+$

ID of the applicant's portal user, or null for an applicant a manager entered.

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

ID of the contact made for the applicant.

unitID
required
string or null^-?[0-9]+$

ID of the unit applied for, or null.

countryID
required
string or null <= 2 characters

Two-letter country code of the address applied for.

address
required
string or null <= 100 characters

Street address applied for.

address2
required
string or null <= 100 characters
city
required
string or null <= 50 characters
stateID
required
string or null <= 3 characters
postalCode
required
string or null <= 20 characters
moveInDate
required
string or null

The move-in date the applicant asked for, YYYY-MM-DD. Some older applicants carry the zero date 0000-00-00, so the value isn't always a valid date.

leaseMonths
required
string or null <= 100 characters

The lease length the applicant asked for, as entered.

firstName
required
string or null <= 50 characters
middleName
required
string or null <= 50 characters
lastName
required
string or null <= 50 characters
email
required
string or null <= 75 characters
homePhone
required
string or null <= 20 characters

Phone number in E.164 form (+12395550101).

cellPhone
required
string or null <= 20 characters

Phone number in E.164 form.

workPhone
required
string or null <= 20 characters

Phone number in E.164 form.

birthDate
required
string or null <date>
licenseNumber
required
string or null <= 50 characters

Driver's license number.

licenseState
required
string or null <= 50 characters

The state that issued the driver's license.

applicantType
required
string or null <= 200 characters

The applicant's role on the application as they chose it on the form (such as Applicant), or null.

required
object or string or null (applicant_address_history)

The prior addresses the applicant listed on the application form, as the form stored them: items holds one entry per row and maxID the highest _id handed out so far. null when the applicant listed none. Some older applicants' lists were stored as JSON text and come back as that text, a string, rather than decoded.

required
object or string or null (applicant_employment_history)

The employers the applicant listed on the application form, as the form stored them: items holds one entry per row and maxID the highest _id handed out so far. null when the applicant listed none. Some older applicants' lists were stored as JSON text and come back as that text, a string, rather than decoded.

required
object or string or null (applicant_occupants)

The other occupants the applicant listed on the application form, as the form stored them: items holds one entry per row and maxID the highest _id handed out so far. null when the applicant listed none. Some older applicants' lists were stored as JSON text and come back as that text, a string, rather than decoded.

required
object or string or null (applicant_vehicles)

The vehicles the applicant listed on the application form, as the form stored them: items holds one entry per row and maxID the highest _id handed out so far. null when the applicant listed none. Some older applicants' lists were stored as JSON text and come back as that text, a string, rather than decoded.

required
object (application_form_builder)

The layout of the application template the applicant filled in: its sections in order, each with its groups of fields. Only the sections shown on the review screen are listed, and in each only the active fields (a group with none is left out).

required
object

The applicant's answers, one key per section of the application form (applyingFor, leaseInfo, personalInfo, employmentHistory and the rest; the same keys as builder.sections[].name, plus sections the template has switched off), and addenda. A section the applicant answered is an object: the field names and their answers for a one-entry section, or items (and usually maxID) for a multi-entry one, as in employmentHistory. questions and terms are lists instead. A section with no answers is an empty array. Some older applicants' sections were stored as JSON text, and come back as that text, a string, rather than decoded.

petScreeningEnabled
required
boolean

Whether the applicant's pets are screened through PetScreening.

required
object or null

The applicant's PetScreening status, or null for an applicant with no portal user. Before any PetScreening activity, profiles is empty.

ssn
string <= 20 characters

The last four digits of the applicant's Social Security number. Sent only when they are on file; otherwise ssnTruncated is sent instead.

ssnTruncated
null

Sent, always null, only when no Social Security number digits are on file; ssn is sent instead when they are.

Response samples

Content type
application/json
{
  • "applicantID": "765",
  • "applicationID": "853",
  • "number": "100001",
  • "userID": "874",
  • "applicantContactID": "821",
  • "unitID": "838",
  • "countryID": "US",
  • "address": "123 Main St",
  • "address2": "Apt 4",
  • "city": "Springfield",
  • "stateID": "FL",
  • "postalCode": "12345",
  • "moveInDate": "2026-12-15",
  • "leaseMonths": "12",
  • "firstName": "Jane",
  • "middleName": "Q",
  • "lastName": "Doe",
  • "email": "jane.doe@example.com",
  • "homePhone": "555-0100",
  • "cellPhone": "555-0100",
  • "workPhone": "555-0100",
  • "birthDate": "1990-01-01",
  • "licenseNumber": "X0000000",
  • "licenseState": "FL",
  • "applicantType": "Applicant",
  • "addressHistory": {
    },
  • "employmentHistory": {
    },
  • "occupants": {
    },
  • "vehicles": {
    },
  • "ssn": "1234",
  • "builder": {
    },
  • "applicantData": {
    },
  • "petScreeningEnabled": false,
  • "petscreeningData": {}
}

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Custom fields are the extra fields your account defines for a kind of record (a lease, a property, an owner and so on), grouped into categories. List the kinds of record that take custom fields, read the categories and fields defined for one, create a category, and read or save one record's custom field values.

List Custom Field Object Types

Returns every record type custom fields can be added to (owners, tenants, leases, properties and the others), each with how many custom field categories and custom fields the account has set up for it. The record types are fixed: this list always holds the same twelve entries, in the same order.

Use Cases

  • Find the customFieldCategoryObjectTypeID values to use with POST /custom-field-categories, GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} and the values endpoints
  • Show how many categories and fields are set up for each record type

Business Rules

  • Requires only authentication; no permission is checked.
  • Every record type is listed, including those with no categories, whose counts are "0".
  • customFieldCategoryObjectTypeID is a JSON number here, unlike the string the rest of the API sends for it.
  • categoryCount counts the type's categories; fieldCount counts its custom fields across those categories.
  • Not paginated: the whole list is returned in one array, with no pagination headers.
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} - list one record type's categories and fields
  • POST /custom-field-categories - create a category for one of these record types
  • GET /custom-fields/values/{objectTypeID}/{objectID} - read one record's custom field values
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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

Response Schema: application/json
Array
customFieldCategoryObjectTypeID
required
integer
Enum: 1 2 3 4 5 6 8 9 10 11 12 13

The record type, as a JSON number.

  • 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
categoryCount
required
string^[0-9]+$

How many custom field categories the account has for this record type.

fieldCount
required
string^[0-9]+$

How many custom fields the account has for this record type, across its categories.

Response samples

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

Get Custom Field Categories by Object Type

Returns one record type's custom field categories, each with its custom fields under customFields: the field definitions only, with no record's values. GET /custom-fields/values/{objectTypeID}/{objectID} returns the same categories and fields with one record's values.

Use Cases

  • Load the categories and fields set up for a record type before reading or writing a record's values
  • Find each field's customFieldID, its type and its settings (a dropdown's options)

Business Rules

  • Requires only authentication; no permission is checked.
  • Categories are ordered by their orderIndex, and each category's fields by theirs.
  • A category with no fields has an empty customFields array.
  • A record type with no categories, or a number that is no record type, answers an empty array. An ID that isn't a whole number of digits answers the stock 404.
  • GET /custom-field-category-object-types - list the record types
  • GET /custom-fields/values/{objectTypeID}/{objectID} - read one record's custom field values
  • POST /custom-fields/values/{objectTypeID}/{objectID} - save one record's custom field values
  • POST /custom-field-categories - create a category for this record type
Authorizations:
basicAuth
path Parameters
customFieldCategoryObjectTypeID
required
integer
Example: 5

The record type, 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the custom field category.

customFieldCategoryObjectTypeID
required
string (custom_field_category_object_types)
Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13"
  • 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

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 (custom_field)

The category's custom fields, ordered by their orderIndex. 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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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 a record type's custom field categories, each with its fields under fields, and each field's value for one record under value.

Use Cases

  • Show a property's, lease's or contact's custom field values, grouped by category
  • Read one category's values with customFieldCategoryID

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 property's, unit's, lease's, listing's, work order's or portfolio's values only when the record is in a portfolio of those groups. For the contact record types (owner, tenant, vendor, association, maintenance technician) the contact's own type decides, whatever type the path names: an owner or tenant follows the contact restriction of GET /owners/{contactID} and GET /tenants/{contactID}, and a vendor, association or maintenance technician is served. For all these record types, an ID with no record is refused too. A refusal is a 403 {"error": "Access Denied"}.
  • The record isn't otherwise looked up: for a user with no portfolio restrictions, an objectID with no record (or one with no saved values) answers its categories and fields with every value null.
  • Categories are ordered by their orderIndex, and each category's fields by theirs.
  • A record type with no categories, or a number that is no record type, answers an empty array. A path value that isn't a whole number of digits answers the stock 404.
  • POST /custom-fields/values/{objectTypeID}/{objectID} - save the record's custom field values
  • GET /custom-field-category-object-types - list the record types
  • GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} - list a record type's categories and fields, without values
Authorizations:
basicAuth
path Parameters
objectTypeID
required
integer
Example: 5

The record type, as customFieldCategoryObjectTypeID from GET /custom-field-category-object-types (not an object type ID used elsewhere in the API).

  • 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
objectID
required
integer
Example: 577

The record's ID (a property ID for record type 5, a lease ID for 4, a contact ID for the contact types).

query Parameters
customFieldCategoryID
integer
Example: customFieldCategoryID=12

Only this category, from GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID}. Read by its digits, so a value with no digits is read as 0 and matches no category (the response is then []).

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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

Unique identifier for the custom field category.

customFieldCategoryObjectTypeID
required
string (custom_field_category_object_types)
Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13"
  • 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

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

The category's custom fields, ordered by their orderIndex, each with the record's value.

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 "endpoint" on an operation with a limit of its own, but not "ip", although the per-IP limit counted it too. The list can carry other items (a few undocumented routes add their own): read the ones you know and ignore the rest. A request the API answers before sign-in (a 401, a path no route matches) lists only "ip". A response sent with no limit counted 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", "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.

X-Request-ID
string <uuid>
Example: "01a1eaeb-e38d-71f1-9fbf-a43bcc163a42"

The ID Rentvine gave this request, a UUID, on every response the API sends, errors included; a new one for every request, whatever X-Request-ID you send. Rentvine records it with the errors it reports, the log lines the request writes and the change history of the records it changes, so log it beside each request you send and quote it (with the time you sent the request) when you contact Rentvine support about a 500 or a change. A 500 repeats it in the body as requestID (Errors). A response sent from in front of the API, such as a 502 or 504 from the gateway, doesn't carry it, though the request may still have run.

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
[
  • {
    }
]