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 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.
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.
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).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."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.{"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 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.200 as if the parameter hadn't been sent, with the operation's default filters still applied. Check filter names against the operation.__rv_api__ session cookie; you don't need to store it or send it back.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.
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.
ℹ️ Create the role first, on the Roles tab, with only the permissions your integration needs.
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.
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.
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.
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.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.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.
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.
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.
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.
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.
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.
The 429 carries Retry-After, the seconds to wait before sending the request again, plus the two headers above. Recognise a 429 by its status.
A refused request isn't counted against the limit that refused it or any other limit counted after sign-in, but every request is counted against the per-IP limit before anything else, refused ones included, unless the per-IP limit itself refused it.
RateLimit on every response. The item with the lowest r is the limit that refuses your next request to that operation first; slow down before it reaches 0 instead of waiting for the 429. Keep an eye on account too: everyone on your account draws on it.Retry-After seconds, then retry the same request. It wasn't run, so retrying is safe, even for a write. For a per-minute limit Retry-After can be longer than the time left in the minute; waiting for it is always enough.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:
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.
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.
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 |
|---|---|
| 1 | Account |
| 2 | User |
| 3 | Contact |
| 4 | Lease |
| 5 | Bill |
| 6 | Property |
| 7 | Unit |
| 8 | Deposit |
| 9 | Accounting Transaction |
| 10 | Accounting Transaction Entry |
| 11 | Portfolio |
| 12 | Payout |
| 13 | Bank Adjustment |
| 14 | Company |
| 15 | Statement |
| 16 | Work Order |
| 17 | Inspection |
| 18 | Inspection Area |
| 19 | Inspection Item |
| 20 | Application |
| 21 | Applicant |
| 22 | Bank Transfer |
| 23 | Listing |
| 24 | Appliance |
| 25 | Text Message |
| 26 | Email Message |
| 27 | Work Order Estimate |
| 28 | Settlement |
| 29 | Lease Tenant |
| 30 | Email Template |
| 31 | Note |
| 32 | File Attachment |
| 33 | Invoice |
| 34 | Document Transaction |
| 35 | Document Envelope |
| 36 | Application Template |
| 37 | Recurring Bill |
| 38 | Chat Message |
| 39 | Reconciliation |
| 40 | Path |
| 41 | Payout Return |
| 42 | Management Fee Setting |
| 43 | Additional Management Fee Setting |
| 44 | Accounting Setting |
| 45 | Posting Setting |
| 46 | Late Fee Setting |
| 47 | Statement Setting |
| 48 | Payout Batch |
| 49 | Letter |
| 50 | Reminder |
| 51 | Review |
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.
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.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.404 with {"error": "No Account Found"} instead of the plain-text No Account Found.Reference only.
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 are
internal health checks, not part of the supported API, and are no longer documented. Don't build integrations on
them.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.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.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.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.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.
RateLimit-Policy and RateLimit headers, the 429 and its Retry-After, and how to back off.
Every operation now documents the 429 response, and every response the two headers.POST /accounting/accounts; GET, POST and PUT /accounting/accounts/{accountID}; and
GET /accounting/bank-accounts.GET and POST /accounting/reconciliations; GET and
DELETE /accounting/reconciliations/{reconciliationID}, where DELETE voids the reconciliation;
GET /accounting/transactions/{transactionID}; and POST /accounting/transactions/{transactionID}/reconcile
and /unreconcile.DELETE on /accounting/leases/charges/{transactionID}, /payments/{transactionID},
/credits/{transactionID}, /refunded-returns/{transactionID} and /deposit-release-credits/{transactionID},
each of which voids the transaction (it keeps its history; nothing is deleted);
POST /accounting/leases/payments/{transactionID}/return; and
POST /accounting/leases/{leaseID}/refunded-returns, /deposit-release-credits and /payouts.GET and POST /leases/{leaseID}/pets, and GET, POST and
DELETE /leases/{leaseID}/pets/{leasePetID}.GET /files, GET /files/search, and GET, POST and DELETE /files/{fileID}.DELETE /custom-fields/{customFieldID} and
DELETE /custom-field-categories/{customFieldCategoryID}. Deleting a field clears its value on every record;
deleting a category deletes every field in it.POST /screening/applications creates an application from one of the account's templates, which
GET /screening/templates lists.PUT /accounting/deposits/{depositID} and PUT /properties/{propertyID}/units/{unitID}, which do the same as
the POST on the same path.GET /properties/{propertyID}/units returns each unit under unit, and documents page, pageSize, search,
isActive and includes. GET /properties/{propertyID}/units/{unitID} returns the unit under unit, beside
the related records includes asks for. The reference had shown bare unit objects.leaseBalances and portfolioBalances includes are objects, not arrays.GET /properties pages 15 items by default, not 25.DELETE /properties/{propertyID} or DELETE /properties/{propertyID}/units/{unitID} is refused because
of the property's or unit's history, the 400 has one key per kind of record that blocks it, for example
{"leases": ["..."]}, or unit.applications for a unit of the property; the reference had listed only
transactions. An ID with no property or unit returns 400 {"error": "Property {propertyID} not found"}
(or Unit), and an ID that isn't a number returns 404.POST /properties/{propertyID} doesn't change portfolioID or isMultiUnit; the reference had listed them in
the request body.activateUnit on POST /properties/{propertyID}/activate is 0 or 1.POST /properties/{propertyID}/units requires address, city and stateID.GET /properties/listings/search excludes property types with notPropertyTypeID[]; the reference had named it
notPropertyTypeIDs.GET /properties/search now also documents propertyIDs[], propertyManagerIDs[], city, stateID,
postalCode, dateTimeModifiedMin, dateTimeModifiedMax and orderBy.GET /owners, /tenants, /vendors, /associations and /maintenance-technicians is
{"contact": {...}, "token": "..."}. The reference had shown GET /owners items as bare contacts, and no list
included token./search operations carries search.rank when search is sent.GET /owners/{contactID}, /tenants/{contactID}, /vendors/{contactID},
/associations/{contactID} and /maintenance-technicians/{contactID} also includes isTaxIdentifierValid,
taxIdentifierTypeID and taxIdentifierCountryID. An ID with no contact of that type returns 400, for
example {"error": "Owner {contactID} not found"}; an ID that isn't a number returns 404. A vendor's
reviewStats is an array.0 or 1, and array filters are named with brackets, for example contactIDs[]. The
search operations document the tax identifier filters (hasTaxIdentifier, isTaxIdentifierValid,
taxIdentifierTypeIDs[] and hasDuplicateTaxIdentifier).GET /vendors/search takes no includes, and GET /owners/search has no insurance expiry filters; the
reference had listed both.GET /accounting/ledgers needs search or ledgerIDs[]; without either it returns a 400 whose body is the
JSON string "Search Failed".depositNumber in the body of POST /accounting/deposits/{depositID} is a string, not null, and the
operation documents its 404.Reference only.
Response types match what the API sends. Response fields are now documented with the JSON types the API returns:
"117"."0" and "1"."1600.00".YYYY-MM-DD HH:MM:SS, and dates are YYYY-MM-DD. These rules cover values read from the database. A value the API computes keeps the type its field documents:
for example, a lease's rentAmount and a predicted invoice line item's amount are numbers. Request bodies
accept either the string or the number form. Path parameters such as {propertyID} are unchanged.
Fields that changed shape.
addressValidationData on a property or unit, and diagnosticSummary on a bill's work order, are objects
(or null), not strings.lineItems of GET /accounting/invoices/{invoiceID} take one of two shapes. An invoice created in
Rentvine returns rows with invoiceLineItemID and a string amount; any other invoice returns predicted
items with no invoiceLineItemID, and amount, unitPrice and quantity as numbers or null. Check for
invoiceLineItemID before reading amount.Enumerated fields list every value. Most status and type fields that reference a shared list of values now
document those values as the strings the API sends, with their current labels. Values added to the lists
include property type 11 (Lot), work order primary status 5 (Cancelled), contact types 7 (Screening
Prospect), 8 (Internal Technician) and 9 (Owner Lead), source type 7 (Ai) and transaction type 25 (Lease
Refunded Return). payoutTypeID 1 is Other (paid outside Rentvine); the reference had called it Cash.
Error responses. A 400 is documented as either a single message, {"error": "..."}, or a map of
validation messages keyed by field. A 403 documents each body the API sends, including the
ELEVATION_REQUIRED error and the empty body some checks return. A 401 is
{"code": 401, "error": "..."}, with code a number; the 29 operations that documented no error response now
document it. A 404 from the resident services and packages operations is
{"code": "404", "error": "Not Found", "message": "..."}, with code a string.
Modified-date filters. dateTimeModifiedMin and dateTimeModifiedMax are inclusive and read the time as
UTC; a time zone offset in the value is ignored. A date alone means midnight. Encode + as %2B: an unencoded
+ is read as a space and the time is lost. A value the API can't read is ignored, and the list comes back
unfiltered.
Operation IDs. Every operation now has an operationId; 28 operations that had none were named.
Corrections to individual operations.
GET /leases/{leaseID}/recurring-charges declares its leaseID path parameter.transactionID and ledgerID as required; the API doesn't send them.POST /properties no longer marks propertyImageID as required. The API doesn't read
it from the request; the created property in the response still includes it.screeningReportModeID in GET /screening/applications/{applicationID}/summary is documented as 0
(Disabled), 1 (Package) or 2 (Dynamic); the earlier description gave 1 and 2 other meanings. It is a
string, except for an account with no screening settings, which gets the integer 0.GET /properties/{propertyID}/images/{imageHash}/{size}.jpeg no longer lists account as a path parameter;
the account is the server's subdomain./accounting prefix, a lease is
updated with POST /leases/{leaseID} (there is no PUT), and a unit's listing is at
GET /properties/{propertyID}/units/{unitID}/listing.GET /leases/export, GET /properties/export, GET /properties/units/export and
GET /screening/applications/export each count against a limit of their own for each API key: 60 an hour, 10 of
them at once. Responses list it as endpoint in the RateLimit-Policy and RateLimit headers. Like every other
limit at the time, it counted requests without refusing any.Reference only.
/accounting/bills/{billID}
(GET, POST and DELETE). The reference listed them under /accounting/{billID}, which doesn't exist.payoutTypeID and achAccountTypeID now list their values; the reference had pointed them at a file that
doesn't exist.type: [..., 'null'] instead of the OpenAPI 3.0 keyword nullable.datePostedMin and datePostedMax are strings in date format.search parameter is a string.*IDs[] array parameters declare integer items.primaryWorkOrderStatusID values are strings, as the API sends them.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.
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.
leaseIDs[]) or lease statuseslease.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.pageSize. Read pages until
pagination-current-page is at or past pagination-total-pages; no match answers [].GET /leases/{leaseID} - one lease, with its includesGET /properties/export - the property exportGET /properties/units/export - the unit export| leaseIDs[] | Array of integers Only these leases. Send each ID as a separate |
| primaryLeaseStatusIDs[] | Array of strings or integers (primary_lease_statuses_request) Items Enum: "1" "2" "3" 1 2 3 Only leases in these primary statuses ( |
| leaseStatusIDs[] | Array of integers Only leases in these lease statuses, the account's own statuses ( |
| 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 |
| 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 |
| 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.
|
| pagination-page-size | integer Example: "1" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
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. |
[- {
- "lease": {
- "leaseID": "239",
- "code": "L-0042",
- "propertyID": "720",
- "unitID": "873",
- "primaryLeaseStatusID": "2",
- "leaseStatusID": "2",
- "moveInDate": "2026-06-05",
- "moveOutDate": null,
- "startDate": "2026-06-17",
- "endDate": "2027-12-02",
- "closedDate": null,
- "expectedMoveOutDate": "2027-05-31",
- "increaseEligibilityDate": "2027-01-01",
- "lateFeeSettingID": "239",
- "tenants": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "+12025550101",
- "isActive": 1,
- "contactID": 851
}
], - "dateTimeCreated": "2030-12-01 09:00:00",
- "dateTimeModified": "2031-01-15 10:00:00"
}, - "balances": {
- "unpaidTotalAmount": 1275,
- "unpaidRentAmount": 1200,
- "pastDueTotalAmount": 1200,
- "pastDueRentAmount": 1200
}, - "unpaidCharges": [
- {
- "amount": 1200,
- "isRent": 1,
- "amountPaid": 0,
- "datePosted": "2026-01-01",
- "accountName": "Rent Income",
- "description": "January Rent",
- "transactionID": 5,
- "isOverdue": 1
}, - {
- "amount": 75,
- "isRent": 0,
- "amountPaid": 0,
- "datePosted": "2026-11-16",
- "accountName": "Carpet Cleaning",
- "description": "Carpet Cleaning",
- "transactionID": 6,
- "isOverdue": 0
}
], - "property": {
- "propertyID": "720",
- "propertyTypeID": "9",
- "isMultiUnit": "0",
- "isActive": "1",
- "name": "Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "OR",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "reserveAmount": "500.00"
}, - "unit": {
- "unitID": "873",
- "isActive": "1",
- "name": "Apt 768",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "WI",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "rent": "3243.74",
- "deposit": "3349.60",
- "size": "1200",
- "beds": null,
- "fullBaths": null,
- "halfBaths": null
}, - "portfolio": {
- "portfolioID": "952",
- "name": "Maple Holdings Portfolio",
- "isActive": "1",
- "reserveAmount": "250.00",
- "additionalReserveAmount": "100.00",
- "owners": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "isActive": 1,
- "contactID": 850
}
]
}
}
]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.
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.
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.pageSize. Read pages until
pagination-current-page is at or past pagination-total-pages; no match answers [].GET /properties/{propertyID} - one propertyGET /properties/units/export - the unit exportGET /leases/export - the lease export| isActive | boolean
|
| 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 |
| 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 |
| 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.
|
| pagination-page-size | integer Example: "1" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
[- {
- "property": {
- "propertyID": "788",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "name": "Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "reserveAmount": "500.00",
- "groups": [
- {
- "name": "Downtown",
- "propertyGroupID": 13
}
], - "dateTimeCreated": "2030-12-01 09:00:00",
- "dateTimeModified": "2031-02-15 10:00:00"
}, - "portfolio": {
- "portfolioID": "1025",
- "name": "Maple Holdings Portfolio",
- "isActive": "1",
- "reserveAmount": "250.00",
- "additionalReserveAmount": "100.00",
- "owners": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "isActive": 1,
- "contactID": 855
}
]
}
}
]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.
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.
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.pageSize. Read pages until
pagination-current-page is at or past pagination-total-pages; no match answers [].GET /properties/{propertyID}/units/{unitID} - one unitGET /properties/export - the property exportGET /leases/export - the lease export| isActive | boolean
|
| 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 |
| 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 |
| 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.
|
| pagination-page-size | integer Example: "1" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
[- {
- "unit": {
- "unitID": "956",
- "isActive": "1",
- "name": "Maple House",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": "293",
- "isVacant": "0",
- "dateTimeCreated": "2030-12-01 09:00:00",
- "dateTimeModified": "2031-03-15 10:00:00"
}, - "property": {
- "propertyID": "817",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "name": "Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "reserveAmount": "500.00"
}
}
]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.
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.
primaryApplicationStatusIDs[]=6&hasLease=false)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.pageSize. Read pages until
pagination-current-page is at or past pagination-total-pages; no match answers [].GET /screening/applications/{applicationID} - one applicationGET /screening/applications - the application listGET /leases/export - the lease export| 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 |
| applicationStatusIDs[] | Array of integers Only applications in these application statuses, the account's own statuses ( |
| hasLease | boolean
|
| 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 |
| 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
|
| 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.
|
| pagination-page-size | integer Example: "1" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
required | object The lease made from the application. Every field is |
[- {
- "application": {
- "applicationID": "866",
- "number": "100001",
- "primaryApplicationStatusID": "6",
- "applicationStatusID": "6",
- "unitID": "867",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "IN",
- "postalCode": "12345",
- "applicants": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "+12025550101",
- "applicantID": 777
}
], - "dateTimeCreated": "2030-12-01 09:00:00",
- "dateTimeModified": "2031-04-15 10:00:00"
}, - "unit": {
- "unitID": "867",
- "propertyID": "714",
- "isActive": "1",
- "name": "Apt 798",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "KY",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "rent": "818.20",
- "deposit": "2653.30",
- "size": "1100",
- "beds": "2",
- "fullBaths": "1",
- "halfBaths": "1"
}, - "lease": {
- "leaseID": "236",
- "startDate": "2026-12-07",
- "endDate": "2027-12-07",
- "tenants": [
- "Jordan Example"
]
}
}
]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.
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.
search.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.800 sorts after 1234).includes=parentAccount adds each account's parent under parentAccount and leaves out every account that
has no parent. Those rows carry no token.parentAccount - the parent account (parentAccountID); accounts with no parent are left outGET /accounting/accounts/search - a search with ID, escrow and modified-date filters, and each account's categoryGET /accounting/accounts/{accountID} - one account, with includes| 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 |
| accountTypeID | string or integer Example: accountTypeID=3,7 One account type, or a comma-separated list of types (
|
| accountTypes | string or integer Example: accountTypes=9 The same as |
| 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 |
| isActive | string or integer or boolean Example: isActive=1
|
| includes | string Example: includes=parentAccount Comma-separated includes. One is available: |
| pagination-page-size | integer Example: "5000" Page size used -- the requested |
| 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-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
| token | string^[0-9]+$ The time of the request as Unix seconds. Sent unless |
[- {
- "account": {
- "accountID": "545",
- "parentAccountID": "546",
- "accountTypeID": "3",
- "accountCategoryID": "2",
- "number": "91015",
- "name": "Thornbury Operating",
- "isActive": "1",
- "isSubjectToManagementFees": "0",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": "Example Bank",
- "bankAccountTypeID": "2",
- "bankAccountCiphertextID": "9",
- "bankAccountNumberTruncated": "6789",
- "bankAccountAddress": "123 Main St",
- "bankAccountAddress2": "Apt 4",
- "bankAccountCity": "Springfield",
- "bankAccountStateID": "IL",
- "bankAccountPostalCode": "12345",
- "bankAccountCountryID": "US",
- "isCheckingEnabled": "1",
- "checkCompanyName": "Example Property Management",
- "checkSignatory": "Jordan Example",
- "checkAddress": "123 Main St",
- "checkAddress2": "Apt 4",
- "checkCity": "Springfield",
- "checkStateID": "IL",
- "checkPostalCode": "12345",
- "checkCountryID": "US",
- "bankAccountNextCheckNumber": "1001",
- "bankAccountNextDepositNumber": "501",
- "checkTemplateID": "49",
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "1",
- "isNachaFileBalanced": "1",
- "nachaOriginName": "Example PM",
- "nachaOriginNumber": "0123456789",
- "nachaDestinationName": "Example Bank",
- "nachaDestinationNumber": "021000021",
- "nachaCompanyIdentification": "1234567890",
- "nachaCompanyName": "Example PM",
- "nachaOriginatingFinancialInstitutionID": "02100002",
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": "Example Export",
- "dateTimeCreated": "2026-11-16 19:21:16",
- "dateTimeModified": "2026-11-16 19:21:16",
- "dateTimeDeactivated": null
}, - "token": "1794856876"
}
]Creates a chart-of-accounts account and answers with it as GET /accounting/accounts/{accountID} reads it. A bank
account (accountTypeID 3) also takes its routing and account numbers, which are stored encrypted and never
returned.
Requires the Manage Chart Of Accounts permission (Administration › ManageChartOfAccounts). A bank account
also requires Manage Bank Accounts (Administration › ManageBankAccounts). Either missing answers 403
{"error": "Permission Denied"}.
accountTypeID, number and name are required, and a bank account also needs bankAccount.routingNumber and
bankAccount.accountNumber. With no accountTypeID, or one that isn't an account type, the API answers 400 with
an error (Account type is required to create the account state, State class not defined for this account type) before it checks any other field.
A bank account's numbers are checked first: when they fail, the 400 lists only the bankAccount.* messages. Then
the account's own fields are checked, and every failure is listed, keyed account.<field>.
number is at most 10 characters and unique among accounts with the same parent (This account already exists); name is at most 100. A sub-account's type must match its parent's (Account type must be the same as the parent account type), and a category's type must match the account's. isDeposit and isPrepayment
can't both be 1.
A bank account with isCheckingEnabled 1 needs the bank and check fields (bankName, bankAccountTypeID,
the bank and check addresses, checkCompanyName, checkTemplateID); one with isNachaEnabled 1 needs
isNachaFileBalanced and every nacha* field but nachaAdapterID. Each missing one is listed with its own
message.
The account type decides which fields the account keeps. Whatever the request sends, saving sets the others to
0 or null:
| Account type | Flags set to 0 |
Bank, check, NACHA and gateway fields (not nachaAdapterID or exportInvoiceServiceName) |
|---|---|---|
1 Accounts Receivable, 2 Accounts Payable |
every flag but isSubjectToMarkup and isBillApprovalExempt |
cleared |
3 Bank |
every flag but isEscrow, isSubjectToMarkup, isBillApprovalExempt, isCheckingEnabled, isNachaEnabled |
kept; the NACHA fields cleared when isNachaEnabled is 0 |
4 Asset |
isDeposit, isEscrow, isSubsidized, isPrepayment, isManagementFee, isBudgetEnabled, isHeld, isSubjectToSalesTax |
cleared |
5 Liability |
isEscrow, isSubsidized, isManagementFee, isBudgetEnabled, isSubjectToSalesTax |
cleared |
6 Equity |
isDeposit, isEscrow, isSubsidized, isPrepayment, isManagementFee, isHeld, isSubjectToSalesTax |
cleared |
7 Income |
isDeposit, isEscrow, isManagementFee, isHeld |
cleared |
8 Other Income |
isDeposit, isEscrow, isManagementFee |
cleared |
9 Expense, 10 Other Expense |
isDeposit, isEscrow, isRent, isSubsidized, isTaxable, isPrepayment, isHeld |
cleared |
depositTypeID is cleared wherever isDeposit is.
Flags left out are 0, except isSubjectToMarkup and isHeld (1, where the type keeps them) and
isNachaFileBalanced (1, then 0 when NACHA is off). A new account is always active.
Send includes to get the account's includes in the response, as GET /accounting/accounts/{accountID} takes
them.
bankAccountCiphertextID), and bankAccountNumberTruncated is set to the account number's last 4 digits.defaultBankAccountID in GET /accounting/settings (undocumented)).GET /logs/{objectTypeID}/{objectID} (undocumented) lists for object type 54.GET /accounting/accounts/{accountID} - Read the account back, with includes.POST /accounting/accounts/{accountID} - Change the account.GET /accounting/accounts - List accounts, for a parent account's ID.GET /accounting/bank-accounts - List the bank accounts.| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID required | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account type. It can't be changed later, and it decides which other fields the account keeps.
|
| number required | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name required | string [ 1 .. 100 ] characters Display name. |
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account: an account of the same type, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. Default |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. Default |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. Default |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. Default |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. Default |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. Default |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. Default |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. Default |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. Default |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. Default |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. Default |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. Default |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. Default |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Default |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. Default |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| isFromImport | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account came from an import. Default |
| importSourceKey | string or null The import's key for the account, unique among imported accounts. Kept only when |
| creditCardGatewayID | string or integer or null^-?[0-9]+$ Credit card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| achGatewayID | string or integer or null^-?[0-9]+$ ACH gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| cashCardGatewayID | string or integer or null^-?[0-9]+$ Cash card gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
| remoteCheckGatewayID | string or integer or null^-?[0-9]+$ Remote check printing gateway (bank accounts). An existing gateway's ID (no lookup route); an update can't change it. |
object The bank account's routing and account numbers. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) The account's current reconciliation: the one marked current that isn't voided (the latest by statement end
date if there are several). An account with
none (any account that isn't a reconciled bank account) gets a placeholder that was never saved: | |
| unprintedCheckCount | integer >= 0 How many check payouts from this account still wait to be printed: not voided, never printed, in an approved
payout batch (the checks the Print Checks screen lists). A JSON number. Requires the |
object or null The account's positive pay gateway (the service the bank checks issued checks against), or null when it has
none. Its IDs and flags are JSON numbers, unlike the rest of the response. Requires the |
{- "accountTypeID": 7,
- "number": "4150",
- "name": "Pet Rent Income",
- "isRent": 1,
- "isSubjectToManagementFees": 1,
- "isSubjectToLateFees": 1,
- "isTaxable": 0
}{- "account": {
- "accountID": "169",
- "parentAccountID": null,
- "accountTypeID": "7",
- "accountCategoryID": null,
- "number": "4150",
- "name": "Pet Rent Income",
- "isActive": "1",
- "isSubjectToManagementFees": "1",
- "isSubjectToLateFees": "1",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "1",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": null,
- "bankAccountTypeID": null,
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": null,
- "bankAccountAddress": null,
- "bankAccountAddress2": null,
- "bankAccountCity": null,
- "bankAccountStateID": null,
- "bankAccountPostalCode": null,
- "bankAccountCountryID": null,
- "isCheckingEnabled": "0",
- "checkCompanyName": null,
- "checkSignatory": null,
- "checkAddress": null,
- "checkAddress2": null,
- "checkCity": null,
- "checkStateID": null,
- "checkPostalCode": null,
- "checkCountryID": null,
- "bankAccountNextCheckNumber": null,
- "bankAccountNextDepositNumber": null,
- "checkTemplateID": null,
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "0",
- "isNachaFileBalanced": "0",
- "nachaOriginName": null,
- "nachaOriginNumber": null,
- "nachaDestinationName": null,
- "nachaDestinationNumber": null,
- "nachaCompanyIdentification": null,
- "nachaCompanyName": null,
- "nachaOriginatingFinancialInstitutionID": null,
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": null,
- "dateTimeCreated": "2026-11-12 23:22:51",
- "dateTimeModified": "2026-11-12 23:22:51",
- "dateTimeDeactivated": null
}
}Returns a 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.
search, or look up known accounts with accountID or accountIDs[].dateTimeModifiedMin.isEscrow=1.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.name[]=.800 sorts after 1234), then name, then accountID.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 includeGET /accounting/accounts/{accountID} - one account, with includes| 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. |
| search | string Example: search=Operating Substring matched against the account's |
| isActive | string or integer or boolean Example: isActive=1
|
| isEscrow | string or integer or boolean Example: isEscrow=1
|
| 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 |
| accountID | integer Example: accountID=31 One account, by ID. A value that isn't a number, or |
| accountIDs[] | Array of integers Example: accountIDs[]=31&accountIDs[]=32 Accounts, by ID, each as a separate |
| 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 |
| 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 |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "account": {
- "accountID": "587",
- "parentAccountID": null,
- "accountTypeID": "3",
- "accountCategoryID": "16",
- "number": "91015",
- "name": "Thornbury Operating",
- "isActive": "1",
- "isSubjectToManagementFees": "0",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": "Example Bank",
- "bankAccountTypeID": "2",
- "bankAccountCiphertextID": "23",
- "bankAccountNumberTruncated": "6789",
- "bankAccountAddress": "123 Main St",
- "bankAccountAddress2": "Apt 4",
- "bankAccountCity": "Springfield",
- "bankAccountStateID": "IL",
- "bankAccountPostalCode": "12345",
- "bankAccountCountryID": "US",
- "isCheckingEnabled": "1",
- "checkCompanyName": "Example Property Management",
- "checkSignatory": "Jordan Example",
- "checkAddress": "123 Main St",
- "checkAddress2": "Apt 4",
- "checkCity": "Springfield",
- "checkStateID": "IL",
- "checkPostalCode": "12345",
- "checkCountryID": "US",
- "bankAccountNextCheckNumber": "1001",
- "bankAccountNextDepositNumber": "501",
- "checkTemplateID": "63",
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "1",
- "isNachaFileBalanced": "1",
- "nachaOriginName": "Example PM",
- "nachaOriginNumber": "0123456789",
- "nachaDestinationName": "Example Bank",
- "nachaDestinationNumber": "021000021",
- "nachaCompanyIdentification": "1234567890",
- "nachaCompanyName": "Example PM",
- "nachaOriginatingFinancialInstitutionID": "02100002",
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": "Example Export",
- "dateTimeCreated": "2026-11-16 19:21:26",
- "dateTimeModified": "2026-11-16 19:21:26",
- "dateTimeDeactivated": null
}, - "accountCategory": {
- "accountCategoryID": "16",
- "accountTypeID": "3",
- "name": "Thornbury Operating Accounts"
}
}
]Returns one chart-of-accounts account, with the related records the includes parameter asks for. A bank account's
routing and account numbers aren't part of it: the response carries only the account number's last 4 digits
(bankAccountNumberTruncated).
POST /accounting/accounts/{accountID}.{"error": "Account <id> not found"}; so does 0.accountCategory - The account's category, or null.checkTemplate - The check template the account prints with, or null.currentReconciliation - The current reconciliation, or an unsaved placeholder when there is none.unprintedCheckCount - How many of the account's check payouts wait to be printed (a JSON number).positivePayGateway - The account's positive pay gateway, or null.GET /accounting/accounts - List accounts.GET /accounting/bank-accounts - List the bank accounts.POST /accounting/accounts/{accountID} - Change the account.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) The account's current reconciliation: the one marked current that isn't voided (the latest by statement end
date if there are several). An account with
none (any account that isn't a reconciled bank account) gets a placeholder that was never saved: | |
| unprintedCheckCount | integer >= 0 How many check payouts from this account still wait to be printed: not voided, never printed, in an approved
payout batch (the checks the Print Checks screen lists). A JSON number. Requires the |
object or null The account's positive pay gateway (the service the bank checks issued checks against), or null when it has
none. Its IDs and flags are JSON numbers, unlike the rest of the response. Requires the |
{- "account": {
- "accountID": "157",
- "parentAccountID": null,
- "accountTypeID": "3",
- "accountCategoryID": null,
- "number": "1015",
- "name": "Operating - Example Bank",
- "isActive": "1",
- "isSubjectToManagementFees": "0",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": "Example Bank",
- "bankAccountTypeID": "2",
- "bankAccountCiphertextID": "15",
- "bankAccountNumberTruncated": "6789",
- "bankAccountAddress": "123 Main St",
- "bankAccountAddress2": "Apt 4",
- "bankAccountCity": "Springfield",
- "bankAccountStateID": "IL",
- "bankAccountPostalCode": "12345",
- "bankAccountCountryID": "US",
- "isCheckingEnabled": "1",
- "checkCompanyName": "Example Property Management",
- "checkSignatory": "Jordan Example",
- "checkAddress": "123 Main St",
- "checkAddress2": "Apt 4",
- "checkCity": "Springfield",
- "checkStateID": "IL",
- "checkPostalCode": "12345",
- "checkCountryID": "US",
- "bankAccountNextCheckNumber": "1001",
- "bankAccountNextDepositNumber": "501",
- "checkTemplateID": "83",
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "1",
- "isNachaFileBalanced": "1",
- "nachaOriginName": "Example PM",
- "nachaOriginNumber": "0123456789",
- "nachaDestinationName": "Example Bank",
- "nachaDestinationNumber": "021000021",
- "nachaCompanyIdentification": "1234567890",
- "nachaCompanyName": "Example PM",
- "nachaOriginatingFinancialInstitutionID": "02100002",
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": "Example Export",
- "dateTimeCreated": "2026-11-12 23:22:47",
- "dateTimeModified": "2026-11-12 23:22:47",
- "dateTimeDeactivated": null
}
}Changes a chart-of-accounts account and answers with it as GET /accounting/accounts/{accountID} reads it. Send
only the fields to change. The account type can't change, and this operation doesn't activate or deactivate an
account or change a bank account's routing and account numbers.
Administration › ManageChartOfAccounts). Changing a
bank account also requires Manage Bank Accounts (Administration › ManageBankAccounts). Either missing
answers 403 {"error": "Permission Denied"}.{"error": "Account <id> not found"}, after the empty-body check.accountTypeID is refused
(Cannot change the account type).Cannot select parent as self) or one of its sub-accounts (Cannot select this parent - circular reference). The other field rules are the create's: number at most 10 characters
and unique under the parent, name at most 100, a category of the same type, not both isDeposit and
isPrepayment, and on a bank account the check and NACHA fields required when those are on.POST /accounting/accounts: fields its type
doesn't keep go back to 0 or null whatever the request sends.includes to get the account's includes in the response. Without it the response has only account.GET /logs/{objectTypeID}/{objectID} (undocumented), object type 54) when anything changed.checkSignatory deletes that gateway and emails
Rentvine support that remote check printing was turned off for the bank account.GET /accounting/accounts/{accountID} - Read the account.PUT /accounting/accounts/{accountID} - The same operation as a PUT.POST /accounting/accounts - Create an account.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account's current type. Another type is refused (
|
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| number | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name | string [ 1 .. 100 ] characters Display name. |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Set to |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) The account's current reconciliation: the one marked current that isn't voided (the latest by statement end
date if there are several). An account with
none (any account that isn't a reconciled bank account) gets a placeholder that was never saved: | |
| unprintedCheckCount | integer >= 0 How many check payouts from this account still wait to be printed: not voided, never printed, in an approved
payout batch (the checks the Print Checks screen lists). A JSON number. Requires the |
object or null The account's positive pay gateway (the service the bank checks issued checks against), or null when it has
none. Its IDs and flags are JSON numbers, unlike the rest of the response. Requires the |
{- "name": "Application Fees",
- "isSubjectToManagementFees": 1,
- "isTaxable": 1
}{- "account": {
- "accountID": "173",
- "parentAccountID": null,
- "accountTypeID": "7",
- "accountCategoryID": null,
- "number": "4962",
- "name": "Application Fees",
- "isActive": "1",
- "isSubjectToManagementFees": "1",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "1",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": null,
- "bankAccountTypeID": null,
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": null,
- "bankAccountAddress": null,
- "bankAccountAddress2": null,
- "bankAccountCity": null,
- "bankAccountStateID": null,
- "bankAccountPostalCode": null,
- "bankAccountCountryID": null,
- "isCheckingEnabled": "0",
- "checkCompanyName": null,
- "checkSignatory": null,
- "checkAddress": null,
- "checkAddress2": null,
- "checkCity": null,
- "checkStateID": null,
- "checkPostalCode": null,
- "checkCountryID": null,
- "bankAccountNextCheckNumber": null,
- "bankAccountNextDepositNumber": null,
- "checkTemplateID": null,
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "0",
- "isNachaFileBalanced": "0",
- "nachaOriginName": null,
- "nachaOriginNumber": null,
- "nachaDestinationName": null,
- "nachaDestinationNumber": null,
- "nachaCompanyIdentification": null,
- "nachaCompanyName": null,
- "nachaOriginatingFinancialInstitutionID": null,
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": null,
- "dateTimeCreated": "2026-11-12 23:22:56",
- "dateTimeModified": "2026-11-12 23:22:56",
- "dateTimeDeactivated": null
}
}The same operation as POST /accounting/accounts/{accountID}, sent as a PUT: same request, permissions, rules,
side effects and responses. It is a partial update too: send only the fields to change.
POST /accounting/accounts/{accountID} - The full description of the update.| accountID required | integer Example: 31 The account's ID, from |
| includes | string Example: includes=accountCategory,currentReconciliation Comma-separated list of related records to add to the response, each under its own key: |
| accountTypeID | string or integer (account_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 1 2 3 4 5 6 7 8 9 10 The account's current type. Another type is refused (
|
| parentAccountID | string or integer or null^-?[0-9]+$ Parent account, for a sub-account, from |
| accountCategoryID | string or integer or null^-?[0-9]+$ Account category, one of the same account type, from |
| number | string [ 1 .. 10 ] characters Chart-of-accounts number, unique among accounts with the same parent. |
| name | string [ 1 .. 100 ] characters Display name. |
| isSubjectToManagementFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to management fees. |
| isSubjectToLateFees | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges posted to the account are subject to late fees. |
| isDeposit | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account tracks security deposits. Can't be combined with |
(deposit_types_request (string or integer)) or null Deposit type, for a deposit account. When
| |
| isEscrow | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds escrow funds. |
| isRent | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is classified as rent. |
| isSubsidized | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account is subsidized. |
| isTaxable | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are taxable. |
| isSubjectToSalesTax | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account are subject to sales tax. |
| isSubjectToMarkup | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether charges to the account can be marked up. |
| isPrepayment | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account holds prepayments. Can't be combined with |
| isManagementFee | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account represents a management fee. |
| isBudgetEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether budget tracking is on for the account. |
| isHeld | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether funds in the account are held. |
| bankName | string or null <= 100 characters Bank name (bank accounts). Required when |
(bank_account_types_request (string or integer)) or null Savings or checking (bank accounts). Required when
| |
| bankAccountAddress | string or null <= 100 characters Bank's address, line 1 (bank accounts). Required when |
| bankAccountAddress2 | string or null <= 100 characters Bank's address, line 2 (bank accounts). |
| bankAccountCity | string or null <= 100 characters Bank's city (bank accounts). Required when |
| bankAccountStateID | string or null Bank's state or province code (bank accounts), as |
| bankAccountPostalCode | string or null <= 20 characters Bank's postal code (bank accounts). Required when |
| bankAccountCountryID | string or null Bank's country code, from |
| bankAccountNextDepositNumber | string or null <= 25 characters Next deposit number (bank accounts). |
| bankAccountNextCheckNumber | string or null <= 25 characters Next check number (bank accounts). |
| isCheckingEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account prints checks (bank accounts). Makes the bank and check fields required. |
| checkCompanyName | string or null <= 100 characters Name printed on checks. Required when |
| checkSignatory | string or null <= 100 characters Signatory printed on checks. See Side Effects for what a change does to remote check printing. |
| checkAddress | string or null <= 100 characters Address printed on checks, line 1. Required when |
| checkAddress2 | string or null <= 100 characters Address printed on checks, line 2. |
| checkCity | string or null <= 100 characters City printed on checks. Required when |
| checkStateID | string or null State printed on checks, as |
| checkPostalCode | string or null <= 20 characters Postal code printed on checks. Required when |
| checkCountryID | string or null Country printed on checks; |
| checkTemplateID | string or integer or null^-?[0-9]+$ Check template, from |
| isNachaEnabled | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account writes NACHA payout files (bank accounts). Makes the NACHA fields required. |
| isNachaFileBalanced | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether the account's NACHA files are balanced. Set to |
| nachaOriginName | string or null <= 100 characters NACHA immediate origin name. Required when |
| nachaOriginNumber | string or null <= 20 characters NACHA immediate origin number. Required when |
| nachaDestinationName | string or null <= 100 characters NACHA immediate destination name. Required when |
| nachaDestinationNumber | string or null <= 20 characters NACHA immediate destination number. Required when |
| nachaCompanyIdentification | string or null <= 20 characters NACHA company identification. Required when |
| nachaCompanyName | string or null <= 100 characters NACHA company name. Required when |
| nachaOriginatingFinancialInstitutionID | string or null <= 20 characters NACHA originating financial institution. Required when |
| nachaAdapterID | string or integer or null^-?[0-9]+$ NACHA file format: |
| isBillApprovalExempt | string or integer (account_flag_request) Enum: "0" "1" 0 1 Whether bills posted to the account skip bill approval. |
| exportInvoiceServiceName | string or null <= 100 characters Service name used when exporting invoices for the account. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
check_template (object) or null The check template the account prints checks with, or null when it has none (or the template no longer
exists). Requires the | |
included_reconciliation (object) or reconciliation_placeholder (object) The account's current reconciliation: the one marked current that isn't voided (the latest by statement end
date if there are several). An account with
none (any account that isn't a reconciled bank account) gets a placeholder that was never saved: | |
| unprintedCheckCount | integer >= 0 How many check payouts from this account still wait to be printed: not voided, never printed, in an approved
payout batch (the checks the Print Checks screen lists). A JSON number. Requires the |
object or null The account's positive pay gateway (the service the bank checks issued checks against), or null when it has
none. Its IDs and flags are JSON numbers, unlike the rest of the response. Requires the |
{- "name": "Application Fees",
- "isSubjectToManagementFees": 1,
- "isTaxable": 1
}{- "account": {
- "accountID": "173",
- "parentAccountID": null,
- "accountTypeID": "7",
- "accountCategoryID": null,
- "number": "4962",
- "name": "Application Fees",
- "isActive": "1",
- "isSubjectToManagementFees": "1",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "1",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": null,
- "bankAccountTypeID": null,
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": null,
- "bankAccountAddress": null,
- "bankAccountAddress2": null,
- "bankAccountCity": null,
- "bankAccountStateID": null,
- "bankAccountPostalCode": null,
- "bankAccountCountryID": null,
- "isCheckingEnabled": "0",
- "checkCompanyName": null,
- "checkSignatory": null,
- "checkAddress": null,
- "checkAddress2": null,
- "checkCity": null,
- "checkStateID": null,
- "checkPostalCode": null,
- "checkCountryID": null,
- "bankAccountNextCheckNumber": null,
- "bankAccountNextDepositNumber": null,
- "checkTemplateID": null,
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "0",
- "isNachaFileBalanced": "0",
- "nachaOriginName": null,
- "nachaOriginNumber": null,
- "nachaDestinationName": null,
- "nachaDestinationNumber": null,
- "nachaCompanyIdentification": null,
- "nachaCompanyName": null,
- "nachaOriginatingFinancialInstitutionID": null,
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": null,
- "dateTimeCreated": "2026-11-12 23:22:56",
- "dateTimeModified": "2026-11-12 23:22:56",
- "dateTimeDeactivated": null
}
}Returns every bank account in the chart of accounts (accounts of type 3, Bank) in one page, with a few of each
account's fields and how many of its checks wait to be printed. It doesn't return routing or account numbers.
number (as text), then name, then accountID.isActive and isEscrow take true/false or 1/0 (also yes/no, in any
case); any other value is ignored and the list isn't filtered by it.GET /accounting/accounts/{accountID} - Read one bank account in full.POST /accounting/accounts - Create a bank account.GET /accounting/accounts - List every kind of account.| search | string Example: search=Operating Keeps the bank accounts whose |
| isActive | string Example: isActive=true
|
| isEscrow | string Example: isEscrow=false
|
| bankAccountIDs[] | Array of integers Example: bankAccountIDs[]=31&bankAccountIDs[]=32 Keeps only these accounts. Send each ID as a separate |
| pagination-page-size | integer Example: "1" The number of bank accounts returned; 15 when none match. |
| pagination-total-items | integer Example: "1" The number of bank accounts returned. |
| pagination-total-pages | integer Example: "1" 1, or 0 when none match. |
| pagination-current-page | integer Example: "1" Always 1. |
| pagination-next-page | integer Example: "1" 1, or 0 when none match. |
| pagination-before-page | integer Example: "1" Always 1. |
| pagination-first-page | integer Example: "1" Always 1. |
| pagination-last-page | integer Example: "1" 1, or 0 when none match. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object A bank account's summary fields. |
[- {
- "account": {
- "accountID": "161",
- "number": "1015",
- "name": "Operating - Example Bank",
- "bankName": "Example Bank",
- "bankAccountNextCheckNumber": "1001",
- "bankAccountNextDepositNumber": "501",
- "isEscrow": "0",
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "bankAccountTypeID": "2",
- "bankAccountNumberTruncated": "6789",
- "isCheckingEnabled": "1",
- "isActive": "1",
- "unprintedCheckCount": "1"
}
}
]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.
Returns one page of bills, each with its payee contact, latest due date first.
contactID).search), or the bills dated in a range (startDate, endDate).bill.isVoided says which they are.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.| search | string Example: search=INV-204 Part of the bill's |
| contactID | integer Example: contactID=210 Only the bills owed to this payee contact (a vendor from |
| startDate | string Example: startDate=2026-03-01 Only bills dated ( |
| endDate | string Example: endDate=2026-03-31 Only bills dated ( |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
required | object (included_contact_left_joined) The bill's payee contact. When the payee contact no longer exists, every field is |
[- {
- "bill": {
- "billID": "232",
- "billBatchID": null,
- "parentBillID": "231",
- "payeeContactID": "614",
- "billTypeID": "1",
- "bankAccountID": null,
- "billDate": "2026-03-02",
- "dateDue": "2026-04-01",
- "reference": "INV-20431",
- "paymentMemo": "Unit 4 repair",
- "serviceAccountNumber": "SA-7781",
- "description": "Replaced the kitchen faucet",
- "workOrderID": "93",
- "discountPercent": "2.5000",
- "markupPercent": "10.0000",
- "isVoided": "0",
- "isApproved": "1",
- "approvedByUserID": null,
- "billApprovalAssigneeUserID": "3",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "1",
- "managementFeeMode": "1",
- "propertyID": "4007",
- "utilityID": null,
- "utilityPeriodStartDate": "2026-02-01",
- "utilityPeriodEndDate": "2026-02-28",
- "importAccountCommitID": null
}, - "contact": {
- "contactID": "614",
- "contactTypeID": "3",
- "vendorTypeID": null,
- "code": null,
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "VT",
- "postalCode": "12345",
- "birthDate": null,
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": null,
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-16 19:37:57",
- "dateTimeModified": "2026-11-16 19:37:57",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}
}, - {
- "bill": {
- "billID": "231",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "614",
- "billTypeID": "1",
- "bankAccountID": null,
- "billDate": "2026-03-01",
- "dateDue": "2026-03-31",
- "reference": "XG5858",
- "paymentMemo": null,
- "serviceAccountNumber": null,
- "description": null,
- "workOrderID": null,
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "0",
- "isApproved": "0",
- "approvedByUserID": null,
- "billApprovalAssigneeUserID": null,
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "1",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}, - "contact": {
- "contactID": "614",
- "contactTypeID": "3",
- "vendorTypeID": null,
- "code": null,
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "VT",
- "postalCode": "12345",
- "birthDate": null,
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": null,
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-16 19:37:57",
- "dateTimeModified": "2026-11-16 19:37:57",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}
}
]Creates a new bill in the system.
leaseCharges.payeeContactID, billDate, and dateDue are required.workOrderID on
this request. Optionally set workOrderStatusID to update the work order's status at the
same time the bill is created.overrideBankAccount: true and supply bankAccountID to
pay the bill from a specific bank account. When overrideBankAccount is false (or
omitted), the system uses the bank account defined in the payer's posting settings.charges must include ledgerID, chargeAccountID, and amount.leaseCharges must include leaseID, chargeAccountID, and amount.GET /accounting/bills - List all bills.GET /accounting/bills/{billID} - Retrieve a single bill with optional includes.POST /accounting/bills/{billID} - Update an existing bill.DELETE /accounting/bills/{billID} - Void a bill.| payeeContactID required | string or integer^-?[0-9]+$ |
| billDate required | string <date> |
| dateDue required | string <date> |
| billBatchID | string or integer or null^-?[0-9]+$ |
| parentBillID | string or integer or null^-?[0-9]+$ |
| reference | string or null |
| paymentMemo | string or null |
| description | string or null |
| workOrderID | string or integer or null^-?[0-9]+$ The ID of a work order to associate with this bill. To tie a bill to a work order,
first create the work order, then pass its |
| bankAccountID | string or integer or null^-?[0-9]+$ The bank account to use for this bill. Only applicable when |
| serviceAccountNumber | string or null |
| utilityPeriodStartDate | string or null <date> |
| utilityPeriodEndDate | string or null <date> |
| discountPercent | string or number or null <decimal> |
| markupPercent | string or number or null <decimal> |
Array of objects Line-item charges applied to ledger accounts. | |
Array of objects Charges posted directly to lease ledgers (tenant-responsible amounts). | |
| tenantAmount | number or null The portion of the bill to be collected from the tenant. |
| workOrderStatusID | string or integer or null^-?[0-9]+$ The status to set on the linked work order when the bill is created. |
| markupOverridePercentage | string or null Overrides the default markup percentage for this bill (decimal string). |
| overrideBankAccount | boolean When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (bill) |
{- "payeeContactID": "67",
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "Plumbing invoice April",
- "description": "Bathroom plumbing repair",
- "charges": [
- {
- "ledgerID": "960",
- "description": "Plumbing repair labor",
- "chargeAccountID": "37",
- "amount": "100.00",
- "salesTaxAmount": "0.00",
- "leaseID": null
}
], - "leaseCharges": [ ],
- "overrideBankAccount": false
}{- "bill": {
- "billID": "15106",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "67",
- "billTypeID": "1",
- "bankAccountID": null,
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "Plumbing invoice April",
- "serviceAccountNumber": null,
- "description": "Bathroom plumbing repair",
- "workOrderID": null,
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "0",
- "isApproved": "1",
- "approvedByUserID": "512915",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}
}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.
approvalRequirementType).{"error": "Access Denied"}. The restrictions include says whether
the caller reaches all of them (full) or only some (partial).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.{"error": "Bill <id> not found"}.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.| 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. |
| includes | string Example: includes=contact,charges,bankAccount,markupDiscount,approvalRequirementType Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
included_contact_accounting (object) or null The payee contact, or | |
Array of objects (bill_charge_row) The bill's non-voided charges. Requires the | |
object Requires the | |
Array of objects (bill_lease_charge_row) Lease charges billed from this bill, latest posting date first. Requires the | |
Array of objects (bill_payout_row) Payout charges toward this bill, latest posting date first. Requires the | |
included_work_order (object) or null The bill's work order. Requires the | |
bill_record (object) or null The bill this markup or discount bill was generated from, or null. Requires the | |
bill_record (object) or null The discount bill generated from this bill, or null. Requires the | |
bill_record (object) or null The markup bill generated from this bill, or null. Requires the | |
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'
| |
object or null The utility of a utility bill, or null. Requires the | |
included_property (object) or null The bill's property ( | |
object Requires the | |
| 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
|
{- "bill": {
- "billID": "241",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "619",
- "billTypeID": "1",
- "bankAccountID": null,
- "billDate": "2026-11-16",
- "dateDue": "2026-12-16",
- "reference": "INV-20431",
- "paymentMemo": "Unit 4 repair",
- "serviceAccountNumber": "SA-7781",
- "description": "Replaced the kitchen faucet",
- "workOrderID": "94",
- "discountPercent": "2.5000",
- "markupPercent": "10.0000",
- "isVoided": "0",
- "isApproved": "0",
- "approvedByUserID": null,
- "billApprovalAssigneeUserID": null,
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "1",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": "2026-02-01",
- "utilityPeriodEndDate": "2026-02-28",
- "importAccountCommitID": null
}
}Updates an existing bill. All fields are optional — only the fields provided in the
request body are changed. Charges are matched by transactionID.
charges must include transactionID to identify the charge being updated.Pass a comma-separated list of include names in the includes query parameter.
| Include name | What it adds |
|---|---|
charges |
Updated charge lines with full transaction details. |
contact |
Full payee contact record. |
payouts |
Payouts applied toward this bill. |
workOrder |
The linked work order, if any. |
GET /accounting/bills/{billID} - Retrieve the updated bill.POST /accounting/bills - Create a new bill.DELETE /accounting/bills/{billID} - Void a bill.| billID required | integer Example: 15026 |
| includes | string Example: includes=charges,contact,payouts,workOrder Comma-separated list of related data to include in the response.
Available values: |
| payeeContactID | string or integer^-?[0-9]+$ The ID of the payee contact (vendor) for this bill. |
| billDate | string <date> The date of the bill. |
| dateDue | string <date> The date the bill is due. |
| amount | string or number <decimal> Total bill amount. |
| discountPercent | string or number <decimal> Discount percentage applied to the bill. |
| markupPercent | string or number <decimal> Markup percentage applied to the bill. |
| bankAccountID | string or integer^-?[0-9]+$ The bank account used to pay this bill. |
| reference | string or null External reference number (e.g. invoice number, check number). |
| paymentMemo | string or null Memo to include with the payment. |
| description | string or null Internal description for the bill. |
| workOrderID | string or integer or null^-?[0-9]+$ The ID of the work order to link to this bill. |
Array of objects Charge lines to update on this bill. Each entry must include | |
| serviceAccountNumber | string or null Utility service account number, if applicable. |
| utilityPeriodStartDate | string or null <date> Start date of the utility billing period. |
| utilityPeriodEndDate | string or null <date> End date of the utility billing period. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (bill) |
object or null Payee contact details (if includes=contact). | |
Array of objects Updated charge line items with full transaction details (if includes=charges). | |
| payouts | Array of objects Payouts applied to this bill (if includes=payouts). |
object or null Linked work order (if includes=workOrder). |
{- "payeeContactID": 21,
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "amount": 0,
- "discountPercent": 0,
- "markupPercent": 0,
- "bankAccountID": 216,
- "reference": "123456",
- "paymentMemo": "test memo",
- "description": "test description",
- "workOrderID": 5954,
- "charges": [
- {
- "transactionID": 80486,
- "amount": "2.00",
- "discountAmount": "0.00",
- "markupAmount": "0.00",
- "ledgerID": 297,
- "chargeAccountID": 66,
- "description": "test description"
}
], - "serviceAccountNumber": "0001",
- "utilityPeriodStartDate": "2026-04-22",
- "utilityPeriodEndDate": "2027-04-22"
}{- "bill": {
- "billID": "15106",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "67",
- "billTypeID": "1",
- "bankAccountID": null,
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "Plumbing invoice April",
- "serviceAccountNumber": null,
- "description": "Bathroom plumbing repair",
- "workOrderID": null,
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "0",
- "isApproved": "1",
- "approvedByUserID": "512915",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}, - "contact": {
- "contactID": "21",
- "contactTypeID": "3",
- "vendorTypeID": "10",
- "code": "Water",
- "name": "1st General Contractor",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "vasco@rentvine.com",
- "phone": null,
- "countryID": "US",
- "address": "70 Hillcroft St",
- "address2": null,
- "city": "Spring",
- "stateID": "FL",
- "postalCode": "33928",
- "birthDate": null,
- "defaultBillChargeAccountID": "71",
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "4",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": "69",
- "achAccountNumberTruncated": "3587",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "1",
- "holdPayments": "0",
- "liabilityInsuranceName": "Progressive",
- "liabilityInsurancePolicyNumber": "u213ffhsicr",
- "liabilityInsuranceExpiresDate": "2025-07-23",
- "workersCompInsuranceName": "None on File",
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": "2024-07-02",
- "discountPercent": "20.0000",
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": "1",
- "maxLineItemsOnPayment": "10",
- "preventConsolidatedPayments": "0",
- "isFromImport": "1",
- "importSourceKey": "11",
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": "TT",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "1st General",
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2023-01-14 18:39:10",
- "dateTimeModified": "2026-04-10 14:36:47",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}, - "charges": [
- {
- "transaction": {
- "transactionID": "80486",
- "transactionTypeID": "7",
- "managementFeeMode": "2",
- "primaryLedgerID": "2",
- "portfolioID": "1",
- "propertyID": "170",
- "unitID": null,
- "leaseID": null,
- "billID": "15026",
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "66",
- "amount": "2.00",
- "amountPaid": "0.00",
- "amountAllocated": null,
- "description": "test description",
- "discountAmount": "0.00",
- "markupAmount": "0.00",
- "isSuppressed": "0",
- "isVoided": "0",
- "datePosted": "2026-04-22",
- "dateTimeCreated": "2026-04-22 04:15:16",
- "dateTimeModified": "2026-04-22 22:51:52"
}, - "property": {
- "propertyID": "170",
- "propertyTypeID": "6",
- "isMultiUnit": "1",
- "isActive": "1",
- "portfolioID": "1",
- "address": "2001 Blake Street",
- "city": "Denver",
- "stateID": "CO",
- "postalCode": "80205"
}, - "unit": {
- "unitID": null,
- "propertyID": null,
- "isActive": null,
- "name": null,
- "address": null
}, - "portfolio": {
- "portfolioID": "1",
- "name": "Amanda LLC",
- "contacts": [
- {
- "contactID": "2",
- "percentOwned": "75.0000",
- "percentDistributed": "100.0000",
- "name": "Amanda H. Wilson"
}, - {
- "contactID": "4471",
- "percentOwned": "25.0000",
- "percentDistributed": "0.0000",
- "name": "chris"
}
], - "isActive": "1"
}, - "postingSetting": {
- "postingSettingID": "1",
- "name": "My Preferred Settings",
- "operatingAccountID": "31",
- "escrowAccountID": "32",
- "leaseRefundAccountID": "31",
- "isActive": "1"
}, - "ledger": {
- "ledgerID": "2",
- "ledgerTypeID": "2",
- "objectID": "1",
- "name": "Amanda LLC",
- "isActive": "1",
- "dateTimeCreated": "2023-09-29 23:46:23",
- "dateTimeModified": "2026-03-26 13:49:41"
}, - "restricted": "0",
- "payeeLedger": {
- "ledgerID": "297",
- "ledgerTypeID": "3",
- "objectID": "170",
- "name": "2001 Blake Street, Denver, CO 80205",
- "isActive": "1",
- "dateTimeCreated": "2023-09-29 23:46:23",
- "dateTimeModified": "2024-06-10 14:31:36"
}
}
], - "payouts": [ ],
- "workOrder": {
- "workOrderID": "5954",
- "workOrderNumber": "105781",
- "workOrderProjectID": null,
- "recurringWorkOrderID": null,
- "isInternal": "0",
- "propertyID": "630",
- "unitID": "607",
- "leaseID": "2746",
- "vendorContactID": "3381",
- "primaryWorkOrderStatusID": "2",
- "workOrderStatusID": "1",
- "vendorWorkOrderStatusID": "2",
- "priorityID": "2",
- "description": "<p> c</p>",
- "isOwnerApproved": "0",
- "isVacant": "0",
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "createdByUserID": "1",
- "dateTimeCreated": "2026-04-22 17:39:33",
- "dateTimeModified": "2026-04-22 17:39:49",
- "portfolioID": "359",
- "assignedToUserID": "381140"
}
}Voids a bill, reversing its accounting impact. The bill remains in the system with
isVoided: "1" and cannot be deleted.
discountBill, markupBill) are generated automatically. To
void those companion bills at the same time, set voidLinkedBills: true in the
request body. If omitted or false, only the parent bill is voided.The void response supports the same includes as GET /accounting/bills/{billID}. Pass a
comma-separated list in the includes query parameter.
| Include name | What it adds |
|---|---|
contact |
Full payee contact record (vendor/owner details, ACH info, insurance). |
charges |
Line-item charges posted to ledgers for this bill. |
bankAccount |
The bank account used to pay this bill. |
leaseCharges |
Tenant-responsible charge transactions, each with property/unit/ledger. |
payouts |
Payouts that have been applied toward this bill. |
workOrder |
The linked work order, if any. |
parentBill |
The parent bill when this is a discount or markup child bill. |
discountBill |
The associated discount bill (voided when voidLinkedBills: true). |
markupBill |
The associated markup bill (voided when voidLinkedBills: true). |
markupDiscount |
Computed markup and discount dollar amounts for the bill. |
utility |
The utility associated with this bill, if any. |
property |
The property associated with this bill, if any. |
GET /accounting/bills/{billID} - Retrieve a bill and its current state.POST /accounting/bills - Create a new bill.| billID required | integer Example: 15051 |
| includes | string Example: includes=contact,charges,workOrder,discountBill,markupBill,leaseCharges Comma-separated list of related data to include in the response.
Available values: |
| voidLinkedBills | boolean When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (bill) |
object or null Payee contact details (if includes=contact). | |
| charges | Array of objects Ledger charge lines (if includes=charges). |
object or null Bank account used for payment (if includes=bankAccount). | |
Array of objects Tenant-responsible charge transactions (if includes=leaseCharges). | |
| payouts | Array of objects Payouts applied to this bill (if includes=payouts). |
object or null Linked work order (if includes=workOrder). | |
object (bill) | |
bill (object) or null The companion discount bill linked to this bill, if any.
Voided alongside the parent when | |
bill (object) or null The companion markup bill linked to this bill, if any.
Voided alongside the parent when | |
object or null Computed markup and discount totals (if includes=markupDiscount). | |
| utility | object or null Linked utility (if includes=utility). |
| property | object or null Linked property (if includes=property). |
{- "voidLinkedBills": true
}{- "bill": {
- "billID": "15051",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "67",
- "billTypeID": "1",
- "bankAccountID": "146",
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "test",
- "serviceAccountNumber": null,
- "description": "test description",
- "workOrderID": "5815",
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "1",
- "isApproved": "1",
- "approvedByUserID": "501195",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}, - "contact": {
- "contactID": "67",
- "contactTypeID": "3",
- "vendorTypeID": "9",
- "name": "Walter's Windows",
- "firstName": null,
- "lastName": null,
- "email": "walter@rentvine.com",
- "phone": "+14436420607",
- "countryID": "US",
- "address": "9470 Corkscrew Palms Cir",
- "address2": null,
- "city": "Naples",
- "stateID": "FL",
- "postalCode": "33928",
- "payoutTypeID": "4",
- "isActive": "1",
- "holdPayments": "0",
- "discountPercent": "10.0000",
- "isBillApprovalExempt": "0",
- "dateTimeCreated": "2023-01-14 18:39:10",
- "dateTimeModified": "2025-11-07 21:37:00",
- "contactType": "Vendor"
}, - "charges": [ ],
- "bankAccount": {
- "bankAccountID": null
}, - "leaseCharges": [
- {
- "transaction": {
- "transactionID": "80842",
- "transactionTypeID": "1",
- "leaseID": "2963",
- "billID": "15051",
- "chargeAccountID": "37",
- "amount": "100.00",
- "amountPaid": "0.00",
- "description": "test description",
- "isVoided": "0",
- "datePosted": "2026-04-22",
- "dateTimeCreated": "2026-04-22 21:59:34",
- "dateTimeModified": "2026-04-22 21:59:34"
}, - "property": {
- "propertyID": "601",
- "address": "9910 Estero Oaks Drive",
- "city": "Fort Myers",
- "stateID": "FL",
- "postalCode": "33967",
- "isActive": "1"
}, - "unit": {
- "unitID": "583",
- "propertyID": "601",
- "address": "9910 Estero Oaks Drive",
- "city": "Fort Myers",
- "stateID": "FL",
- "isActive": "1"
}, - "ledger": {
- "ledgerID": "866",
- "ledgerTypeID": "2",
- "objectID": "297",
- "name": "WalterDeVeasTestPortfolio",
- "isActive": "1"
}, - "restricted": "0"
}
], - "payouts": [ ],
- "workOrder": {
- "workOrderID": "5815",
- "workOrderNumber": "105642",
- "propertyID": "495",
- "unitID": "474",
- "leaseID": "2162",
- "vendorContactID": null,
- "workOrderStatusID": "27",
- "primaryWorkOrderStatusID": "4",
- "priorityID": "2",
- "description": "<p>test</p>",
- "isVacant": "0",
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "dateTimeCreated": "2026-03-17 18:26:08",
- "dateTimeModified": "2026-04-22 21:59:34"
}, - "parentBill": null,
- "discountBill": {
- "billID": "15052",
- "billBatchID": null,
- "parentBillID": "15051",
- "payeeContactID": "1",
- "billTypeID": "2",
- "bankAccountID": null,
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "test",
- "serviceAccountNumber": null,
- "description": null,
- "workOrderID": "5815",
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "1",
- "isApproved": "1",
- "approvedByUserID": "501195",
- "managementFeeBatchID": null,
- "isDiscount": "1",
- "isMarkup": "0",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}, - "markupBill": {
- "billID": "15053",
- "billBatchID": null,
- "parentBillID": "15051",
- "payeeContactID": "1",
- "billTypeID": "2",
- "bankAccountID": null,
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "test",
- "serviceAccountNumber": null,
- "description": null,
- "workOrderID": "5815",
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "1",
- "isApproved": "1",
- "approvedByUserID": "501195",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "1",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": null,
- "utilityPeriodEndDate": null,
- "importAccountCommitID": null
}, - "markupDiscount": {
- "discountAmount": 0,
- "markupAmount": 0
}, - "utility": null,
- "property": null
}Approves a bill, marking it as authorized for payment. Once approved, the bill's
isApproved flag is set to 1 and approvedByUserID is recorded.
Accounting component).400 is returned if the billID is not found.GET /accounting/bills/{billID} — the same includes
query parameter is supported.GET /accounting/bills/{billID} - Retrieve a bill and its current approval state.POST /accounting/bills - Create a bill.POST /accounting/bills/{billID} - Update a bill.DELETE /accounting/bills/{billID} - Void a bill.| billID required | integer Example: 14973 |
| includes | string Example: includes=contact,charges,workOrder Comma-separated list of related data to include in the response.
Available values: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (bill) |
{- "bill": {
- "billID": "14973",
- "billBatchID": null,
- "parentBillID": null,
- "payeeContactID": "1",
- "billTypeID": "1",
- "bankAccountID": "170",
- "billDate": "2026-04-22",
- "dateDue": "2026-04-22",
- "reference": "12345",
- "paymentMemo": "test memo",
- "serviceAccountNumber": "0001",
- "description": "test description",
- "workOrderID": "5954",
- "discountPercent": "0.0000",
- "markupPercent": "0.0000",
- "isVoided": "0",
- "isApproved": "1",
- "approvedByUserID": "501195",
- "managementFeeBatchID": null,
- "isDiscount": "0",
- "isMarkup": "0",
- "managementFeeMode": "2",
- "propertyID": null,
- "utilityID": null,
- "utilityPeriodStartDate": "2026-04-22",
- "utilityPeriodEndDate": "2027-04-22",
- "importAccountCommitID": null
}
}Returns the bill as a PDF: the bill, its payee, and its non-voided charges with their property, unit, ledger and charge account.
portfolioID).application/pdf), not JSON.{"error": "Bill <id> not found"}.GET /accounting/bills/{billID} - The bill as JSON.GET /accounting/bills - List bills.| 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. |
| portfolioID | integer Example: portfolioID=12 Print only the charges in this portfolio. Without it, every charge the caller may access is printed. |
| Cache-Control | string Value: "no-cache" Always |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "error": "Bill 999999999 not found"
}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.
isPaid=false), unapproved (isApproved=false) or needing master approval
(requiresMasterApproval=true) charges, by due date or payee.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.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.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).| 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
|
| isApproved | string or integer or boolean Example: isApproved=0
|
| isPaid | string or integer or boolean Example: isPaid=0
|
| isChildBill | string or integer or boolean
|
| requiresMasterApproval | string or integer or boolean Example: requiresMasterApproval=1
|
| amountMin | number Example: amountMin=100 Only charges whose |
| amountMax | number Example: amountMax=5000 Only charges whose |
| datePostedMin | string Example: datePostedMin=2026-01-01 Only charges posted on or after this day, |
| datePostedMax | string Example: datePostedMax=2026-04-30 Only charges posted on or before this day, |
| billDateMin | string Only charges of bills dated on or after this day, |
| billDateMax | string Only charges of bills dated on or before this day, |
| dateDueMin | string Only charges of bills due on or after this day, |
| dateDueMax | string Only charges of bills due on or before this day, |
| 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 |
| payeeContactID | integer As |
| portfolioIDs[] | Array of integers Only charges in these portfolios; send each as its own |
| portfolioID | integer As |
| propertyIDs[] | Array of integers Only charges on these properties; send each as its own |
| propertyID | integer As |
| unitIDs[] | Array of integers Only charges on these units; send each as its own |
| unitID | integer As |
| assignedToUserIDs[] | Array of integers Only charges on properties assigned to these users; send each as its own |
| billApprovalAssigneeUserIDs[] | Array of integers Only charges of bills whose approval is assigned to these users; |
| tagIDs[] | Array of integers Only charges of bills with any of these tags; send each as its own |
| orderBy | string Example: orderBy=transaction.amount|desc Sort column, optionally followed by |
| 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. |
| pagination-page-size | integer Example: "25" Items on a full page -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
[- {
- "bill": {
- "billID": "265",
- "parentBillID": null,
- "billDate": "2026-03-02",
- "dateDue": "2026-04-01",
- "reference": "INV-20431",
- "isVoided": "0",
- "description": "Kitchen repairs",
- "payeeContactID": "665",
- "isApproved": "0",
- "billApprovalAssigneeUserID": "4393",
- "dateTimeCreated": "2026-11-16 19:38:13",
- "requiresMasterApproval": "1"
}, - "billApprovalAssigneeUser": {
- "userID": "4393",
- "firstName": "Jane",
- "lastName": "Doe"
}, - "transaction": {
- "transactionID": "1159",
- "transactionTypeID": "7",
- "billID": "265",
- "primaryLedgerID": "10375",
- "chargeAccountID": "2750",
- "amount": "150.00",
- "amountPaid": "0.00",
- "description": "Faucet",
- "discountAmount": "2.50",
- "markupAmount": "10.00",
- "isVoided": "0",
- "datePosted": "2026-03-02"
}, - "ledger": {
- "ledgerID": "10375",
- "name": "#368 - 221 Satterfield Neck, Altheafurt, MN 75579",
- "ledgerTypeID": "4"
}, - "portfolio": {
- "portfolioID": "4956",
- "name": "Nikolaus Inc Portfolio",
- "contacts": "[{\"contactID\":\"5\",\"percentOwned\":\"100.00\",\"percentDistributed\":\"100.00\",\"name\":\"Pat Owner\"}]"
}, - "property": {
- "propertyID": "4032",
- "name": "3035 Ora Plain Apt. 941",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "UT",
- "PostalCode": "12345"
}, - "unit": {
- "unitID": "3403",
- "unitName": "#368",
- "unitAddress": "123 Main St",
- "unitAddress2": null,
- "unitCity": "Springfield",
- "unitStateID": "MN",
- "unitPostalCode": "12345"
}, - "chargeAccount": {
- "accountID": "2750",
- "number": "933781",
- "name": "aspernatur non ut"
}, - "contact": {
- "contactID": "665",
- "contactTypeID": "3",
- "name": "Northwind Plumbing"
}
}
]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.
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.
bankAccountID is the only filter: without it, every bank account's deposits are listed. Voided deposits are
included.dateTimeCreated, oldest first).GET /accounting/deposits/search - Search deposits with more filters.GET /accounting/deposits/{depositID} - Retrieve one deposit, with its lines.| bankAccountID | integer Example: bankAccountID=12 Only the deposits into this bank account ( |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the deposit. |
[- {
- "deposit": {
- "depositID": "98",
- "bankAccountID": "419",
- "reconciliationID": "35",
- "previousReconciliationID": "36",
- "depositNumber": "28",
- "description": "Rent Payments",
- "amount": "5491.49",
- "isVoided": "0",
- "dateDeposited": "2026-10-09",
- "dateTimeCreated": "2024-10-02 09:00:00"
}, - "token": "1794856824"
}
]Creates a new bank deposit, optionally adding transactions, bulk payments, and
file attachments in the same request. On success, returns the newly created deposit
(same shape as GET /accounting/deposits/{depositID}).
Accounting > ModifyDeposit permission.transactionID in transactions must exist and pass portfolio restrictions.bulkPaymentID in bulkPayments must exist.attachments array contains fileID values for pre-uploaded files.GET /accounting/deposits/{depositID} and
returns the full deposit detail.GET /accounting/deposits/transactions/undeposited - Retrieve undeposited transactions to include.GET /accounting/deposits/{depositID} - View the created deposit.| bankAccountID required | string or integer^-?[0-9]+$ The bank account to deposit into. |
| dateDeposited required | string <date> The date of the deposit. |
| amount required | string or number <decimal> Total deposit amount as a decimal string. |
| depositNumber | string or null Optional reference number. |
| description | string or null Optional description. |
Array of objects List of transactions to include in this deposit. | |
Array of objects List of bulk payments to include in this deposit. | |
| attachments | Array of integers File IDs of documents to attach to this deposit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
| transactions | Array of objects Deposited transactions (if includes=transactions). |
{- "bankAccountID": 146,
- "depositNumber": "27",
- "description": null,
- "dateDeposited": "2026-04-24",
- "attachments": [ ],
- "transactions": [
- {
- "transactionID": 80911
}, - {
- "transactionID": 78052
}
], - "bulkPayments": [ ],
- "amount": "1400.00"
}{- "deposit": {
- "depositID": "589",
- "bankAccountID": "146",
- "reconciliationID": null,
- "previousReconciliationID": null,
- "depositNumber": "27",
- "description": null,
- "amount": "1400.00",
- "isVoided": "0",
- "dateDeposited": "2026-04-24",
- "dateTimeCreated": "2026-04-24 13:11:51"
}
}Returns 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.
isReconciled=false), or those in one reconciliation.dateDeposited, newest first, then by depositID, highest first.isVoided=false.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.| search | string Example: search=2024-0165 Matches deposits whose |
| bankAccountIDs[] | Array of integers Example: bankAccountIDs[]=12&bankAccountIDs[]=15 Only the deposits into these bank accounts ( |
| bankAccountID | integer Example: bankAccountID=12 Only the deposits into this bank account. Read only when |
| isVoided | string Example: isVoided=false
|
| isReconciled | string Example: isReconciled=false
|
| 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 |
| dateDepositedMax | string Example: dateDepositedMax=2024-12-31 Only deposits made on or before this date, as |
| reconciliationIDs[] | Array of integers Example: reconciliationIDs[]=88&reconciliationIDs[]=89 Only the deposits in these reconciliations ( |
| reconciliationID | integer Example: reconciliationID=88 Only the deposits in this reconciliation. Read only when |
| 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. |
| pagination-page-size | integer Example: "2" Page size used -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
required | object (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 |
[- {
- "deposit": {
- "depositID": "221",
- "bankAccountID": "1811",
- "reconciliationID": "123",
- "previousReconciliationID": "124",
- "depositNumber": "28",
- "description": "Rent Payments",
- "amount": "2797.77",
- "isVoided": "0",
- "dateDeposited": "2026-08-16",
- "dateTimeCreated": "2026-11-16 19:33:12"
}, - "account": {
- "accountID": "1811",
- "parentAccountID": null,
- "accountTypeID": "3",
- "accountCategoryID": null,
- "number": "945789",
- "name": "Operating - Example Bank",
- "isActive": "1",
- "isSubjectToManagementFees": "0",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": "Example Bank",
- "bankAccountTypeID": "2",
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": "6789",
- "bankAccountAddress": "123 Main St",
- "bankAccountAddress2": "Apt 4",
- "bankAccountCity": "Springfield",
- "bankAccountStateID": "IL",
- "bankAccountPostalCode": "12345",
- "bankAccountCountryID": "US",
- "isCheckingEnabled": "1",
- "checkCompanyName": "Example Property Management",
- "checkSignatory": "Jordan Example",
- "checkAddress": "123 Main St",
- "checkAddress2": "Apt 4",
- "checkCity": "Springfield",
- "checkStateID": "IL",
- "checkPostalCode": "12345",
- "checkCountryID": "US",
- "bankAccountNextCheckNumber": "1001",
- "bankAccountNextDepositNumber": "501",
- "checkTemplateID": "203",
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "1",
- "isNachaFileBalanced": "1",
- "nachaOriginName": "Example PM",
- "nachaOriginNumber": "0123456789",
- "nachaDestinationName": "Example Bank",
- "nachaDestinationNumber": "021000021",
- "nachaCompanyIdentification": "1234567890",
- "nachaCompanyName": "Example PM",
- "nachaOriginatingFinancialInstitutionID": "02100002",
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": "Example Export",
- "dateTimeCreated": "2026-11-16 19:33:12",
- "dateTimeModified": "2026-11-16 19:33:12",
- "dateTimeDeactivated": null
}, - "reconciliation": {
- "reconciliationID": "123",
- "reconciliationVersionID": "2",
- "bankAccountID": "1812",
- "statementStartDate": "2026-09-22",
- "statementEndDate": "2026-10-22",
- "statementEndingBalance": "44295.28",
- "isCurrent": "1",
- "isVoided": "0",
- "previousStatementEndingBalance": "24929.38",
- "moneyInTotal": "0.00",
- "moneyOutTotal": "0.00",
- "reconciledMoneyInTotal": "0.00",
- "reconciledMoneyOutTotal": "0.00",
- "unreconciledMoneyInTotal": "0.00",
- "unreconciledMoneyOutTotal": "0.00",
- "reconciledBalance": "0.00",
- "adjustedCashBalance": "0.00",
- "bankAccountBalance": "0.00",
- "undepositedPaymentsBalance": "0.00",
- "paymentsDepositedAfterStatementEndDateBalance": "0.00",
- "unsettledElectronicTransactionsBalance": "0.00",
- "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
- "adjustmentsTotal": "0.00",
- "reconciledAdjustmentsTotal": "0.00",
- "unreconciledAdjustmentsTotal": "0.00",
- "bankAdjustmentBalance": "0.00",
- "bankAccountUndepositedBalance": "0.00",
- "unsettledPaymentBalance": "0.00",
- "unsettledPaymentReturnBalance": "0.00",
- "unsettledPayoutBalance": "0.00",
- "unsettledPayoutReturnBalance": "0.00",
- "createdByUserID": "2",
- "dateTimeCreated": "2026-11-16 19:33:12"
}
}
]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.createdByUserID).bankAccountID is required and must be a bank account; otherwise the API answers 400 (see the examples).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.| bankAccountID required | integer Example: bankAccountID=31 The bank account to list for ( |
| 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: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
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 |
required | object Who recorded the line. |
[- {
- "transaction": {
- "depositTransactionTypeID": "1",
- "objectTypeID": "9",
- "objectID": "701",
- "transactionID": "701",
- "transactionTypeID": "2",
- "bulkPaymentID": null,
- "bulkPaymentTypeID": null,
- "primaryLedgerID": "9460",
- "amount": "220.47",
- "datePosted": "2024-10-02",
- "description": "Rent Payment",
- "reference": "1042"
}, - "ledger": {
- "ledgerID": "9460",
- "ledgerTypeID": "2",
- "name": "OPR93 - Dicki Ltd Portfolio"
}, - "payer": {
- "name": "Kaylee McGlynn"
}, - "property": {
- "propertyID": "3673",
- "name": "122 Lorena Ramp Apt. 374",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "DC",
- "postalCode": "12345",
- "countryID": "US"
}, - "unit": {
- "unitID": "3121",
- "name": "Apt 790",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "IL",
- "postalCode": "12345",
- "countryID": "US"
}, - "createdByUser": {
- "userID": null
}
}, - {
- "transaction": {
- "depositTransactionTypeID": "2",
- "objectTypeID": "84",
- "objectID": "14",
- "transactionID": null,
- "transactionTypeID": null,
- "bulkPaymentID": "14",
- "bulkPaymentTypeID": "1",
- "primaryLedgerID": null,
- "amount": "2616.75",
- "datePosted": "2024-10-02",
- "description": "Officia aut consequuntur qui quam illo.",
- "reference": "2001"
}, - "ledger": {
- "ledgerID": null,
- "ledgerTypeID": null,
- "name": null
}, - "payer": {
- "name": "Berniece Padberg"
}, - "property": {
- "propertyID": null,
- "name": null,
- "address": null,
- "address2": null,
- "city": null,
- "stateID": null,
- "postalCode": null,
- "countryID": null
}, - "unit": {
- "unitID": null,
- "name": null,
- "address": null,
- "address2": null,
- "city": null,
- "stateID": null,
- "postalCode": null,
- "countryID": null
}, - "createdByUser": {
- "userID": "3900"
}
}
]Retrieves one deposit. The response always holds the deposit; the includes parameter adds its lines, its
reconciliations and the caller's access to it.
Access Denied.restrictions.access partial, or full when all are), and its transactions include lists only the payments inside them.access full.Deposit {depositID} not found; a value that isn't a number
answers the stock 404.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.| depositID required | integer Example: 4210 The deposit's ID, from |
| includes | string Example: includes=transactions,reconciliation Comma-separated list of related data to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
Array of objects (deposit_transaction_row) The deposit's lines. Requires the | |
included_reconciliation (object) or null The reconciliation the deposit is in, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the deposit was in before it was last unreconciled, or null. Requires the | |
object The caller's access to the deposit. Requires the |
{- "deposit": {
- "depositID": "245",
- "bankAccountID": "1837",
- "reconciliationID": "126",
- "previousReconciliationID": "127",
- "depositNumber": "28",
- "description": "Rent Payments",
- "amount": "9944.32",
- "isVoided": "0",
- "dateDeposited": "2026-08-10",
- "dateTimeCreated": "2026-11-16 19:33:17"
}
}Updates editable fields on an existing deposit. Only depositNumber, description, and dateDeposited may
be changed after creation, and only the keys sent change: keys left out keep their values. On success, returns
the updated deposit (same shape as GET /accounting/deposits/{depositID}).
Accounting › ModifyDeposit), checked first: a key without it
gets the 403 even for a deposit that doesn't exist.Access Denied for a deposit outside them.{"isVoided": ["Cannot modify voided deposit"]}), a reconciled one, a
missing or empty body, and a field that breaks its limit (see the request body).bankAccountID and amount cannot be changed after creation: sent in the body, they are ignored.depositID answers the stock 404.GET /accounting/deposits/{depositID} and honours its includes (transactions,
reconciliation, previousReconciliation, restrictions), whose objects aren't documented on this
operation yet.Deposit Updated entry to the deposit's history log when a field changes. No transaction or ledger
entry is written.PUT /accounting/deposits/{depositID} - the same update with PUTPOST /accounting/deposits/{depositID}/transactions - Add/remove transactions.DELETE /accounting/deposits/{depositID} - Void the deposit.| depositID required | integer Example: 4210 The ID of the deposit to update, from |
| depositNumber | string [ 1 .. 100 ] characters Updated reference number, up to 100 characters. The deposit must always have one: |
| description | string or null <= 1000 characters Updated description, up to 1000 characters. |
| dateDeposited | string <date> Updated deposit date. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
{- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "dateDeposited": "2024-10-23"
}{- "deposit": {
- "depositID": "74",
- "bankAccountID": "220",
- "reconciliationID": null,
- "previousReconciliationID": "23",
- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "amount": "5045.71",
- "isVoided": "0",
- "dateDeposited": "2024-10-23",
- "dateTimeCreated": "2026-11-12 07:48:39"
}
}The same update as POST /accounting/deposits/{depositID}, sent with PUT: the same body, rules, side effects and
responses, including the includes it honours. It is not a full replacement: keys left out keep their values.
POST /accounting/deposits/{depositID} - the same update with POST| depositID required | integer Example: 4210 The ID of the deposit to update, from |
| depositNumber | string [ 1 .. 100 ] characters Updated reference number, up to 100 characters. The deposit must always have one: |
| description | string or null <= 1000 characters Updated description, up to 1000 characters. |
| dateDeposited | string <date> Updated deposit date. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
{- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "dateDeposited": "2024-10-23"
}{- "deposit": {
- "depositID": "74",
- "bankAccountID": "220",
- "reconciliationID": null,
- "previousReconciliationID": "23",
- "depositNumber": "29",
- "description": "October rent deposits (revised)",
- "amount": "5045.71",
- "isVoided": "0",
- "dateDeposited": "2024-10-23",
- "dateTimeCreated": "2026-11-12 07:48:39"
}
}Voids a deposit, reversing its effect on the bank account balance. The deposit record
is marked isVoided = 1 and the associated transactions are undeposited. Returns the
deposit record after voiding.
Accounting > VoidDeposit permission.POST /accounting/deposits/{depositID}/reconcile - Reconcile a deposit instead of voiding.GET /accounting/deposits/{depositID} - Check deposit state before voiding.| depositID required | integer Example: 4210 The ID of the deposit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| depositID required | string^-?[0-9]+$ Unique identifier for the deposit. |
| bankAccountID required | string^-?[0-9]+$ The bank account the deposit was made into ( |
| 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"
|
| dateDeposited required | string <date> The date the deposit was made. |
| dateTimeCreated required | string When the deposit record was created. UTC, formatted |
{- "depositID": "33",
- "bankAccountID": "31",
- "reconciliationID": null,
- "previousReconciliationID": "22",
- "depositNumber": "54",
- "description": "December rent deposits",
- "amount": "11781.00",
- "isVoided": "1",
- "dateDeposited": "2021-12-14",
- "dateTimeCreated": "2021-12-14 20:35:15"
}Adds one or more transactions (and/or bulk payments) to an existing deposit. This endpoint is used to incrementally build up a deposit rather than specifying all transactions at creation time.
Accounting > ModifyDeposit permission.transactionID in transactions must exist and pass portfolio access checks.bulkPaymentID in bulkPayments must exist.{ "success": true } on success, not the updated deposit. Fetch the deposit
separately via GET /accounting/deposits/{depositID}?includes=transactions to see
the updated state.GET /accounting/deposits/transactions/undeposited - Get available undeposited transactions.GET /accounting/deposits/{depositID} - View the deposit with transactions included.| depositID required | integer Example: 4210 The ID of the deposit to add transactions to. |
| transactions | Array of integers List of transaction IDs to add to the deposit. |
| bulkPayments | Array of integers List of bulk payment IDs to add to the deposit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| success required | boolean |
{- "transactions": [
- 9903,
- 9904
]
}{- "success": true
}Renders the deposit's slip as a PDF and streams it as the response body (Content-Type: application/pdf), with
no JSON envelope.
Access Denied; a deposit with neither (one whose payments are all voided, for example) is printed for every key.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.| depositID required | integer Example: 4210 The deposit's ID, from |
| Cache-Control | string Example: "no-cache" Always |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "error": "Deposit 999999999 not found"
}Marks a deposit as reconciled, optionally linking it to an existing reconciliation record. This performs a single-item reconciliation (as opposed to a full bank statement reconciliation). On success, returns the updated deposit detail.
reconciliationID.Accounting > ModifyDeposit and Accounting > ModifyReconciliations
permissions.reconciliationID is provided and the reconciliation exists, the deposit is
linked to it. If no ID is provided, a new reconciliation record is created.isSingleTransaction flag is set internally — this action reconciles this
deposit only, not all items in a reconciliation batch.GET /accounting/deposits/{depositID}.POST /accounting/deposits/{depositID}/unreconcile - Reverse this reconciliation.GET /accounting/deposits/{depositID}?includes=reconciliation - Check reconciliation state.| depositID required | integer Example: 4210 The ID of the deposit to reconcile. |
| reconciliationID | string or integer or null^-?[0-9]+$ The ID of an existing reconciliation to link this deposit to. If omitted or null, a new reconciliation record is created. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
{- "reconciliationID": 88
}{- "deposit": {
- "depositID": "4210",
- "bankAccountID": "12",
- "reconciliationID": "88",
- "previousReconciliationID": null,
- "depositNumber": "DEP-2024-001",
- "description": "October rent deposits",
- "amount": "5250.00",
- "isVoided": "0",
- "dateDeposited": "2024-10-22",
- "dateTimeCreated": "2024-10-22 14:00:00"
}
}Removes the reconciliation link from a deposit, reverting it to an unreconciled
state. On success, returns the updated deposit detail with reconciliationID set
to null.
Accounting > ModifyDeposit and Accounting > ModifyReconciliations
permissions.previousReconciliationID field on the deposit will record the reconciliation
that was removed.GET /accounting/deposits/{depositID}.POST /accounting/deposits/{depositID}/reconcile - Reconcile the deposit again.GET /accounting/deposits/{depositID}?includes=reconciliation - Check current reconciliation state.| depositID required | integer Example: 4210 The ID of the deposit to unreconcile. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (deposit) A bank deposit groups one or more payment transactions (and bulk payments) into a
single deposited amount that can be reconciled against a bank statement. Deposits
belong to a bank account and track their reconciliation state via |
{- "deposit": {
- "depositID": "4210",
- "bankAccountID": "12",
- "reconciliationID": null,
- "previousReconciliationID": "88",
- "depositNumber": "DEP-2024-001",
- "description": "October rent deposits",
- "amount": "5250.00",
- "isVoided": "0",
- "dateDeposited": "2024-10-22",
- "dateTimeCreated": "2024-10-22 14:00:00"
}
}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.
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.
invoiceStatusIDs[]=2).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.name[]= (invoiceStatusIDs[]=1&invoiceStatusIDs[]=2).
The singular form is used only
when the plural one is absent.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.| 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 |
| 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 |
| payeeContactIDs[] | Array of integers Example: payeeContactIDs[]=210 Only invoices owed to these payee contacts; send each as its own |
| payeeContactID | integer Only invoices owed to this payee contact; ignored when |
| 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. |
| assignedToUserID | integer As |
| 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 |
| workOrderID | integer As |
| billIDs[] | Array of integers Only invoices converted to these bills; send each as its own |
| billID | integer As |
| dateCreatedMin | string Example: dateCreatedMin=2026-01-01 Only invoices created on or after this day in the account's time zone, |
| dateCreatedMax | string Example: dateCreatedMax=2026-01-31 Only invoices created on or before this day in the account's time zone, |
| 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. |
| pagination-page-size | integer Example: "25" Items on a full page -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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). |
[- {
- "invoice": {
- "invoiceID": "117",
- "invoiceTypeID": "2",
- "invoiceStatusID": "3",
- "invoiceSourceID": "1",
- "invoiceFileID": "15",
- "payeeContactID": "641",
- "billID": "254",
- "workOrderID": "98",
- "reference": "INV-5521",
- "declinedMessage": null,
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-01-02 12:00:00",
- "predictedReference": "INV-5521",
- "predictedServiceAccountNumber": "SA-1188",
- "predictedFields": {
- "amount": {
- "value": "84.50",
- "source": "predicted",
- "confidence": 0.91
}, - "ledger": null,
- "payeeContact": null
}
}, - "invoiceFile": {
- "fileID": "15",
- "title": "Statement Batch - 11/16/2026",
- "fileType": "pdf",
- "isImage": "0"
}, - "contact": {
- "contactID": "641",
- "name": "Invoices Controller Vendor",
- "contactTypeID": "3"
}, - "workOrder": {
- "workOrderID": "98",
- "workOrderNumber": "100001",
- "assignedToUserID": "3"
}, - "bill": {
- "billID": "254",
- "reference": "CR670669"
}, - "submittedBy": {
- "userID": "4377",
- "firstName": "Jane",
- "lastName": "Doe",
- "email": "jane.doe@example.com"
}, - "createdInvoice": {
- "total": "84.50",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "NM",
- "ledgerID": "10351",
- "addressFull": "885 Klocko Turnpike Suite 777, Carmelburgh, NM"
}, - "property": {
- "assignedToUserID": null
}
}
]Uploads an invoice PDF or image file. The file is stored and an invoice record is
created in Processing status. The AI extraction service processes the file
asynchronously and populates the predicted* fields when complete. The invoice
transitions to Ready status once extraction is done.
multipart/form-data with the file as the first upload.invoiceStatusID=1 (Processing) and
invoiceSourceID=2 (Upload).GET /accounting/invoices/{invoiceID} and returns the
full invoice detail.predicted* fields will
be populated after a short delay.GET /accounting/invoices/{invoiceID} - Poll for updated prediction results.POST /accounting/invoices/{invoiceID}/decline - Decline an invoice after review.| file required | string <binary> The invoice PDF or image file to upload. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (invoice) An invoice is an inbound document (uploaded PDF or vendor-created line-item entry)
that can be reviewed, converted to a bill, or declined. The |
| lineItems required | Array of objects Line items (empty until AI extraction completes). |
{- "invoice": {
- "invoiceID": "1299",
- "receivedInvoiceEmailID": "5001",
- "invoiceTypeID": "1",
- "invoiceStatusID": "1",
- "invoiceSourceID": "2",
- "invoiceFileID": "9753",
- "payeeContactID": "150",
- "billID": "201",
- "workOrderID": "301",
- "reference": "INV-2026-001",
- "submittedByUserID": "501195",
- "submittedByEmail": "manager@example.com",
- "declinedMessage": "Invoice requires additional review.",
- "predictedFields": {
- "amount": {
- "value": "375.00"
}, - "ledger": {
- "value": "Operating Account"
}, - "dueDate": {
- "value": "2026-05-15"
}, - "billDate": {
- "value": "2026-04-27"
}, - "accountID": {
- "value": 50
}, - "lineItems": [ ],
- "reference": {
- "value": "INV-4421"
}, - "workOrderID": {
- "value": 301
}, - "payeeContact": {
- "value": 210
}, - "serviceEndDate": {
- "value": "2026-04-30"
}, - "defaultDiscount": {
- "value": "5.00"
}, - "serviceStartDate": {
- "value": "2026-04-01"
}, - "serviceAccountNumber": {
- "value": "SVC-001"
}
}, - "predictedPayeeContactID": "210",
- "predictedPayeeContactName": "Acme Plumbing",
- "predictedDefaultDiscount": "5.00",
- "predictedWorkOrderID": "301",
- "predictedLedgerID": "401",
- "predictedLedgerAddress": "123 Main St",
- "predictedAccountID": "50",
- "predictedBillDate": "2026-04-27",
- "predictedDueDate": "2026-05-15",
- "predictedReference": "INV-4421",
- "predictedServiceAccountNumber": "SVC-001",
- "predictedAmount": "375.00",
- "predictedServiceStartDate": "2026-04-01",
- "predictedServiceEndDate": "2026-04-30",
- "datePosted": "2026-04-27",
- "dateTimeCreated": "2026-04-27 12:38:52"
}, - "lineItems": [ ]
}Returns one invoice with its line items, and the related records the includes parameter asks for.
predictedInvoice).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.{"error": "Invoice <id> not found"}.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.| 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. |
| includes | string Example: includes=contact,invoiceFile,workOrder,property Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
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; | |
invoice_predicted_invoice (object) or null The prediction service's record for the invoice, or null. Requires the | |
file (object) or boolean or null The uploaded file; | |
Array of objects Files attached to the invoice and shared with the vendor. Requires the | |
included_work_order (object) or null The invoice's work order, or null. Requires the | |
included_unit (object) or null The work order's unit. Requires the | |
included_property (object) or null The work order's property. Requires the | |
included_lease (object) or null The work order's lease. Requires the | |
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 |
{- "invoice": {
- "invoiceID": "128",
- "receivedInvoiceEmailID": null,
- "invoiceTypeID": "1",
- "invoiceStatusID": "1",
- "invoiceSourceID": "2",
- "invoiceFileID": "18",
- "payeeContactID": "647",
- "billID": null,
- "workOrderID": null,
- "reference": "IZ87654",
- "submittedByUserID": null,
- "submittedByEmail": null,
- "declinedMessage": null,
- "predictedFields": null,
- "predictedPayeeContactID": null,
- "predictedPayeeContactName": null,
- "predictedDefaultDiscount": null,
- "predictedWorkOrderID": null,
- "predictedLedgerID": null,
- "predictedLedgerAddress": null,
- "predictedAccountID": null,
- "predictedBillDate": null,
- "predictedDueDate": null,
- "predictedReference": null,
- "predictedServiceAccountNumber": null,
- "predictedAmount": null,
- "predictedServiceStartDate": null,
- "predictedServiceEndDate": null,
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-01-11 12:00:00"
}, - "lineItems": [
- {
- "description": "Service call",
- "amount": "95.00",
- "unitPrice": "95.00",
- "quantity": "1",
- "productCode": null
}
]
}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.
application/pdf), not JSON.{"error": "Invoice not found"}.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.| 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. |
| Cache-Control | string Value: "no-cache" Always |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "error": "Invoice not found"
}Declines an invoice, setting its status to Declined (4) and optionally sending
a decline notification to the vendor. On success, returns the updated invoice detail.
invoiceStatusID is set to 4 (Declined) internally regardless of
the value provided in the request body.declinedMessage is stored on the invoice and included in the notification email
if sendNotification is true.sendNotification defaults to true if not provided in the request body.GET /accounting/invoices/{invoiceID} and returns the
full invoice detail.GET /accounting/invoices/{invoiceID} - View the declined invoice.POST /accounting/invoices/upload - Upload a replacement invoice.| invoiceID required | integer Example: 8850 The ID of the invoice to decline. |
| declinedMessage | string or null Message explaining why the invoice was declined. Sent to the vendor if |
| sendNotification | boolean Default: true Whether to send a decline notification email to the vendor. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (invoice) An invoice is an inbound document (uploaded PDF or vendor-created line-item entry)
that can be reviewed, converted to a bill, or declined. The |
| lineItems required | Array of objects |
{- "declinedMessage": "Invoice amount does not match the approved work order estimate.",
- "sendNotification": true
}{- "invoice": {
- "invoiceID": "1299",
- "receivedInvoiceEmailID": "5001",
- "invoiceTypeID": "1",
- "invoiceStatusID": "4",
- "invoiceSourceID": "2",
- "invoiceFileID": "9753",
- "payeeContactID": "150",
- "billID": "201",
- "workOrderID": "301",
- "reference": "INV-2026-001",
- "submittedByUserID": "501195",
- "submittedByEmail": "manager@example.com",
- "declinedMessage": "test",
- "predictedFields": {
- "amount": {
- "value": "375.00"
}, - "ledger": {
- "value": "Operating Account"
}, - "dueDate": {
- "value": "2026-04-27"
}, - "billDate": {
- "value": "2026-04-27"
}, - "accountID": {
- "value": 50
}, - "lineItems": [ ],
- "reference": {
- "value": "INV-4421"
}, - "workOrderID": {
- "value": 301
}, - "payeeContact": {
- "value": 210
}, - "serviceEndDate": {
- "value": "2026-04-30"
}, - "defaultDiscount": {
- "value": "5.00"
}, - "serviceStartDate": {
- "value": "2026-04-01"
}, - "serviceAccountNumber": {
- "value": "SVC-001"
}
}, - "predictedPayeeContactID": "210",
- "predictedPayeeContactName": "Acme Plumbing",
- "predictedDefaultDiscount": "5.00",
- "predictedWorkOrderID": "301",
- "predictedLedgerID": "401",
- "predictedLedgerAddress": "123 Main St",
- "predictedAccountID": "50",
- "predictedBillDate": "2026-04-27",
- "predictedDueDate": "2026-04-27",
- "predictedReference": "INV-4421",
- "predictedServiceAccountNumber": "SVC-001",
- "predictedAmount": "375.00",
- "predictedServiceStartDate": "2026-04-01",
- "predictedServiceEndDate": "2026-04-30",
- "datePosted": "2026-04-27",
- "dateTimeCreated": "2026-04-27 12:38:52"
}, - "lineItems": [ ]
}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.
Returns an array of {"ledger": {...}} items matching the given search criteria, with no paging.
At least one of search or ledgerIDs must be provided: a request with neither
(an empty search counts as none) is refused with a 400 whose body is the bare
JSON string "Search Failed".
search to find ledgers by name.ledgerIDs to fetch a known set of ledgers by ID.ledgerTypeID with search to narrow results to
a specific ledger type (e.g. only property operating accounts).ledgerIDs[] lookup drops any ID these filters leave
out, with no error.search and ledgerIDs[] together must both match. search=0 counts as no search (the 400).1) are left
out. This is an account setting, not a permission: every key on the account gets the same rows.search
can return over a thousand ledgers. A search of only spaces matches every ledger.ledgerIDs[] values that aren't positive integers are dropped; when none is left the answer is 200 [], not theledgerIDs=100 (no brackets) is read as a one-item list; a comma list (100,101) isn't split.ledgerTypeID of 0, or one that isn't a number, is ignored (no type filter); any other value outside 1 to 4
matches nothing: 200 [].GET /accounting/ledgers/search — Paginated ledger search with extended filters.GET /accounting/ledgers/{ledgerID} (undocumented) — Retrieve a single ledger with optional includes.| search | string Example: search=Operating Search string matched against the ledger name. |
| ledgerTypeID | integer Enum: 1 2 3 4 Example: ledgerTypeID=2 Filter results to a single ledger type.
|
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=100&ledgerIDs[]=101 Filter by one or more ledger IDs. Pass each value as a separate
query parameter: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (ledger) |
[- {
- "ledger": {
- "ledgerID": "100",
- "ledgerTypeID": "2",
- "name": "Operating Account",
- "objectID": "500",
- "isActive": "1"
}
}, - {
- "ledger": {
- "ledgerID": "101",
- "ledgerTypeID": "2",
- "name": "Security Deposit Account",
- "objectID": "501",
- "isActive": "1"
}
}
]Returns a page of ledgers. Each row holds the ledger under ledger and, for a unit's ledger, the unit under
unit.
search, narrowed to some types with ledgerTypeIDs[].ledgerID or ledgerIDs[].dateTimeModifiedMin.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.ledgerID, newest first.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 onlyGET /accounting/ledgers/{ledgerID} (undocumented) - one ledger, with includes| search | string Example: search=Operating Substring matched against the ledger's name. |
| isActive | string or integer or boolean Example: isActive=1
|
| ledgerID | integer Example: ledgerID=100 One ledger, by ID. A value that isn't a number, or |
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=100&ledgerIDs[]=101 Ledgers, by ID, each as a separate |
| 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 |
| 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 |
| 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 |
| 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 |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "ledger": {
- "ledgerID": "8031",
- "ledgerTypeID": "4",
- "objectID": "2802",
- "name": "Marlowe Unit Ledger",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:20:53",
- "dateTimeModified": "2026-11-16 19:20:53"
}, - "unit": {
- "unitID": "2802",
- "propertyID": "3188",
- "name": "#742",
- "address": "123 Main St",
- "address2": "Apt 4",
- "leaseID": "224"
}
}
]A reconciliation matches a bank account's records against one bank statement: the deposits, payments, transfers and adjustments the statement cleared are marked reconciled, and the period's balances and transactions are recorded. Each bank account has one current reconciliation, the newest; the next one starts the day after it ends. List, read, complete (create) and void reconciliations here. Single payment returns and bank fees are reconciled into an existing reconciliation, or removed from it, with POST /accounting/transactions/{transactionID}/reconcile and /unreconcile; deposits with their own endpoints. Keys restricted to portfolio groups can't list, read, complete or void reconciliations, since a reconciliation spans every portfolio that uses the bank account.
Lists completed bank reconciliations, newest statement first, with the bank account each one belongs to. Voided
reconciliations are listed too, unless isVoided filters them out.
bankAccountID with isCurrent=true) before reconciling a
transaction into it.excludeInBalanceReconciliations=true).{"error": "Access Denied"}: a reconciliation spans every
portfolio that uses the bank account, so restricted keys can't read reconciliations at all.statementEndDate, newest first, then by reconciliationID, highest first.true/false/1/0/yes/no) is ignored, and the list comes back unfiltered by it.GET /accounting/reconciliations/{reconciliationID} - One reconciliation, with its transactions and balances.POST /accounting/reconciliations - Complete a reconciliation.GET /accounting/bank-accounts - The bank accounts to filter by.| search | string Example: search=Operating Keeps the reconciliations whose statement ending balance equals this value exactly, or whose bank account's number, name or bank name contains it. Send a number ( |
| bankAccountID | integer Example: bankAccountID=124 Keeps one bank account's reconciliations. Bank account IDs come from |
| bankAccountIDs[] | Array of integers Keeps the reconciliations of any of these bank accounts. Send each ID as its own |
| isCurrent | string Example: isCurrent=true
|
| isVoided | string Example: isVoided=false
|
| statementEndingBalanceMin | string Example: statementEndingBalanceMin=1000.00 Keeps the reconciliations whose statement ending balance is at least this amount. Ignored when it isn't a number. |
| statementEndingBalanceMax | string Example: statementEndingBalanceMax=50000.00 Keeps the reconciliations whose statement ending balance is at most this amount. Ignored when it isn't a number. |
| statementStartDateMin | string Example: statementStartDateMin=2026-01-01 Keeps the statements that start on or after this date ( |
| statementStartDateMax | string Example: statementStartDateMax=2026-12-31 Keeps the statements that start on or before this date ( |
| statementEndDateMin | string Example: statementEndDateMin=2026-01-01 Keeps the statements that end on or after this date ( |
| statementEndDateMax | string Example: statementEndDateMax=2026-12-31 Keeps the statements that end on or before this date ( |
| excludeInBalanceReconciliations | string Example: excludeInBalanceReconciliations=true
|
| page | integer Default: 1 The page to return. A value below 1 is read as 1. |
| pageSize | integer Default: 25 Items per page (default 25). There is no upper limit; 0, a negative value or a value that isn't a number serves 15. |
| pagination-page-size | integer Example: "3" The page size used, or the number of matching reconciliations when that is smaller; 15 when nothing matches. |
| pagination-total-items | integer Example: "3" Total number of matching reconciliations across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (reconciliation_list_item) A reconciliation as |
required | object The bank account the reconciliation belongs to. |
[- {
- "reconciliation": {
- "reconciliationID": "21",
- "reconciliationVersionID": "2",
- "bankAccountID": "124",
- "statementStartDate": "2026-03-01",
- "statementEndDate": "2026-03-31",
- "statementEndingBalance": "5250.00",
- "isCurrent": "1",
- "isVoided": "0",
- "previousStatementEndingBalance": "29868.81",
- "moneyInTotal": "0.00",
- "moneyOutTotal": "0.00",
- "reconciledMoneyInTotal": "0.00",
- "reconciledMoneyOutTotal": "0.00",
- "unreconciledMoneyInTotal": "0.00",
- "unreconciledMoneyOutTotal": "0.00",
- "reconciledBalance": "0.00",
- "adjustedCashBalance": "0.00",
- "bankAccountBalance": "0.00",
- "undepositedPaymentsBalance": "0.00",
- "paymentsDepositedAfterStatementEndDateBalance": "0.00",
- "unsettledElectronicTransactionsBalance": "0.00",
- "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
- "adjustmentsTotal": "0.00",
- "reconciledAdjustmentsTotal": "0.00",
- "unreconciledAdjustmentsTotal": "0.00",
- "bankAdjustmentBalance": "0.00",
- "bankAccountUndepositedBalance": "0.00",
- "unsettledPaymentBalance": "0.00",
- "unsettledPaymentReturnBalance": "0.00",
- "unsettledPayoutBalance": "0.00",
- "unsettledPayoutReturnBalance": "0.00",
- "createdByUserID": "2",
- "dateTimeCreated": "2026-11-14 21:06:46",
- "changeTransactionBalance": "0.00"
}, - "account": {
- "accountID": "124",
- "parentAccountID": null,
- "accountTypeID": "3",
- "accountCategoryID": null,
- "number": "352298",
- "name": "Operating Checking",
- "isActive": "1"
}
}
]Completes a bank reconciliation: marks the transactions cleared on the bank statement as reconciled, and records the statement period, its balances and a snapshot of the period's transactions. The new reconciliation becomes the bank account's current one.
POST /files).Accounting › ModifyReconciliations); without it the
API answers 403 {"error": "Permission Denied"}.{"error": "Access Denied"}.statementStartDate says. statementStartDate is used, and required, only when the bank account has no
current reconciliation: its first, or after every reconciliation it had was voided.statementEndingBalance must equal the current reconciliation's ending balance (0.00 when there is none), plus
the money-in items in transactions, minus the money-out items; otherwise 400 Failed reconciled balance check.transactions must still be unreconciled and dated on or before statementEndDate, with the
amount and date it has now, and sent once. Its reconciliationTransactionTypeID and reconciliationObjectTypeID
must be the pair the item is listed under: money in (1) for a deposit (4), a bank transfer in (2) or a
payout return (11); money out (2) for a payout (5), a payment return (9), a bank fee (10) or a bank
transfer out (3); either direction for a bank adjustment (1), a transaction entry (7) or a settlement (8),
as its amount goes. The transaction type Adjustment (3) and the object type Transaction (6) never match. The items reconcilable for a period, with
their pairs, amounts and dates, are the ones GET /accounting/reconciliations/unreconciled (undocumented) lists.This reconciliation is being updated, please try again. Retry a moment later.transactions; bankAccountID; the end date and ending
balance; whether every item can still be reconciled, once; the balance; each item's amount and date; that the
ledgers' balances add up to the bank balance; the new record's own rules (a bank account, a start date when there
is no current reconciliation, an end date not before the start); then attachments.statementEndingBalance and each item's amount are decimal numbers: a string such as "2450.00", or a JSON
number. Each item's reconciliationObjectTypeID is one of the listed values.viewState and matches, which the Manager screen sends for Bank Sync, are optional and left out here.transactions is marked reconciled with the new reconciliation's ID.statementEndDate (older ones included) is copied to the
reconciliation's transactions include, with whether it was reconciled; payments and payouts that couldn't be
reconciled go to unreconcilableTransactions, and the ledgers' balances to ledgerBalances.attachments is attached to the reconciliation. Supporting documents and bank statements attached
to the bank account's in-progress reconciliation move to the new one, which then ends.matchedBankTransactions) needs matches, which this reference leaves out, so a reconciliation created without
it links none.GET /accounting/reconciliations/{reconciliationID} - Read the reconciliation back with its includes.DELETE /accounting/reconciliations/{reconciliationID} - Void it.GET /accounting/bank-accounts - The bank accounts to reconcile.| bankAccountID required | string or integer^-?[0-9]+$ The bank account being reconciled, from |
| statementEndDate required | string Last day of the statement period ( |
| statementEndingBalance required | string or number <decimal> ^-?[0-9]+(\.[0-9]+)?$ The ending balance on the bank statement, as a decimal number. |
required | Array of objects The items the statement cleared. Send an empty array when it cleared none. |
| statementStartDate | string First day of the statement period ( |
| attachments | Array of strings or integers[ items^-?[0-9]+$ ] Files to attach to the reconciliation, by |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| reconciliationID required | string^-?[0-9]+$ Unique identifier for the reconciliation record. |
| reconciliationVersionID required | integer Value: 2 Always |
| bankAccountID required | string or integer^-?[0-9]+$ The bank account, exactly as the request sent it (a string or a number). |
| statementStartDate required | string <date> Start of the statement period, as |
| statementEndDate required | string <date> End of the statement period, as |
| statementEndingBalance required | string or number <decimal> The statement's ending balance, exactly as the request sent it (a string or a number). |
| isCurrent required | integer Value: 1 Always |
| isVoided required | integer Value: 0 Always |
| previousStatementEndingBalance required | string or number <decimal> The previous reconciliation's ending balance: a decimal string read from it, or the number |
| moneyInTotal required | number Total money-in (credits) for the period. Computed by the API and sent as a JSON number ( |
| moneyOutTotal required | number Total money-out (debits) for the period. Computed by the API and sent as a JSON number ( |
| reconciledMoneyInTotal required | number Total reconciled credits for the period. Computed by the API and sent as a JSON number ( |
| reconciledMoneyOutTotal required | number Total reconciled debits for the period. Computed by the API and sent as a JSON number ( |
| unreconciledMoneyInTotal required | number Total unreconciled credits remaining. Computed by the API and sent as a JSON number ( |
| unreconciledMoneyOutTotal required | number Total unreconciled debits remaining. Computed by the API and sent as a JSON number ( |
| reconciledBalance required | number Net reconciled balance (credits minus debits). Computed by the API and sent as a JSON number ( |
| adjustedCashBalance required | number Adjusted cash balance after reconciliation adjustments. Computed by the API and sent as a JSON number ( |
| bankAccountBalance required | string <decimal> Current bank account balance as of the statement end date. |
| undepositedPaymentsBalance required | string <decimal> Total value of payments not yet deposited. |
| paymentsDepositedAfterStatementEndDateBalance required | string <decimal> Payments deposited after the statement end date. |
| unsettledElectronicTransactionsBalance required | string <decimal> Balance of electronic transactions not yet settled. |
| electronicTransactionsSettledAfterStatementEndDateBalance required | string <decimal> Electronic transactions settled after the statement end date. |
| adjustmentsTotal required | number Value: 0 Total value of all reconciliation adjustments. Always |
| reconciledAdjustmentsTotal required | number Value: 0 Total value of reconciled adjustments. Always |
| unreconciledAdjustmentsTotal required | number Value: 0 Total value of unreconciled adjustments. Always |
| bankAdjustmentBalance required | number Value: 0 Net bank adjustment balance. Always |
| bankAccountUndepositedBalance required | number Value: 0 Undeposited balance in the bank account. Always |
| unsettledPaymentBalance required | number Value: 0 Balance of unsettled incoming payments. Always |
| unsettledPaymentReturnBalance required | number Value: 0 Balance of unsettled returned payments. Always |
| unsettledPayoutBalance required | number Value: 0 Balance of unsettled outgoing payouts. Always |
| unsettledPayoutReturnBalance required | number Value: 0 Balance of unsettled returned payouts. Always |
| createdByUserID required | string^-?[0-9]+$ ID of the user who created this reconciliation ( |
| dateTimeCreated required | string When the reconciliation was created. UTC, formatted |
{- "bankAccountID": 395,
- "statementStartDate": "2026-04-01",
- "statementEndDate": "2026-04-30",
- "statementEndingBalance": "2450.00",
- "transactions": [
- {
- "reconciliationTransactionTypeID": 1,
- "reconciliationObjectTypeID": 4,
- "objectID": 59,
- "amount": "2450.00",
- "datePosted": "2026-04-10"
}
], - "attachments": [
- 28
]
}{- "reconciliationID": "205",
- "reconciliationVersionID": 2,
- "bankAccountID": 395,
- "statementStartDate": "2026-04-01",
- "statementEndDate": "2026-04-30",
- "statementEndingBalance": "2450.00",
- "isCurrent": 1,
- "isVoided": 0,
- "previousStatementEndingBalance": 0,
- "moneyInTotal": 2450,
- "moneyOutTotal": 0,
- "reconciledMoneyInTotal": 2450,
- "reconciledMoneyOutTotal": 0,
- "unreconciledMoneyInTotal": 0,
- "unreconciledMoneyOutTotal": 0,
- "reconciledBalance": 2450,
- "adjustedCashBalance": 0,
- "bankAccountBalance": "0.00",
- "undepositedPaymentsBalance": "0.00",
- "paymentsDepositedAfterStatementEndDateBalance": "0.00",
- "unsettledElectronicTransactionsBalance": "0.00",
- "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
- "adjustmentsTotal": 0,
- "reconciledAdjustmentsTotal": 0,
- "unreconciledAdjustmentsTotal": 0,
- "bankAdjustmentBalance": 0,
- "bankAccountUndepositedBalance": 0,
- "unsettledPaymentBalance": 0,
- "unsettledPaymentReturnBalance": 0,
- "unsettledPayoutBalance": 0,
- "unsettledPayoutReturnBalance": 0,
- "createdByUserID": "138",
- "dateTimeCreated": "2026-11-14 21:18:00"
}Returns one completed (or voided) bank reconciliation, with the related records the includes parameter asks
for: the bank account, the snapshot of the period's transactions taken at completion, the transactions that
couldn't be reconciled, the changes made after completion, the ledger balances and the Bank Sync matches.
transactions and ledgerBalances.reconciliationChangeTransactions, changeTransactionBalance).{"error": "Access Denied"}.{"error": "Reconciliation <id> not found"}.bankAccount - The bank account, every column of it.transactions - Every unreconciled item dated on or before the statement end date when the reconciliation was
completed (older ones included), cleared or not.unreconcilableTransactions - The payments and payouts in the period that couldn't be reconciled at completion,
grouped by why; every group is always sent, as an empty list when it has none.reconciliationChangeTransactions - The transactions reconciled into or removed from the reconciliation on their
own after completion, leaving out the ones a void cancelled. Also adds changeTransactionBalance.ledgerBalances - Each ledger's balance in the bank account at the statement end date, leaving out ledgers whose
balances are both zero.matchedBankTransactions - The Bank Sync transactions confirmed as matches for the cleared items, grouped by
item.GET /accounting/reconciliations - List reconciliations.DELETE /accounting/reconciliations/{reconciliationID} - Void this reconciliation.POST /accounting/transactions/{transactionID}/reconcile - Reconcile one more transaction into it.| reconciliationID required | integer Example: 116 The reconciliation's ID, from |
| includes | string Example: includes=transactions,ledgerBalances Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object The period's payments and payouts that couldn't be reconciled at completion, by reason. Requires the | |
Array of objects The changes made after completion, without the voided ones. Requires the | |
| changeTransactionBalance | number Net of the changes in |
Array of objects Each ledger's share of the bank account's balance at the statement end date, without the ledgers whose current and future balances are both zero. Requires the | |
object or Array of reconciliation_matched_bank_transaction (objects) The Bank Sync transactions confirmed as matches for the items this reconciliation cleared, keyed by the
item ( |
{- "reconciliation": {
- "reconciliationID": "147",
- "reconciliationVersionID": "2",
- "bankAccountID": "363",
- "statementStartDate": "2026-06-18",
- "statementEndDate": "2026-07-18",
- "statementEndingBalance": "24996.25",
- "isCurrent": "1",
- "isVoided": "0",
- "previousStatementEndingBalance": "3842.06",
- "moneyInTotal": "0.00",
- "moneyOutTotal": "0.00",
- "reconciledMoneyInTotal": "0.00",
- "reconciledMoneyOutTotal": "0.00",
- "unreconciledMoneyInTotal": "0.00",
- "unreconciledMoneyOutTotal": "0.00",
- "reconciledBalance": "0.00",
- "adjustedCashBalance": "0.00",
- "bankAccountBalance": "0.00",
- "undepositedPaymentsBalance": "0.00",
- "paymentsDepositedAfterStatementEndDateBalance": "0.00",
- "unsettledElectronicTransactionsBalance": "0.00",
- "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
- "adjustmentsTotal": "0.00",
- "reconciledAdjustmentsTotal": "0.00",
- "unreconciledAdjustmentsTotal": "0.00",
- "bankAdjustmentBalance": "0.00",
- "bankAccountUndepositedBalance": "0.00",
- "unsettledPaymentBalance": "0.00",
- "unsettledPaymentReturnBalance": "0.00",
- "unsettledPayoutBalance": "0.00",
- "unsettledPayoutReturnBalance": "0.00",
- "createdByUserID": "2",
- "dateTimeCreated": "2026-11-14 21:15:40"
}, - "bankAccount": {
- "accountID": "363",
- "parentAccountID": null,
- "accountTypeID": "3",
- "accountCategoryID": null,
- "number": "889749",
- "name": "Operating Checking",
- "isActive": "1",
- "isSubjectToManagementFees": "0",
- "isSubjectToLateFees": "0",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "0",
- "isSubsidized": "0",
- "isTaxable": "0",
- "isSubjectToSalesTax": "0",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "0",
- "isHeld": "0",
- "bankName": "First Example Bank",
- "bankAccountTypeID": null,
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": null,
- "bankAccountAddress": null,
- "bankAccountAddress2": null,
- "bankAccountCity": null,
- "bankAccountStateID": null,
- "bankAccountPostalCode": null,
- "bankAccountCountryID": null,
- "isCheckingEnabled": "0",
- "checkCompanyName": null,
- "checkSignatory": null,
- "checkAddress": null,
- "checkAddress2": null,
- "checkCity": null,
- "checkStateID": null,
- "checkPostalCode": null,
- "checkCountryID": null,
- "bankAccountNextCheckNumber": null,
- "bankAccountNextDepositNumber": null,
- "checkTemplateID": null,
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isNachaEnabled": "0",
- "isNachaFileBalanced": "0",
- "nachaOriginName": null,
- "nachaOriginNumber": null,
- "nachaDestinationName": null,
- "nachaDestinationNumber": null,
- "nachaCompanyIdentification": null,
- "nachaCompanyName": null,
- "nachaOriginatingFinancialInstitutionID": null,
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": null,
- "dateTimeCreated": "2026-11-14 21:15:40",
- "dateTimeModified": "2026-11-14 21:15:40",
- "dateTimeDeactivated": null
}, - "transactions": [
- {
- "reconciliationTransaction": {
- "reconciliationTransactionID": "24",
- "reconciliationID": "147",
- "isReconciled": "1",
- "reconciliationTransactionTypeID": "1",
- "reconciliationObjectTypeID": "4",
- "objectID": "53",
- "transactionEntryTransactionID": "123",
- "datePosted": "2026-04-15",
- "description": "April rent deposit",
- "reference": "DEP-1042",
- "amount": "100.00"
}, - "token": "1794690941"
}
], - "unreconcilableTransactions": {
- "undepositedPayments": [
- {
- "unreconcilableTransactionID": "21",
- "reconciliationID": "147",
- "unreconcilableTransactionTypeID": "1",
- "objectTypeID": "9",
- "objectID": "123",
- "transactionTypeID": "9",
- "transactionID": "123",
- "datePosted": "2026-04-29",
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "amount": "15.00"
}
], - "paymentDepositedAfterStatementEndDate": [
- {
- "unreconcilableTransactionID": "22",
- "reconciliationID": "147",
- "unreconcilableTransactionTypeID": "2",
- "objectTypeID": "9",
- "objectID": "123",
- "transactionTypeID": "9",
- "transactionID": "123",
- "datePosted": "2026-04-29",
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "amount": "15.00"
}
], - "unsettledElectronicTransaction": [
- {
- "unreconcilableTransactionID": "23",
- "reconciliationID": "147",
- "unreconcilableTransactionTypeID": "3",
- "objectTypeID": "9",
- "objectID": "123",
- "transactionTypeID": "9",
- "transactionID": "123",
- "datePosted": "2026-04-29",
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "amount": "15.00"
}
], - "electronicTransactionSettledAfterStatementEndDate": [
- {
- "unreconcilableTransactionID": "24",
- "reconciliationID": "147",
- "unreconcilableTransactionTypeID": "4",
- "objectTypeID": "9",
- "objectID": "123",
- "transactionTypeID": "9",
- "transactionID": "123",
- "datePosted": "2026-04-29",
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "amount": "15.00"
}
]
}, - "reconciliationChangeTransactions": [
- {
- "reconciliationChangeTransaction": {
- "reconciliationChangeTransactionID": "36",
- "reconciliationID": "147",
- "bankAccountID": "363",
- "reconciliationChangeTypeID": "1",
- "reconciliationTransactionTypeID": "2",
- "reconciliationObjectTypeID": "6",
- "objectID": "123",
- "transactionEntryTransactionID": "123",
- "datePosted": "2026-04-29",
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "amount": "15.00",
- "dateTimeCreated": "2026-11-14 21:15:40"
}
}
], - "changeTransactionBalance": -15,
- "ledgerBalances": [
- {
- "ledger": {
- "ledgerID": "155",
- "name": "NKDN9522 - Maple Street Rentals"
}, - "ledgerBalance": {
- "currentBalance": "1250.00",
- "futureBalance": "1310.00"
}
}
], - "matchedBankTransactions": {
- "4_53": [
- {
- "reconciliationBankTransactionID": "12",
- "reconciliationBankStatementID": "22",
- "sourceKey": "linked-1",
- "datePosted": "2026-04-15",
- "amount": "100.00",
- "bankTransactionTypeID": "1",
- "description": null,
- "reference": null,
- "confidence": 95,
- "reconciliationBankTransactionMatchID": 12,
- "reconciliationID": 147
}
]
}
}Voids a bank account's current reconciliation: everything it reconciled becomes unreconciled again, and the
reconciliation before it becomes current. The voided reconciliation stays readable, with isVoided 1.
Accounting › VoidReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.{"error": "Access Denied"}.Only the most current reconciliation can be deleted.{"error": "Reconciliation <id> not found"}.This reconciliation is being updated, please try again.previousReconciliationID.reconciliationChangeTransactions include no longer lists them.GET /accounting/reconciliations/{reconciliationID} - Read the voided reconciliation.POST /accounting/reconciliations - Complete the reconciliation again.| reconciliationID required | integer Example: 52 The reconciliation's ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| reconciliationID required | string^-?[0-9]+$ Unique identifier for the reconciliation record. |
| reconciliationVersionID required | string (reconciliation_versions) Enum: "1" "2" Version identifier for the reconciliation.
|
| bankAccountID required | string^-?[0-9]+$ The bank account this reconciliation belongs to. |
| statementStartDate required | string <date> Start date of the bank statement period. |
| statementEndDate required | string <date> End date of the bank statement period. |
| statementEndingBalance required | string <decimal> Ending balance from the bank statement. |
| isCurrent required | integer Value: 0 Always |
| isVoided required | integer Value: 1 Always |
| previousStatementEndingBalance required | string <decimal> Ending balance from the previous statement period. |
| moneyInTotal required | string <decimal> Total money-in (credits) for the period. |
| moneyOutTotal required | string <decimal> Total money-out (debits) for the period. |
| reconciledMoneyInTotal required | string <decimal> Total reconciled credits for the period. |
| reconciledMoneyOutTotal required | string <decimal> Total reconciled debits for the period. |
| unreconciledMoneyInTotal required | string <decimal> Total unreconciled credits remaining. |
| unreconciledMoneyOutTotal required | string <decimal> Total unreconciled debits remaining. |
| reconciledBalance required | string <decimal> Net reconciled balance (credits minus debits). |
| adjustedCashBalance required | string <decimal> Adjusted cash balance after reconciliation adjustments. |
| bankAccountBalance required | string <decimal> Current bank account balance as of the statement end date. |
| undepositedPaymentsBalance required | string <decimal> Total value of payments not yet deposited. |
| paymentsDepositedAfterStatementEndDateBalance required | string <decimal> Payments deposited after the statement end date. |
| unsettledElectronicTransactionsBalance required | string <decimal> Balance of electronic transactions not yet settled. |
| electronicTransactionsSettledAfterStatementEndDateBalance required | string <decimal> Electronic transactions settled after the statement end date. |
| adjustmentsTotal required | string <decimal> Total value of all reconciliation adjustments. |
| reconciledAdjustmentsTotal required | string <decimal> Total value of reconciled adjustments. |
| unreconciledAdjustmentsTotal required | string <decimal> Total value of unreconciled adjustments. |
| bankAdjustmentBalance required | string <decimal> Net bank adjustment balance. |
| bankAccountUndepositedBalance required | string <decimal> Undeposited balance in the bank account. |
| unsettledPaymentBalance required | string <decimal> Balance of unsettled incoming payments. |
| unsettledPaymentReturnBalance required | string <decimal> Balance of unsettled returned payments. |
| unsettledPayoutBalance required | string <decimal> Balance of unsettled outgoing payouts. |
| unsettledPayoutReturnBalance required | string <decimal> Balance of unsettled returned payouts. |
| createdByUserID required | string^-?[0-9]+$ ID of the user who created this reconciliation ( |
| dateTimeCreated required | string When the reconciliation was created. UTC, formatted |
{- "reconciliationID": "259",
- "reconciliationVersionID": "2",
- "bankAccountID": "560",
- "statementStartDate": "2026-04-01",
- "statementEndDate": "2026-04-30",
- "statementEndingBalance": "3450.00",
- "isCurrent": 0,
- "isVoided": 1,
- "previousStatementEndingBalance": "1000.00",
- "moneyInTotal": "2450.00",
- "moneyOutTotal": "0.00",
- "reconciledMoneyInTotal": "2450.00",
- "reconciledMoneyOutTotal": "0.00",
- "unreconciledMoneyInTotal": "0.00",
- "unreconciledMoneyOutTotal": "0.00",
- "reconciledBalance": "3450.00",
- "adjustedCashBalance": "0.00",
- "bankAccountBalance": "0.00",
- "undepositedPaymentsBalance": "0.00",
- "paymentsDepositedAfterStatementEndDateBalance": "0.00",
- "unsettledElectronicTransactionsBalance": "0.00",
- "electronicTransactionsSettledAfterStatementEndDateBalance": "0.00",
- "adjustmentsTotal": "0.00",
- "reconciledAdjustmentsTotal": "0.00",
- "unreconciledAdjustmentsTotal": "0.00",
- "bankAdjustmentBalance": "0.00",
- "bankAccountUndepositedBalance": "0.00",
- "unsettledPaymentBalance": "0.00",
- "unsettledPaymentReturnBalance": "0.00",
- "unsettledPayoutBalance": "0.00",
- "unsettledPayoutReturnBalance": "0.00",
- "createdByUserID": "213",
- "dateTimeCreated": "2026-11-14 21:18:36"
}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.
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.
transactionTypeIDs[]), properties or ledgers.dateTimeModifiedMin).isVoided=false.datePostedMin=garbage, amountMin=abc) is
ignored: the list comes back as if that filter were left out.datePosted, newest first, then by transactionID, highest first.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.| 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
|
| 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 |
| datePostedMax | string Example: datePostedMax=2024-12-31 Only transactions posted on or before this date, as |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-10-01 00:00:00 Only transactions changed at or after this time, in UTC, as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-10-31 23:59:59 Only transactions changed at or before this time, in UTC, as |
| transactionTypeIDs[] | Array of integers Example: transactionTypeIDs[]=12&transactionTypeIDs[]=15 Only the transactions of these types (the values of |
| transactionTypeID | integer Example: transactionTypeID=12 The same filter for one ID, read only when |
| propertyIDs[] | Array of integers Example: propertyIDs[]=12&propertyIDs[]=15 Only the transactions of these properties ( |
| propertyID | integer Example: propertyID=12 The same filter for one ID, read only when |
| primaryLedgerIDs[] | Array of integers Example: primaryLedgerIDs[]=12&primaryLedgerIDs[]=15 Only the transactions of these ledgers ( |
| primaryLedgerID | integer Example: primaryLedgerID=12 The same filter for one ID, read only when |
| 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. |
| pagination-page-size | integer Example: "2" Page size used -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The transaction's main columns. |
required | object The primary ledger. Both fields are |
required | object The transaction's property. Every field is |
required | object The transaction's portfolio. Both fields are |
required | object The transaction's unit. Every field is |
required | object What the transaction's entries post to. |
[- {
- "transaction": {
- "transactionID": "735",
- "transactionTypeID": "1",
- "primaryLedgerID": "9530",
- "billID": null,
- "bulkPaymentID": null,
- "description": "Ullam error in cum magnam.",
- "isVoided": "0",
- "amount": "3047.37",
- "datePosted": "2026-11-16",
- "reference": null,
- "payoutID": null,
- "payoutReturnID": null,
- "dateTimeCreated": "2026-11-16 19:33:37",
- "dateTimeModified": "2026-11-16 19:33:37",
- "contactID": null
}, - "ledger": {
- "ledgerID": "9530",
- "name": "AETY522 - Mraz, Jacobs and Will Portfolio"
}, - "property": {
- "propertyID": "3705",
- "name": "6775 Nora Plaza",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "ME",
- "postalCode": "12345",
- "isMultiUnit": "0"
}, - "portfolio": {
- "portfolioID": "4498",
- "name": "Mraz, Jacobs and Will Portfolio"
}, - "unit": {
- "unitID": "3153",
- "name": "#814",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "AR",
- "postalCode": "12345"
}, - "transactionEntries": {
- "ledgerNames": "AETY522 - Mraz, Jacobs and Will Portfolio, Mayert and Sons Portfolio"
}
}
]Returns one accounting transaction of any type (a charge, a payment, a bill, a journal entry, ...), with the
related records the includes parameter asks for. Posting a journal entry answers with this same shape.
entries) and history (transactionLogs,
cashEntryArchives).returnedTransaction), or a payment to its bulk receipt.{"error": "Access Denied"} for a transaction whose primary ledger
it can't access (a manager-ledger transaction needs an unrestricted key).{"error": "Transaction <id> not found"}.ledger - The primary ledger, or null when there is none.portfolio - The portfolio; false when the transaction has none.property - The property, or null.unit - The unit, or null.lease - The lease, or null.account - Always null.contact - The contact (tenant, owner or vendor), or null.reconciliation - The reconciliation that reconciled the transaction, or null.previousReconciliation - The reconciliation it was reconciled in before, or null.returnedTransaction - The transaction this one returned, or null.bulkPayment - The bulk receipt the transaction belongs to, or null.transactionLogs - Every change made to the transaction, newest first.entries - The cash-basis lines that aren't voided, newest first, with their ledgers and related records.cashEntries - Every cash-basis line, with its ledger.accrualEntries - Every accrual-basis line, with its ledger.cashEntryArchives - The cash-basis lines a change replaced.accrualEntryArchives - The accrual-basis lines a change replaced.GET /accounting/transactions/search - Search transactions.GET /accounting/journal-entries/search - Search journal entries.DELETE /accounting/journal-entries/{transactionID} - Void a journal entry.| transactionID required | integer Example: 80980 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_record) An accounting transaction: every column of the transaction row. Fields a transaction's type doesn't use are null (a journal entry fills its type, ledger, portfolio, property or unit, amount, description and dates). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects Every change made to the transaction (create, modify, void), newest first (changes made in the same second come in
no set order), one row per change. Requires the
| |
Array of objects (transaction_entry_row) The transaction's cash-basis entries that aren't voided (an accrual-only entry isn't listed), newest first: by
date posted, then transaction, then entry ID, each descending. Each comes with its ledger and related records.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every cash-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every accrual-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its
ledger. Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "transaction": {
- "transactionID": "101",
- "transactionTypeID": "11",
- "managementFeeMode": "2",
- "primaryLedgerID": "306",
- "portfolioID": "111",
- "propertyID": "104",
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "140.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Reclassify October landscaping invoice to repairs",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-10-31",
- "dateTimeCreated": "2026-11-12 23:44:27",
- "dateTimeModified": "2026-11-12 23:44:27"
}
}Adds one payment return or bank fee to an existing reconciliation of its bank account, outside a full
reconciliation: use it for an item that cleared the bank after the reconciliation that should have held it was
completed. Answers with the transaction as GET /accounting/transactions/{transactionID} returns it, and takes the
same includes.
Accounting › ModifyReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.Transaction type cannot be reconciled.{"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.previousReconciliationID of a transaction it removed.{"error": "Transaction <id> not found"}.reconciliationID is set, and its previousReconciliationID cleared.6 Transaction, whatever the transaction's type) is written to the
reconciliation, so its changeTransactionBalance falls by the transaction's amount. Reconciling a transaction
back into a reconciliation it was removed from, when that reconciliation holds exactly one removal record for it
with the same date and amount, deletes that record instead.transactionLogs include.POST /accounting/transactions/{transactionID}/unreconcile - Undo it.GET /accounting/reconciliations - Find the bank account's reconciliations (bankAccountID, isCurrent=true).GET /accounting/reconciliations/{reconciliationID} - See the change (includes=reconciliationChangeTransactions).POST /accounting/deposits/{depositID}/reconcile - Reconcile a deposit.| transactionID required | integer Example: 99 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| reconciliationID required | string or integer^-?[0-9]+$ The reconciliation to add the transaction to, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_record) An accounting transaction: every column of the transaction row. Fields a transaction's type doesn't use are null (a journal entry fills its type, ledger, portfolio, property or unit, amount, description and dates). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects Every change made to the transaction (create, modify, void), newest first (changes made in the same second come in
no set order), one row per change. Requires the
| |
Array of objects (transaction_entry_row) The transaction's cash-basis entries that aren't voided (an accrual-only entry isn't listed), newest first: by
date posted, then transaction, then entry ID, each descending. Each comes with its ledger and related records.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every cash-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every accrual-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its
ledger. Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "reconciliationID": 73
}{- "transaction": {
- "transactionID": "49",
- "transactionTypeID": "9",
- "managementFeeMode": "1",
- "primaryLedgerID": "75",
- "portfolioID": "40",
- "propertyID": null,
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": "227",
- "chargeAccountID": "228",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "15.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": "73",
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-04-29",
- "dateTimeCreated": "2026-11-14 21:07:04",
- "dateTimeModified": "2026-11-14 21:07:05"
}
}Removes one reconciled transaction from its reconciliation, leaving the rest of the reconciliation as it is.
Answers with the transaction as GET /accounting/transactions/{transactionID} returns it, and takes the same
includes. The request has no body.
POST /accounting/transactions/{transactionID}/reconcile, or take a transaction out of a completed
reconciliation it shouldn't be in.Accounting › ModifyReconciliations); without it the API
answers 403 {"error": "Permission Denied"}.Transaction is not reconciled.{"portfolioID": ["You do not have access to the portfolio"]} and changes nothing.{"error": "Transaction <id> not found"}.reconciliationID is cleared, and its previousReconciliationID set to the reconciliation it
was removed from.6 Transaction) is written to that reconciliation, so its
changeTransactionBalance rises by the transaction's amount: back to where it was for a transaction reconciled
into it on its own, above it for one the full reconciliation cleared.transactionLogs include.POST /accounting/transactions/{transactionID}/reconcile - Reconcile it again.GET /accounting/reconciliations/{reconciliationID} - See the change (includes=reconciliationChangeTransactions).POST /accounting/deposits/{depositID}/unreconcile - Unreconcile a deposit.| transactionID required | integer Example: 99 The transaction's ID, from |
| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_record) An accounting transaction: every column of the transaction row. Fields a transaction's type doesn't use are null (a journal entry fills its type, ledger, portfolio, property or unit, amount, description and dates). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects Every change made to the transaction (create, modify, void), newest first (changes made in the same second come in
no set order), one row per change. Requires the
| |
Array of objects (transaction_entry_row) The transaction's cash-basis entries that aren't voided (an accrual-only entry isn't listed), newest first: by
date posted, then transaction, then entry ID, each descending. Each comes with its ledger and related records.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every cash-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every accrual-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its
ledger. Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "transaction": {
- "transactionID": "75",
- "transactionTypeID": "9",
- "managementFeeMode": "1",
- "primaryLedgerID": "101",
- "portfolioID": "53",
- "propertyID": null,
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": "267",
- "chargeAccountID": "268",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "15.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Monthly service fee",
- "reference": "FEE-0426",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": "88",
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-04-29",
- "dateTimeCreated": "2026-11-14 21:07:08",
- "dateTimeModified": "2026-11-14 21:07:08"
}
}Records a miscellaneous payment receipt against a ledger (e.g. a Money Order,
Cash, or Check received that is not a lease rent payment). Creates a transaction
of type 12 (Other Payment) and returns the newly created transaction.
attachments (array of fileID values).ModifyOtherPayments permission under the Accounting component.ledgerID is required and must reference a valid, accessible ledger.chargeAccountID identifies the income account to credit.bankAccountID identifies the bank account to debit.paymentTypeID must be one of the defined payment type integers (1–8).GET /accounting/other-payments/{transactionID}.GET /accounting/other-payments/{transactionID} - Retrieve a specific other payment.PUT /accounting/other-payments/{transactionID} - Update an existing other payment.DELETE /accounting/other-payments/{transactionID} - Void an other payment.| ledgerID required | string or integer^-?[0-9]+$ ID of the ledger to post the payment against. |
| amount required | string or number <decimal> Payment amount. |
| chargeAccountID required | string or integer^-?[0-9]+$ Income account ID to credit. |
| datePosted required | string <date> Date the payment was received. |
| bankAccountID required | string or integer^-?[0-9]+$ Bank account ID to debit. |
required | (payment_types_request (string or integer)) or null |
| receivedFrom | string or null Name or description of the payer. |
| reference | string or null Check number, transaction reference, or other identifier. |
| description | string or null Internal memo describing the payment. |
| attachments | Array of integers Array of |
| depositID | string or integer or null^-?[0-9]+$ Deposit ID to associate this payment with, if applicable. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "ledgerID": 1165,
- "receivedFrom": "123pm",
- "amount": 1000,
- "chargeAccountID": 106,
- "datePosted": "2026-05-15",
- "reference": "Test Reference",
- "description": "Test Description",
- "bankAccountID": 31,
- "attachments": [ ],
- "paymentTypeID": 4
}{- "transaction": {
- "transactionID": "83657",
- "transactionTypeID": "12",
- "managementFeeMode": "2",
- "primaryLedgerID": "1165",
- "portfolioID": "416",
- "propertyID": null,
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": "31",
- "chargeAccountID": "106",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "1000.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Test Description",
- "reference": "Test Reference",
- "receivedFrom": "123pm",
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "4",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-05-15",
- "dateTimeCreated": "2026-05-15 18:34:26",
- "dateTimeModified": "2026-05-15 18:34:26"
}
}Posts a new charge transaction against a lease. The charge is recorded against the specified chart-of-account entry and immediately increases the lease's outstanding balance. Management fees and sales tax charges may be auto-generated depending on the account's configuration and the portfolio's management fee settings.
400
is returned otherwise.chargeAccountID must reference a valid income-type chart-of-account entry configured for
lease charges; invalid accounts are rejected with a 400.datePosted must be a valid calendar date in YYYY-MM-DD format.amount is accepted as a decimal string (e.g. "1000.00").POST /accounting/leases/{leaseID}/payments - Apply a payment against this or other charges on the lease.GET /accounting/transactions/search - Search and retrieve existing transactions for the lease.GET /leases/{leaseID}/recurring-charges - Manage recurring charges that auto-generate transactions.| leaseID required | integer Example: 2982 ID of the lease to post the charge against. |
| datePosted required | string <date> Date the charge should be posted to the ledger ( |
| amount required | string or number <decimal> Charge amount as a decimal string. |
| chargeAccountID required | string or integer^-?[0-9]+$ Chart-of-account ID to post this charge against. Must be an income-type account enabled for lease charges. |
| description required | string Label for the charge as it appears on statements and the tenant ledger. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_detail) Full accounting transaction record as returned by lease charge and payment creation endpoints. Contains all fields including management-fee, sales-tax, ACH, prepayment, and reconciliation metadata. Fields that are not applicable to a given transaction type will be null. |
{- "datePosted": "2026-04-25",
- "amount": "1500.00",
- "chargeAccountID": "9",
- "description": "April Rent"
}{- "transaction": {
- "transactionID": "80980",
- "transactionTypeID": "1",
- "managementFeeMode": "2",
- "primaryLedgerID": "1212",
- "portfolioID": "435",
- "propertyID": "708",
- "unitID": "687",
- "leaseID": "2982",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "9",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "1000.00",
- "amountPaid": "0.00",
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Rent Income",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": "0.00",
- "isAdditionalManagementFee": "0",
- "managementFeePercent": "0.01",
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": "10",
- "managementFeeSalesTaxAmountPaid": "0.00",
- "managementFeeSalesTaxPercent": "7.0000",
- "managementFeeSalesTaxIncomeAccountID": "9",
- "managementFeeSalesTaxExpenseAccountID": "38",
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": "0",
- "isProrated": "0",
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-04-25",
- "dateTimeCreated": "2026-04-25 20:08:26",
- "dateTimeModified": "2026-04-25 20:08:26"
}
}Records a payment received from a tenant against a lease. The payment can be applied to
specific outstanding charges via the receipts array, applied automatically to the oldest
charges first, or held as a prepayment (unapplied credit) for future application. An email
receipt is optionally sent to the tenant on success.
400
is returned otherwise.bankAccountID defaults to the portfolio's primary trust account when null; provide a
specific bank account ID to override.leaseTenantID identifies which tenant on the lease is making the payment; this controls
the contactID recorded on the transaction and determines where the email receipt is sent.prepaymentAccountID controls where unallocated funds are held. Use -1 to apply to the
portfolio's default prepayment account. Set hasPrepayment: true and supply prepaymentAmount
to split the payment between charges and prepayment.applyAutomatically is true, the server allocates the payment to outstanding charges
from oldest to newest, ignoring the receipts array.applyAutomatically is false, supply a receipts array specifying which charge
transactions to apply the payment to and the amount to apply to each.receipts[].chargeTransactionID must reference a charge transaction on this lease.receipts[].amount plus prepaymentAmount should equal amount.emailReceipt: true triggers an email receipt to the tenant identified by leaseTenantID.POST /accounting/leases/{leaseID}/charges - Create a charge before applying a payment.GET /accounting/transactions/search - Search existing payment and charge transactions for the lease.| leaseID required | integer Example: 2982 ID of the lease to record the payment against. |
| amount required | string or number <decimal> Total payment amount as a decimal string. |
| datePosted required | string <date> Date the payment should be posted to the ledger ( |
| leaseTenantID required | string or integer^-?[0-9]+$ ID of the lease-tenant record identifying the paying tenant. Controls |
| bankAccountID | string or integer or null^-?[0-9]+$ ID of the bank account to deposit the payment into. Pass |
| emailReceipt | boolean Default: false Whether to send a payment receipt email to the tenant identified by |
| leaseID | string or integer^-?[0-9]+$ ID of the lease (must match the |
| prepaymentAccountID | string or integer or null^-?[0-9]+$ Account to hold unallocated (prepayment) funds. Use |
| prepaymentAmount | string or number or null <decimal> Portion of |
| reference | string or null External reference number such as a check number or ACH trace ID. |
| description | string or null Free-text label for this payment as it appears on the tenant ledger. |
| applyAutomatically | boolean Default: false When |
Array of objects List of charge transactions to apply this payment to. Required when
| |
| hasPrepayment | boolean Default: false Whether any portion of this payment should be held as a prepayment.
When |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_detail) Full accounting transaction record as returned by lease charge and payment creation endpoints. Contains all fields including management-fee, sales-tax, ACH, prepayment, and reconciliation metadata. Fields that are not applicable to a given transaction type will be null. |
{- "bankAccountID": null,
- "emailReceipt": true,
- "leaseID": "2982",
- "prepaymentAccountID": null,
- "amount": "1500.00",
- "datePosted": "2026-04-25",
- "prepaymentAmount": null,
- "reference": "1001",
- "leaseTenantID": "3356",
- "description": "April rent payment",
- "applyAutomatically": false,
- "receipts": [
- {
- "chargeTransactionID": "80976",
- "amount": 1500
}
], - "hasPrepayment": false
}{- "transaction": {
- "transactionID": "80977",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "1212",
- "portfolioID": "435",
- "propertyID": "708",
- "unitID": "687",
- "leaseID": "2982",
- "billID": null,
- "contactID": "5194",
- "bankAccountID": "46",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "1000.00",
- "amountPaid": null,
- "amountAllocated": "500.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "April rent payment",
- "reference": "1234",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "3",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-04-25",
- "dateTimeCreated": "2026-04-25 20:01:18",
- "dateTimeModified": "2026-04-25 20:01:18"
}
}Records a refunded return on a lease: a manual tenant credit to the lease's unallocated (prepayment) account, funded from an equity account. It is used when a payment whose credit was already refunded to the tenant comes back from the bank, to restore the credit the refund drew on. It isn't linked to a specific returned payment.
The response is the new refunded return as GET /accounting/leases/refunded-returns/{transactionID} (undocumented)
returns it, with the same includes.
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}.amount (above 0.00), datePosted, description, equityAccountID and unallocatedAccountID are required;
a missing one answers 400 with a validation map keyed transaction.<field> (description:
Description is required).equityAccountID must be an equity account (Equity account must be of type equity) and
unallocatedAccountID a prepayment account (Unallocated account must be of type prepayment).leaseID with no lease answers 400 {"error": "Failed to get lease details"}, not 404; for an API user
restricted to portfolio groups it answers 403 {"error": "Access Denied"} instead, since the restriction
check runs first. A path value that isn't a number answers the stock 404.amount answers 500.amount to unallocatedAccountID and a debit of amount to
equityAccountID, so the tenant's credit balance rises by amount.From the code, not covered by a contract test:
property - the lease's propertyunit - the lease's unitlease - the leaseDELETE /accounting/leases/refunded-returns/{transactionID} - Void a refunded return.POST /accounting/leases/payments/{transactionID}/return - Return a payment; it records a refunded return by
itself when part of the payment's credit had been refunded.GET /accounting/accounts/search - Find the account IDs.| leaseID required | integer Example: 2982 ID of the lease to credit. |
| includes | string Example: includes=lease Comma-separated related records to add to the response, each under its own key: |
| amount required | string or number <decimal> > 0 Amount to credit; must be above |
| datePosted required | string Date the refunded return posts to the ledger ( |
| description required | string non-empty Free-text description shown on the ledger; required, and can't be blank. |
| equityAccountID required | string or integer^-?[0-9]+$ Equity account that funds the credit (debited); the Manager app defaults to the owner distribution
account. The IDs come from |
| unallocatedAccountID required | string or integer^-?[0-9]+$ Account that receives the credit; it must be a prepayment account. Use the account the lease's payments
hold unapplied credit in (their |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
object (included_lease) The lease, with the |
{- "amount": "120.00",
- "datePosted": "2026-11-09",
- "description": "Refunded payment returned",
- "equityAccountID": "453",
- "unallocatedAccountID": "3"
}{- "transaction": {
- "transactionID": "580",
- "transactionTypeID": "25",
- "managementFeeMode": "2",
- "primaryLedgerID": "888",
- "portfolioID": "458",
- "propertyID": "430",
- "unitID": "430",
- "leaseID": "430",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": null,
- "equityAccountID": "453",
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "120.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Refunded payment returned",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:07:20",
- "dateTimeModified": "2026-11-09 05:07:20"
}
}Releases part or all of a lease's collected security deposit as a tenant credit, and can apply that credit to
open charges (final charges at move-out) in the same request. The credit can't release more than was collected
on each deposit account, and its parts (depositReleases) must add up to its amount.
The response is the new credit as GET /accounting/leases/deposit-release-credits/{transactionID} (undocumented)
returns it, with the same includes.
POST /accounting/leases/{leaseID}/payouts.Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}.amount. Each failure
answers 400 with its message (see the examples).description is required: without it the API answers 400
{"depositReleaseCredit.description": ["Description is required"]}.Cannot release a deposit that has not been collected.receipts entry must name an open charge on this lease: a charge on another lease answers 400
{"depositReleaseCredit.receipt.receipt": ["Invalid Charge or Payment."]}, and one that doesn't exist
{"depositReleaseCredit.receipt.receipt": ["Could not locate receipt charge transaction"]}. Applying more than a
charge's open amount (depositReleaseCredit.receipt.charge.amountPaid), or more than the credit
(depositReleaseCredit.receipt.payment.amountAllocated), answers 400 (see the examples).leaseID with no lease has no collected deposit, so it answers 400
{"depositRelease": ["Cannot release a deposit that has not been collected"]}, not 404; for an API user
restricted to portfolio groups it answers 403 {"error": "Access Denied"} instead, since the restriction
check runs first. A path value that isn't a number answers the stock 404.amount answers 500.19) is posted for amount, and one deposit-release row is written per
depositReleases entry; the collected deposit left to release drops by amount.receipts entry applies the credit to that charge.From the code, not covered by a contract test:
managementFeeAmountPaid rise (seen on a live call, where 12.50 was taken on a 125.00 charge).account - always false: the include looks up a column these transactions don't havecontact - always false: a deposit-release credit has no contactlease - the leaseproperty - the lease's propertyunit - the lease's unitreceipts - the charges the credit was applied todepositReleases - the credit's deposit-release rowsDELETE /accounting/leases/deposit-release-credits/{transactionID} - Void a deposit-release credit.GET /accounting/leases/{leaseID}/charges/for-payment (undocumented) - Find the lease's open charges for
receipts.GET /leases/{leaseID}/deposit-balances (undocumented) - The deposit accounts the lease has collected on, with
the balance left to release on each.| leaseID required | integer Example: 2982 ID of the lease whose deposit is released. |
| includes | string Example: includes=receipts,depositReleases Comma-separated related records to add to the response, each under its own key: |
| amount required | string or number <decimal> Amount to release; must equal the sum of |
| datePosted required | string Date the credit posts to the ledger ( |
| description required | string non-empty Free-text description shown on the ledger; required, and can't be blank. |
required | Array of objects non-empty The deposit accounts to release from, and how much from each. |
Array of objects Open charges on the lease to apply the credit to, and how much to each. Optional. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
| account | boolean Value: false With the |
| contact | boolean Value: false With the |
object (included_lease) The lease, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects The credit's receipts that aren't voided, with the | |
Array of objects (included_deposit_release) The credit's deposit-release rows, with the |
{- "amount": "400.00",
- "datePosted": "2026-11-09",
- "description": "Security deposit applied to final charges",
- "depositReleases": [
- {
- "liabilityAccountID": "360",
- "amount": "400.00"
}
], - "receipts": [
- {
- "chargeTransactionID": "451",
- "amount": "250.00"
}
]
}{- "transaction": {
- "transactionID": "452",
- "transactionTypeID": "19",
- "managementFeeMode": "2",
- "primaryLedgerID": "741",
- "portfolioID": "382",
- "propertyID": "359",
- "unitID": "359",
- "leaseID": "359",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "56",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": "56",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "400.00",
- "amountPaid": null,
- "amountAllocated": "250.00",
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Security deposit applied to final charges",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:06:47",
- "dateTimeModified": "2026-11-09 05:06:47"
}
}Refunds a tenant's credit balance: creates a payout batch holding one payout to the tenant, paid from the given
bank account, and applies it to the tenant's payments or credits through receipts. Nothing is paid until the
batch is approved; the batch is created unapproved unless isApproved is sent and honoured (see Business Rules).
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}.leaseID with no lease answers 400 {"error": "Lease 999999999 not found"}, not 404. A path value that
isn't a number answers the stock 404.isApproved: true approves the batch only when the API key's role also has the Approve Payout Batch
permission (Accounting › ApproveBillPay). Without it the flag is silently ignored and the batch is created
unapproved, with a 200.isMFACodeRequiredForPayoutApproval is on: then
isApproved: true without mfaCode answers 400 {"mfaCode": ["MFA Code is Required"]}, and a wrong code
{"mfaCode": ["MFA Code is Invalid"]}.amount exactly, and no receipt may apply more than what is left of the payment
or credit it names; otherwise 400 (see the examples).leaseTenantID and an unknown contactID): contactID when sent;
else the contact of leaseTenantID, which must be on this lease; else the lease's first tenant. A contactID that names no tenant contact answers 400
{"payoutBatchContract.checkBatch.checks[0].payeeID": ["Payee cannot be found."]} (on a check payout).receipts[].paymentTransactionID must be a lease payment, credit or deposit-release credit; any other
transaction (a charge, say) answers 400 with a validation map naming the payout's liability account (see the
receiptNotAPayment example).payoutTypeID 4, and from the code 3 as well) needs the payee's bank details: a saved paymentMethodID or the
refundAch* fields. Without them it answers 400 with a validation map keyed payouts[0].<field>.amount answers 500.bankAccountID, with one payout of amount to the payee. A check payout takes the
bank account's next check number, and the bank account's next check number goes up by one.amount.isApproved honoured, the batch is approved and queued for payment; from the code, approval also sends a
payout-batch-approved notification and writes a "Payout Batch Modified" log entry.From the code, not covered by a contract test:
isMoveOutTransaction defaults to whether the lease is in move-out (active or completed), unless
the body sets it.checkNumber in the body is used as is, and the bank account's next check number isn't advanced.POST /accounting/leases/{leaseID}/payments - Record the payment whose credit is refunded.GET /accounting/transactions/search - Find the payments and credits to refund (receipts[].paymentTransactionID).GET /accounting/accounts/search - Find the bank account.GET /leases/{leaseID}/tenants - Find the tenant (leaseTenantID, contactID).| leaseID required | integer Example: 2982 ID of the lease whose tenant is refunded. |
| bankAccountID required | string or integer^-?[0-9]+$ Bank account the payout is paid from; a missing or unknown one answers |
| datePosted required | string Date the payout batch posts ( |
| amount required | string or number <decimal> Payout amount; must equal the sum of |
required | Array of objects non-empty The tenant payments or credits the payout refunds, and how much from each. |
| payoutTypeID | string or integer Default: 2 Enum: "1" "2" "3" "4" 1 2 3 4 How the payout is paid; defaults to a check:
|
| leaseTenantID | string or integer^-?[0-9]+$ Tenant on this lease to pay, when |
| contactID | string or integer^-?[0-9]+$ Contact to pay. The tenants' contact IDs come from |
| description | string or null Ignored; a payout has no description. Its ledger transaction is described with |
| memo | string or null Memo printed on the check; it also describes the payout's ledger transaction. |
| checkPayeeName | string or null Name printed on the check. |
| checkNumber | string or null Check number to use instead of the bank account's next check number. |
| payeeAddress | string or null Mailing address of the payee. |
| payeeAddress2 | string or null Second address line of the payee. |
| payeeCity | string or null City of the payee. |
| payeeStateID | string or null State of the payee; checked against |
| payeePostalCode | string or null Postal code of the payee. |
| payeeCountryID | string or null Country of the payee. The values come from |
| isApproved | boolean Default: false Approve the batch now. Honoured only when the API key's role has Approve Payout Batch; otherwise ignored. |
| mfaCode | string or null The approver's MFA code, needed with |
| isMoveOutTransaction | boolean or null Mark the payout as a move-out refund, or not; when absent or null, it follows the lease's move-out state. |
| paymentMethodID | string or integer or null^-?[0-9]+$ For an ACH payout ( |
(bank_account_types_request (string or integer)) or null For an ACH payout without
| |
| refundAchRoutingNumber | string or null For an ACH payout without |
| refundAchAccountNumber | string or null For an ACH payout without |
| refundAchIsCorporateAccount | string or integer or boolean or null For an ACH payout without |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The payout batch the request created. |
{- "bankAccountID": "437",
- "datePosted": "2026-11-09",
- "payoutTypeID": 2,
- "amount": "150.00",
- "leaseTenantID": "413",
- "description": "Move-out credit refund",
- "memo": "Example memo.",
- "checkPayeeName": "Jordan Example",
- "payeeAddress": "123 Main St",
- "payeeCity": "Springfield",
- "payeePostalCode": "12345",
- "receipts": [
- {
- "paymentTransactionID": "558",
- "amount": "150.00"
}
]
}{- "payoutBatch": {
- "payoutBatchID": "22",
- "payoutBundleID": null,
- "bankAccountID": "437",
- "payoutBatchStatusID": 1,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:07:14"
}
}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.
amount minus amountPaid) and which payments and credits paid it
(receipts).403
{"error": "Access Denied"}.400
{"error": "Charge 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.403 even when it isn't a lease charge.isVoided '1'.property - the lease's propertyunit - the lease's unitlease - the leaseportfolio - the portfolio the charge posted topropertyPortfolios - every ownership period of the propertyreceipts - the payments and credits applied to the charge (receipts that aren't voided), each with its
payment or creditsalesTaxTransaction - the sales tax charge posted for this charge, or nullsalesTaxFromTransaction - for a sales tax charge, the charge it was posted for; null otherwisePOST /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).| transactionID required | integer Example: 80980 ID of the lease charge. |
| includes | string Example: includes=receipts,salesTaxTransaction Comma-separated related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
object (included_lease) The charge's lease, with the | |
object (included_portfolio) The portfolio the charge posted to, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
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 | |
lease_transaction (object) or null The sales tax charge posted for this charge, with the | |
lease_transaction (object) or null For a sales tax charge, the charge it was posted for, with the |
{- "transaction": {
- "transactionID": "395",
- "transactionTypeID": "1",
- "managementFeeMode": "2",
- "primaryLedgerID": "726",
- "portfolioID": "376",
- "propertyID": "350",
- "unitID": "350",
- "leaseID": "350",
- "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": "300.00",
- "amountPaid": "120.00",
- "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": "12.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": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": "0",
- "isProrated": "0",
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-11-16 19:59:16",
- "dateTimeModified": "2026-11-16 19:59:16"
}
}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.
Accounting › ModifyLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.chargeAccountID, amount, datePosted and description are read; any other key is ignored, billID
included.400
{"error": "Charge 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.amountPaid above 0.00), the account and the date can't change, and
the amount can't drop below what is paid.400 {"isVoided": ["Cannot modify a voided transaction"]}.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.From the code, not covered by a contract test:
managementFeePercent, isSuppressed,
isAdditionalManagementFee and the management fee sales tax fields) from the new account and the property's
management fee settings.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.| transactionID required | integer Example: 80980 ID of the lease charge to change. |
| includes | string Example: includes=receipts,salesTaxTransaction Comma-separated related records to add to the response, each under its own key: |
The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is
refused.
| chargeAccountID | string or integer^-?[0-9]+$ The account the charge posts to, from |
| amount | string or number <decimal> The charge amount, above |
| datePosted | string The date the charge posts to the ledger, as |
| description | string [ 1 .. 4000 ] characters The charge's label on the tenant ledger and statements. Can't be emptied. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
object (included_lease) The charge's lease, with the | |
object (included_portfolio) The portfolio the charge posted to, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
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 | |
lease_transaction (object) or null The sales tax charge posted for this charge, with the | |
lease_transaction (object) or null For a sales tax charge, the charge it was posted for, with the |
{- "amount": "275.00",
- "datePosted": "2026-11-05",
- "description": "Carpet cleaning, two rooms"
}{- "transaction": {
- "transactionID": "404",
- "transactionTypeID": "1",
- "managementFeeMode": "2",
- "primaryLedgerID": "740",
- "portfolioID": "383",
- "propertyID": "357",
- "unitID": "357",
- "leaseID": "357",
- "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": "275.00",
- "amountPaid": "0.00",
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Carpet cleaning, two rooms",
- "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": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": "0",
- "isProrated": "0",
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-05",
- "dateTimeCreated": "2026-11-16 19:59:20",
- "dateTimeModified": "2026-11-16 19:59:20"
}
}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.| transactionID required | integer Example: 80980 ID of the lease charge to change. |
| includes | string Example: includes=receipts,salesTaxTransaction Comma-separated related records to add to the response, each under its own key: |
The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is
refused.
| chargeAccountID | string or integer^-?[0-9]+$ The account the charge posts to, from |
| amount | string or number <decimal> The charge amount, above |
| datePosted | string The date the charge posts to the ledger, as |
| description | string [ 1 .. 4000 ] characters The charge's label on the tenant ledger and statements. Can't be emptied. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
object (included_lease) The charge's lease, with the | |
object (included_portfolio) The portfolio the charge posted to, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
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 | |
lease_transaction (object) or null The sales tax charge posted for this charge, with the | |
lease_transaction (object) or null For a sales tax charge, the charge it was posted for, with the |
{- "amount": "275.00",
- "datePosted": "2026-11-05",
- "description": "Carpet cleaning, two rooms"
}{- "transaction": {
- "transactionID": "404",
- "transactionTypeID": "1",
- "managementFeeMode": "2",
- "primaryLedgerID": "740",
- "portfolioID": "383",
- "propertyID": "357",
- "unitID": "357",
- "leaseID": "357",
- "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": "275.00",
- "amountPaid": "0.00",
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Carpet cleaning, two rooms",
- "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": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": "0",
- "isProrated": "0",
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-05",
- "dateTimeCreated": "2026-11-16 19:59:20",
- "dateTimeModified": "2026-11-16 19:59:20"
}
}Voids a posted lease charge. This is not a delete: the charge keeps its row and its history, is flagged voided
(isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's
balance. A voided charge can't be changed or voided again.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400 {"error": "Charge 999999999 not found"}, and one that isn't a lease
charge answers 400 {"error": "Transaction not found"}; neither is a 404. A path value that isn't a number
answers the stock 404.400 {"isVoided": ["Cannot modify a voided transaction"]}.amountPaid above 0.00) can't be voided: 400
{"amountPaid": ["Cannot void a charge that has receipts applied. You must reverse all receipts before voiding."]}.
Void the payments and credits applied to it first; the void never frees them.From the code, not covered by a contract test:
updateLeaseCharge event is recorded, and the lease's last-activity date is updated.POST /accounting/leases/{leaseID}/charges - Post a charge.POST /accounting/leases/{leaseID}/credits (undocumented) - Credit a charge instead of voiding it.GET /accounting/transactions/search - Find the charge to void (transactionTypeIDs[] 1).| transactionID required | integer Example: 80980 ID of the lease charge to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. |
| equityAccountID required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 0 null Amount of a charge paid so far. Only a charge with nothing applied can be voided, and the void sets this to the number |
| amountAllocated required | integer or null Enum: 0 null Amount of a payment or credit applied so far; the void voids its receipts and recomputes it in memory, so a voided credit sends the number |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "transactionID": "50",
- "transactionTypeID": "1",
- "managementFeeMode": "2",
- "primaryLedgerID": "122",
- "portfolioID": "62",
- "propertyID": "60",
- "unitID": "60",
- "leaseID": "60",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "9",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "250.00",
- "amountPaid": 0,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Carpet Cleaning",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": "0.00",
- "isAdditionalManagementFee": "0",
- "managementFeePercent": "10.00",
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": 1,
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": 0,
- "isProrated": 0,
- "isMoveOutTransaction": 0,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 04:47:27",
- "dateTimeModified": "2026-11-09 04:47:28"
}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.
receipts) and how much is left unapplied.403
{"error": "Access Denied"}.400
{"error": "Credit 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.403 even when it isn't a lease credit.contact - always false: a lease credit has no contactlease - the leaseportfolio - the portfolio the credit posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreceipts - 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 payoutDELETE /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).| transactionID required | integer Example: 80982 ID of the lease credit. |
| includes | string Example: includes=lease,receipts Comma-separated related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
object (included_lease) The credit's lease, with the | |
object (included_portfolio) The portfolio the credit posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
Array of objects (lease_receipt_row) The credit's receipts that aren't voided, with the |
{- "transaction": {
- "transactionID": "363",
- "transactionTypeID": "3",
- "managementFeeMode": "2",
- "primaryLedgerID": "654",
- "portfolioID": "339",
- "propertyID": "315",
- "unitID": "315",
- "leaseID": "315",
- "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": "100.00",
- "amountPaid": null,
- "amountAllocated": "60.00",
- "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": "0",
- "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": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-11-16 19:59:00",
- "dateTimeModified": "2026-11-16 19:59:00"
}
}Voids a posted lease credit. This is not a delete: the credit keeps its row and its history, is flagged voided
(isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's
balance. A voided credit can't be changed or voided again.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400 {"error": "Credit 999999999 not found"}, and one that isn't a lease
credit answers 400 {"error": "Credit 999999999 not found"}; neither is a 404. A path value that isn't a number
answers the stock 404.400 {"isVoided": ["Cannot modify a voided transaction"]}.400 {"receipt.isVoided": [...], "credit.receipt.isVoided": [...]}, both
Cannot void a payout receipt that is associated with an active payout. Void the payout first with
DELETE /accounting/payouts/{payoutID} (undocumented).From the code, not covered by a contract test:
POST /accounting/leases/{leaseID}/credits (undocumented) - Post a credit.GET /accounting/transactions/search - Find the credit to void (transactionTypeIDs[] 3).| transactionID required | integer Example: 80980 ID of the lease credit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. |
| equityAccountID required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 0 null Amount of a charge paid so far. Only a charge with nothing applied can be voided, and the void sets this to the number |
| amountAllocated required | integer or null Enum: 0 null Amount of a payment or credit applied so far; the void voids its receipts and recomputes it in memory, so a voided credit sends the number |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "transactionID": "66",
- "transactionTypeID": "3",
- "managementFeeMode": "2",
- "primaryLedgerID": "155",
- "portfolioID": "79",
- "propertyID": "76",
- "unitID": "76",
- "leaseID": "76",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "9",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": "4",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "75.00",
- "amountPaid": null,
- "amountAllocated": 0,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Rent concession",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": 1,
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": "0",
- "isMoveInCharge": 0,
- "isProrated": 0,
- "isMoveOutTransaction": 0,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 04:48:08",
- "dateTimeModified": "2026-11-09 04:48:08"
}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.
receipts) and how much is left as a tenant credit.depositID), returned (returnTransactionID) or voided (isVoided)
before changing, returning or voiding it.403
{"error": "Access Denied"}.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.403 even when it isn't a lease payment.isVoided '1'.deposit - the bank deposit the payment is in, or false when it isn't in onecontact - the paying tenant's contactlease - the leaseportfolio - the portfolio the payment posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreturnTransaction - the return transaction, or null until the payment is returnedbulkPayment - the bulk payment (bulk receipt) it belongs to, or nulltransactionLogs - the payment's change logreceipts - receipts that aren't voided: the charges it paid and any refundsmanagementFees - management fees taken on it that aren't voidedPOST /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).| transactionID required | integer Example: 80981 ID of the lease payment. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "transaction": {
- "transactionID": "323",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "581",
- "portfolioID": "300",
- "propertyID": "281",
- "unitID": "281",
- "leaseID": "281",
- "billID": null,
- "contactID": "285",
- "bankAccountID": "239",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": "300.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "Rent payment",
- "reference": "1042",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "3",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": "37",
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-11-16 19:58:34",
- "dateTimeModified": "2026-11-16 19:58:34"
}
}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.
Accounting › ModifyLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.datePosted, description, reference, paymentTypeID and depositID are read; any other key is
ignored.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.403 even when it isn't a lease payment.400
{"paymentTypeID": ["Electronic payment types cannot be changed"]}, and a new date 400
{"payment": ["Payment date posted cannot be changed"]}.400 with its message (see the examples).400 {"isVoided": ["Cannot modify a voided transaction"]}.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.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:
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.| transactionID required | integer Example: 80981 ID of the lease payment to change. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is
refused.
| datePosted | string The date the payment posts, as |
| 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.
|
| depositID | string or integer or null^-?[0-9]+$ The bank deposit to put the payment in, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "datePosted": "2026-11-03",
- "description": "Rent payment, November",
- "reference": "1043",
- "paymentTypeID": 4
}{- "transaction": {
- "transactionID": "628",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "1127",
- "portfolioID": "585",
- "propertyID": "542",
- "unitID": "542",
- "leaseID": "542",
- "billID": null,
- "contactID": "548",
- "bankAccountID": "367",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": "300.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "Rent payment, November",
- "reference": "1043",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "4",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-03",
- "dateTimeCreated": "2026-11-16 20:08:08",
- "dateTimeModified": "2026-11-16 20:08:09"
}
}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.| transactionID required | integer Example: 80981 ID of the lease payment to change. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
The fields to change; any field left out keeps its value. A body that decodes to nothing ({} included) is
refused.
| datePosted | string The date the payment posts, as |
| 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.
|
| depositID | string or integer or null^-?[0-9]+$ The bank deposit to put the payment in, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "datePosted": "2026-11-03",
- "description": "Rent payment, November",
- "reference": "1043",
- "paymentTypeID": 4
}{- "transaction": {
- "transactionID": "628",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "1127",
- "portfolioID": "585",
- "propertyID": "542",
- "unitID": "542",
- "leaseID": "542",
- "billID": null,
- "contactID": "548",
- "bankAccountID": "367",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": "300.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "Rent payment, November",
- "reference": "1043",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "4",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-03",
- "dateTimeCreated": "2026-11-16 20:08:08",
- "dateTimeModified": "2026-11-16 20:08:09"
}
}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.
POST /accounting/leases/payments/{transactionID}/return), which keeps the payment and records the return.Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.400 with a validation map:{"isVoided": ["Cannot modify a voided transaction"]};{"isVoided": ["Cannot void a gateway connected transaction"]};{"isVoided": ["Transaction has been returned and cannot be voided"]};{"depositID": [...], "deposit.transaction.depositID": [...]}, both
Cannot remove deposit from reconciled transaction;{"isVoided": ["Cannot void a transaction that is connected to a bulk payment that is not voided"]}.
Once the bulk payment is voided, its payments can be voided one by one;{"receipt.isVoided": [...], "payment.receipt.isVoided": [...]}, both
Cannot void a payout receipt that is associated with an active payout. Void the payout first with
DELETE /accounting/payouts/{payoutID} (undocumented).depositID becomes null).From the code, not covered by a contract test:
deposit - the bank deposit; always false after a void, which takes the payment out of its depositcontact - the paying tenant's contactlease - the leaseportfolio - the portfolio the payment posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreturnTransaction - the return transaction; always null here, since a returned payment can't be voidedbulkPayment - the bulk payment it belongs to, or nulltransactionLogs - the payment's change log, the void includedreceipts - receipts that aren't voided; always empty after a voidmanagementFees - management fees that aren't voided; empty after a voidPOST /accounting/leases/{leaseID}/payments - Record a payment.POST /accounting/leases/payments/{transactionID}/return - Return a deposited payment instead of voiding it.GET /accounting/transactions/search - Find the payment to void (transactionTypeIDs[] 2).| transactionID required | integer Example: 80981 ID of the lease payment to void. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "transaction": {
- "transactionID": "234",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "394",
- "portfolioID": "203",
- "propertyID": "191",
- "unitID": "191",
- "leaseID": "191",
- "billID": null,
- "contactID": "192",
- "bankAccountID": "219",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": "0.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "Rent payment",
- "reference": "1042",
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "3",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "1",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 04:52:11",
- "dateTimeModified": "2026-11-09 04:52:11"
}
}Records that a deposited lease payment came back from the bank (a bounced check, an NSF). The payment itself is
kept unchanged except that it now points at a new return transaction (returnTransactionID), which reverses it
for the full amount on the same bank account. The charges the payment paid are open again. Optionally, a bank
fee and a tenant charge (an NSF fee) are posted in the same request.
The response is the original payment, not the return: request includes=returnTransaction to get the return
transaction too. It is the payment as GET /accounting/leases/payments/{transactionID} returns
it, with the same includes.
Accounting › ModifyLeaseTransactions); without it
the API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.{} counts as empty): 400 {"error": "invalid input."}. It must hold a
return object with a datePosted. The checks run in this order: the body; whether the payment is voided or
already returned; the return object; whether the payment is deposited; and only then the return's own fields.400
{"error": "Payment 999999999 not found"}; neither is a 404. A path value that isn't a number answers the
stock 404.{"payment": ["This payment cannot be returned"]}; one that isn't in a bank deposit
answers {"transactionID": ["Cannot return a payment that has not been deposited."]}. A payment in a bulk
payment (bulk receipt) is never in a deposit of its own, so it gets the same not-deposited answer.{"return.bankAccountGatewayTransactionID": ["Bank Account Gateway Transaction ID is required for gateway connect transaction"]}.bankFee is posted only when the account keeps management fees in the ledger; under bill management fees it is
ignored. The tenant charge is always posted, with the description NSF Fee.400 with an empty array [] and no message.4, Lease Payment Return) is created for the payment's full amount, on its bank
account, dated return.datePosted; the payment's returnTransactionID points at it.Refunded Payment Returned) and a matching charge
(Refunded Payment Return Recovery) are posted for the refunded amount.bankFee under ledger management fees, a bank fee is posted on the payment's bank account.charge, a tenant charge described NSF Fee is posted on the lease, dated return.datePosted. Like any
new charge, it is paid at once from the tenant's other unapplied credits (prepayments), if there are any.From the code, not covered by a contract test:
createLeasePaymentReturn event is recorded, and the lease's last-activity date is updated.deposit - the bank deposit the payment is incontact - the paying tenant's contactlease - the leaseportfolio - the portfolio the payment posted toproperty - the lease's propertyunit - the lease's unitpropertyPortfolios - every ownership period of the propertyreturnTransaction - the return transaction this request createdbulkPayment - the bulk payment it belongs to, or nulltransactionLogs - the payment's change logreceipts - receipts that aren't voided: after a return, only refund (payout) receiptsmanagementFees - management fees that aren't voided; empty after a returnDELETE /accounting/leases/payments/{transactionID} - Void a payment instead (one that was never deposited).POST /accounting/leases/{leaseID}/payouts - Refund a tenant's credit.GET /accounting/accounts/search - Find the account IDs for bankFee and charge.POST /accounting/deposits and POST /accounting/deposits/{depositID}/transactions - Put the payment in a bank
deposit, which a return requires.GET /accounting/transactions/search - Find the payment to return (transactionTypeIDs[] 2).| transactionID required | integer Example: 80981 ID of the lease payment that was returned. |
| includes | string Example: includes=returnTransaction,transactionLogs Comma-separated related records to add to the response, each under its own key: |
required | object The return transaction. |
object A bank fee the bank charged for the return, posted on the payment's bank account with the return's date. Posted only when the account keeps management fees in the ledger; ignored under bill management fees. Ignored when it has neither key. | |
object A charge to the tenant for the return (an NSF fee), posted on the lease with the return's date and the
description |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_transaction) A lease accounting transaction (charge, payment, credit, payment return, refunded return, deposit-release credit) as a read returns it: every column, each value a string or null as the database sends it. |
included_deposit (object) or boolean The bank deposit the payment is in, with the | |
object (included_contact) The paying tenant's contact, with the | |
object (included_lease) The payment's lease, with the | |
object (included_portfolio) The portfolio the payment posted to, with the | |
object (included_property) The lease's property, with the | |
object (included_unit) The lease's unit, with the | |
Array of objects (included_property_portfolio) Every ownership period of the lease's property, with the | |
lease_transaction (object) or null The payment's return transaction, with the | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the payment belongs to, with the | |
Array of objects The payment's change log, with the | |
Array of objects (lease_receipt_row) The payment's receipts that aren't voided, with the | |
Array of objects (included_management_fee) The management fees taken on the payment that aren't voided, with the |
{- "return": {
- "datePosted": "2026-11-09",
- "description": "Returned check: insufficient funds"
}, - "charge": {
- "chargeAccountID": "9",
- "amount": "35.00"
}
}{- "transaction": {
- "transactionID": "524",
- "transactionTypeID": "2",
- "managementFeeMode": "2",
- "primaryLedgerID": "811",
- "portfolioID": "418",
- "propertyID": "393",
- "unitID": "393",
- "leaseID": "393",
- "billID": null,
- "contactID": "394",
- "bankAccountID": "415",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": "1",
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": "0.00",
- "processingFee": null,
- "convenienceFee": "0.00",
- "convenienceFeeTransactionID": null,
- "description": "Rent payment",
- "reference": "1042",
- "receivedFrom": null,
- "returnTransactionID": "525",
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": "3",
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": "81",
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": "0",
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:07:04",
- "dateTimeModified": "2026-11-09 05:07:04"
}, - "returnTransaction": {
- "transactionID": "525",
- "transactionTypeID": "4",
- "managementFeeMode": "2",
- "primaryLedgerID": "811",
- "portfolioID": "418",
- "propertyID": "393",
- "unitID": "393",
- "leaseID": "393",
- "billID": null,
- "contactID": null,
- "bankAccountID": "415",
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "500.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Returned check: insufficient funds",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 05:07:04",
- "dateTimeModified": "2026-11-09 05:07:04"
}
}Voids a posted lease refunded return. This is not a delete: the refunded return keeps its row and its history, is flagged voided
(isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's
balance. A voided refunded return can't be changed or voided again.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400 {"error": "Refunded Return 999999999 not found"}, and one that isn't a lease
refunded return answers 400 {"error": "Refunded Return 999999999 not found"}; neither is a 404. A path value that isn't a number
answers the stock 404.400 {"isVoided": ["Cannot modify a voided transaction"]}.POST /accounting/leases/{leaseID}/refunded-returns - Record a refunded return.GET /accounting/transactions/search - Find the refunded return to void (transactionTypeIDs[] 25).| transactionID required | integer Example: 80980 ID of the lease refunded return to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. |
| equityAccountID required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 0 null Amount of a charge paid so far. Only a charge with nothing applied can be voided, and the void sets this to the number |
| amountAllocated required | integer or null Enum: 0 null Amount of a payment or credit applied so far; the void voids its receipts and recomputes it in memory, so a voided credit sends the number |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "transactionID": "280",
- "transactionTypeID": "25",
- "managementFeeMode": "2",
- "primaryLedgerID": "503",
- "portfolioID": "259",
- "propertyID": "244",
- "unitID": "244",
- "leaseID": "244",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": null,
- "equityAccountID": "255",
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": "3",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "120.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Refunded payment returned",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": 1,
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": 0,
- "isProrated": 0,
- "isMoveOutTransaction": 0,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 04:54:19",
- "dateTimeModified": "2026-11-09 04:54:19"
}Voids a posted lease deposit-release credit. This is not a delete: the deposit-release credit keeps its row and its history, is flagged voided
(isVoided '1' on a later read), and its ledger entries are voided so it no longer counts toward the lease's
balance. A voided deposit-release credit can't be changed or voided again.
Accounting › VoidLeaseTransactions); without it the
API answers 403 {"error": "Permission Denied"}.403
{"error": "Access Denied"}.400 {"error": "Deposit Release Credit 999999999 not found"}, and one that isn't a lease
deposit-release credit answers 400 {"error": "Deposit Release Credit 999999999 not found"}; neither is a 404. A path value that isn't a number
answers the stock 404.400 {"isVoided": ["Cannot modify a voided transaction"]}.400 {"receipt.isVoided": [...], "depositReleaseCredit.receipt.isVoided": [...]}, both
Cannot void a payout receipt that is associated with an active payout. Void the payout first with
DELETE /accounting/payouts/{payoutID} (undocumented).depositReleases include still lists them). A void entry is added to its
transaction log.From the code, not covered by a contract test:
POST /accounting/leases/{leaseID}/deposit-release-credits - Release a collected deposit.GET /accounting/transactions/search - Find the deposit-release credit to void (transactionTypeIDs[] 19).| transactionID required | integer Example: 80980 ID of the lease deposit-release credit to void. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| transactionID required | string^-?[0-9]+$ Unique identifier of the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" Transaction type:
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee mode the account used when the transaction posted:
|
| primaryLedgerID required | string or null^-?[0-9]+$ Ledger the transaction posts to (the lease's portfolio ledger for lease transactions). |
| portfolioID required | string or null^-?[0-9]+$ Portfolio that owned the property when the transaction posted. |
| propertyID required | string or null^-?[0-9]+$ Property of the transaction's lease. |
| unitID required | string or null^-?[0-9]+$ Unit of the transaction's lease. |
| leaseID required | string or null^-?[0-9]+$ Lease the transaction belongs to. |
| billID required | string or null^-?[0-9]+$ Bill the transaction belongs to; null for lease transactions. |
| contactID required | string or null^-?[0-9]+$ Contact the transaction is with: the paying tenant on a payment, null on most charges and credits. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the money moved through (payments, returns); null for charges and credits. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-accounts account a charge or credit posts to; on a deposit-release credit, the account the released deposit is moved to. |
| equityAccountID required | string or null^-?[0-9]+$ Equity account that funds a refunded return (debited); null for other types. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account of a bank transfer; null for lease transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account of a management fee; null for lease transactions. |
required | account_filter_types (string) or null Which charges the unapplied amount may later be applied to:
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment account chosen for a payment's unapplied amount, when the payment names one. |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account that holds the unapplied (prepayment) amount of a payment or credit. |
| payoutID required | string or null^-?[0-9]+$ Payout the transaction belongs to; null for lease charges, credits and payments. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return the transaction belongs to. |
| amount required | string <decimal> Amount of the transaction, in its column's scale. |
| amountPaid required | integer or null Enum: 0 null Amount of a charge paid so far. Only a charge with nothing applied can be voided, and the void sets this to the number |
| amountAllocated required | integer or null Enum: 0 null Amount of a payment or credit applied so far; the void voids its receipts and recomputes it in memory, so a voided credit sends the number |
| processingFee required | string or null <decimal> Processing fee of an online payment. |
| convenienceFee required | string or null <decimal> Convenience fee charged on an online payment. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Charge that carries the convenience fee of an online payment. |
| description required | string or null <= 4000 characters Free-text description shown on the ledger. |
| reference required | string or null <= 200 characters External reference, such as a check number. |
| receivedFrom required | string or null <= 100 characters Name the payment was received from, when entered. |
| returnTransactionID required | string or null^-?[0-9]+$ Return transaction of a returned payment; null until the payment is returned. |
required | return_types (string) or null Return reason code of an electronic payment return. |
| returnDescription required | string or null <= 200 characters Return reason text of an electronic payment return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment (bulk receipt) the payment belongs to. |
required | payment_types (string) or null How a payment was made:
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a bill-related transaction belongs to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Bill credit a bill-related transaction belongs to. |
| discountAmount required | string or null <decimal> Discount applied to a bill charge. |
| markupAmount required | string or null <decimal> Markup applied to a bill charge. |
| managementFeeAmountPaid required | string or null <decimal> Management fee taken from what was paid on this charge. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether the charge carries an additional management fee. |
| managementFeePercent required | string or null <decimal> Management fee percent applied to this charge. |
| isSuppressed required | string Enum: "0" "1" Whether the transaction is hidden from the tenant. |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management fee. |
| managementFeePeriodDate required | string or null <date> Management fee period the transaction counts toward. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax on the management fee, paid so far. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percent on the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account of the management-fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account of the management-fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch the transaction was billed in. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether the charge is a sales tax charge. |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting of a sales tax charge. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ Charge a sales tax charge was raised from. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment-processor gateway of an online payment; a gateway-connected payment can't be voided or returned through this API. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Processor's transaction ID of an online payment. |
| settlementID required | string or null^-?[0-9]+$ Processor settlement an online payment was paid out in. |
| paymentAccountName required | string or null <= 200 characters Name on the account an online payment came from. |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last digits of the account an online payment came from. |
| depositID required | string or null^-?[0-9]+$ Bank deposit the payment is in; a payment must be deposited before it can be returned. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation the transaction was reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Reconciliation the transaction was in before it was last unreconciled. |
required | transaction_statuses (string) or null Status of an ACH transfer. |
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer the transaction belongs to. |
| lateFeePeriod required | string or null^-?[0-9]+$ Late fee period a late-fee charge was raised for. |
| isFromManager required | string or null Enum: "0" "1" null Whether a resident-portal transaction was entered by the manager. |
| isMoveInCharge required | string or integer Enum: 0 "1" Whether this is a move-in charge. The save sets an empty value to the number |
| isProrated required | string or integer Enum: 0 "1" Whether this is a prorated charge. The save sets an empty value to the number |
| isMoveOutTransaction required | string or integer Enum: 0 "1" Whether this is a move-out transaction. The save sets an empty value to the number |
| moveOutAmount required | string or null <decimal> Amount counted toward the move-out statement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge a discount or markup belongs to. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge or credit that raised the transaction. |
| residentServiceID required | string or null^-?[0-9]+$ Resident service the charge is for. |
| residentPackageID required | string or null^-?[0-9]+$ Resident package the charge is for. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency of a withholding. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact a withholding is held for. |
| datePosted required | string <date> Date the transaction posts to the ledger. |
| dateTimeCreated required | string When the transaction was created. UTC, formatted |
| dateTimeModified required | string When the transaction was last changed. UTC, formatted |
{- "transactionID": "361",
- "transactionTypeID": "19",
- "managementFeeMode": "2",
- "primaryLedgerID": "615",
- "portfolioID": "317",
- "propertyID": "298",
- "unitID": "298",
- "leaseID": "298",
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": "56",
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": "56",
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "1000.00",
- "amountPaid": null,
- "amountAllocated": 0,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Security deposit release",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": 1,
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": 0,
- "isProrated": 0,
- "isMoveOutTransaction": 0,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-11-09",
- "dateTimeCreated": "2026-11-09 04:56:23",
- "dateTimeModified": "2026-11-09 04:56:24"
}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.
isVoided=1.transactionEntriesLedgerIDs[].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.name[]=.transactionID, newest first.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 entriesGET /accounting/recurring-ledger-transfers/search - the recurring ledger transfer schedules| search | string Example: search=reclass Substring matched against the description, or the exact amount ( |
| isVoided | string or integer or boolean
|
| 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 |
| datePostedMax | string Example: datePostedMax=2026-10-31 Only transfers posted on or before this date, as |
| transactionEntriesLedgerIDs[] | Array of integers Example: transactionEntriesLedgerIDs[]=8203 Only transfers with an entry on one of these ledgers, each as a separate |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The transaction's main columns. |
required | object The primary ledger. Both fields are |
required | object The transaction's property. Every field is |
required | object The transaction's portfolio. Both fields are |
required | object The transaction's unit. Every field is |
required | object What the transaction's entries post to. |
[- {
- "transaction": {
- "transactionID": "216",
- "transactionTypeID": "15",
- "primaryLedgerID": null,
- "billID": null,
- "bulkPaymentID": null,
- "description": "Wrenfield reserve top-up",
- "isVoided": "0",
- "amount": "450.00",
- "datePosted": "2026-10-31",
- "reference": "LT-1001",
- "payoutID": null,
- "payoutReturnID": null,
- "dateTimeCreated": "2026-11-16 19:21:49",
- "dateTimeModified": "2026-11-16 19:21:49",
- "contactID": null
}, - "ledger": {
- "ledgerID": null,
- "name": null
}, - "property": {
- "propertyID": null,
- "name": null,
- "address": null,
- "address2": null,
- "city": null,
- "stateID": null,
- "postalCode": null,
- "isMultiUnit": null
}, - "portfolio": {
- "portfolioID": null,
- "name": null
}, - "unit": {
- "unitID": null,
- "name": null,
- "address": null,
- "address2": null,
- "city": null,
- "stateID": null,
- "postalCode": null
}, - "transactionEntries": {
- "ledgerNames": "Cormier PLC Portfolio, FXF41 - Hermiston Inc Portfolio"
}
}
]Posts a journal entry: a transaction of type 11 (Journal Entry) on one ledger, made of at least two lines that
debit and credit chart-of-accounts accounts by equal totals. Answers with the new transaction as
GET /accounting/transactions/{transactionID} reads it.
Accounting › ModifyJournalEntries); without it, 403
{"error": "Permission Denied"}.{"error": "Access Denied"}.ledgerID present ({"ledgerID": "Ledger is Required"}) and naming a ledger (Ledger is Invalid); the ledger restriction above; the lines as a set (at least two, Journal Entry must have at least 2 entries.; a debit or a credit on each line, not both; 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.debitEntry.<field> or creditEntry.<field> and don't say which line failed: an account that
doesn't exist (Account does not exist.), or a credit line of zero (Entry must have a credit or debit > 0.00,
with Credit is required). So every line needs an amount above zero.debit or credit that isn't a number fails while the lines are read, after the ledger checks, and answers
500.primaryLedgerID is the portfolio's
ledger, with propertyID (and unitID) set.Cannot create a journal entry on the manager ledger when in billed management fee mode).managementFeeMode).includes to get related records in the response, as GET /accounting/transactions/{transactionID}
takes them.transactionLogs include) and one cash-and-accrual entry
per line (entries, cashEntries and accrualEntries includes).isSuppressed 1.GET /accounting/transactions/{transactionID} - Read the entry back, with includes.DELETE /accounting/journal-entries/{transactionID} - Void the entry.GET /accounting/journal-entries/search - Search journal entries.GET /accounting/ledgers/search - Search ledgers, for ledgerID.GET /accounting/accounts - List accounts, for each line's accountID.| includes | string Example: includes=ledger,property,entries Comma-separated list of related records to add to the response, each under its own key: |
| ledgerID required | string or integer^-?[0-9]+$ The ledger to post on, from |
| datePosted required | string The date the entry posts on, |
| description required | string [ 1 .. 4000 ] characters What the entry is for. |
required | Array of objects >= 2 items The entry's lines. Each line either debits or credits one account; the debits must add up to the credits, and
that total is the entry's |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (transaction_record) An accounting transaction: every column of the transaction row. Fields a transaction's type doesn't use are null (a journal entry fills its type, ledger, portfolio, property or unit, amount, description and dates). |
included_ledger (object) or null The transaction's primary ledger, or null when it has none (a ledger transfer, for example). Requires the
| |
included_portfolio (object) or false (any) The transaction's portfolio. When the transaction has none (a manager-ledger journal entry), this is | |
included_property (object) or null The transaction's property, or null when it has none. Requires the | |
included_unit (object) or null The transaction's unit, or null when it has none. Requires the | |
included_lease (object) or null The transaction's lease, or null when it has none. Requires the | |
| account | null Always |
included_contact (object) or null The transaction's contact (tenant, owner or vendor), or null when it has none. Requires the | |
included_reconciliation (object) or null The reconciliation that reconciled the transaction, or null. Requires the | |
included_reconciliation (object) or null The reconciliation the transaction was reconciled in before, or null. Requires the | |
transaction_record (object) or null The transaction this one returned: the transaction whose | |
included_bulk_payment (object) or null The bulk payment (bulk receipt) the transaction belongs to, or null. Requires the | |
Array of objects Every change made to the transaction (create, modify, void), newest first (changes made in the same second come in
no set order), one row per change. Requires the
| |
Array of objects (transaction_entry_row) The transaction's cash-basis entries that aren't voided (an accrual-only entry isn't listed), newest first: by
date posted, then transaction, then entry ID, each descending. Each comes with its ledger and related records.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every cash-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its ledger.
Requires the | |
Array of objects (transaction_entry_with_ledger) Every accrual-basis entry of the transaction, voided ones included, oldest first (by entry ID), each with its
ledger. Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The cash-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the | |
Array of objects (transaction_entry_archive_with_ledger) The accrual-basis entries a modify replaced, archived when the transaction was changed, each with its ledger.
Requires the |
{- "ledgerID": "109",
- "datePosted": "2026-10-31",
- "description": "Reclassify October landscaping invoice to repairs",
- "entries": [
- {
- "accountID": "259",
- "description": "Sprinkler valve repair",
- "debit": "125.00"
}, - {
- "accountID": "260",
- "description": "Moved from landscaping",
- "credit": "125.00"
}
]
}{- "transaction": {
- "transactionID": "24",
- "transactionTypeID": "11",
- "managementFeeMode": "2",
- "primaryLedgerID": "107",
- "portfolioID": "38",
- "propertyID": "35",
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "125.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Reclassify October landscaping invoice to repairs",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": "0",
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": null,
- "isProrated": null,
- "isMoveOutTransaction": null,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-10-31",
- "dateTimeCreated": "2026-11-12 23:26:02",
- "dateTimeModified": "2026-11-12 23:26:02"
}
}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.
isVoided=1.propertyIDs[], or those that touched a ledger with
transactionEntriesLedgerIDs[].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.name[]=.transactionID, newest first.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 entriesPOST /accounting/journal-entries - create a journal entryGET /accounting/recurring-journal-entries/search - the recurring journal entry schedules| 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 ( |
| isVoided | string or integer or boolean
|
| 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 |
| datePostedMax | string Example: datePostedMax=2026-10-31 Only entries posted on or before this date, as |
| propertyIDs[] | Array of integers Example: propertyIDs[]=3255 Only entries of these properties, each as a separate |
| transactionEntriesLedgerIDs[] | Array of integers Example: transactionEntriesLedgerIDs[]=8203 Only entries with an entry on one of these ledgers, each as a separate |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The transaction's main columns. |
required | object The primary ledger. Both fields are |
required | object The transaction's property. Every field is |
required | object The transaction's portfolio. Both fields are |
required | object The transaction's unit. Every field is |
required | object What the transaction's entries post to. |
[- {
- "transaction": {
- "transactionID": "190",
- "transactionTypeID": "11",
- "primaryLedgerID": "8203",
- "billID": null,
- "bulkPaymentID": null,
- "description": "Sablewood unit reclass",
- "isVoided": "0",
- "amount": "125.00",
- "datePosted": "2026-10-30",
- "reference": null,
- "payoutID": null,
- "payoutReturnID": null,
- "dateTimeCreated": "2026-11-16 19:21:40",
- "dateTimeModified": "2026-11-16 19:21:40",
- "contactID": null
}, - "ledger": {
- "ledgerID": "8203",
- "name": "Kassulke PLC Portfolio"
}, - "property": {
- "propertyID": "3255",
- "name": "4498 Okuneva Well Suite 139",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "NE",
- "postalCode": "12345",
- "isMultiUnit": "0"
}, - "portfolio": {
- "portfolioID": "3714",
- "name": "Kassulke PLC Portfolio"
}, - "unit": {
- "unitID": "2841",
- "name": "#775",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NV",
- "postalCode": "12345"
}, - "transactionEntries": {
- "ledgerNames": "Kassulke PLC Portfolio"
}
}
]Voids a journal entry: the transaction and its lines are marked voided and stay on record, with a "void" log. It
answers with the voided transaction itself, not wrapped in transaction.
Accounting › VoidJournalEntries); without it, 403
{"error": "Permission Denied"}. Modify Journal Entries alone isn't enough.{"error": "Journal Entry <id> not found"}.{"error": "Access Denied"} for an entry outside them.{"isVoided": ["Cannot modify a voided transaction"]}), and so is one with a
reconciled line ({"reconciliationID": ["Cannot modify a journal entry that has been reconciled"]}).isVoided becomes 1, and so does each of its lines that isn't voided yet (the cashEntries
and accrualEntries includes show them; the entries include, which lists only lines that aren't voided, comes
back empty).transactionLogs include).GET /accounting/transactions/{transactionID} - Read the voided entry and its lines.POST /accounting/journal-entries - Post a corrected entry.| transactionID required | integer Example: 80980 The journal entry's transaction ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| transactionID required | string^-?[0-9]+$ Unique identifier for the transaction. |
| transactionTypeID required | string (transaction_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25"
|
| managementFeeMode required | string (management_fee_modes) Enum: "1" "2" Management fee calculation mode applied to this transaction.
|
| primaryLedgerID required | string or null^-?[0-9]+$ The ledger the transaction posts on ( |
| portfolioID required | string or null^-?[0-9]+$ Portfolio this transaction belongs to. |
| propertyID required | string or null^-?[0-9]+$ Property associated with this transaction. |
| unitID required | string or null^-?[0-9]+$ Unit associated with this transaction. |
| leaseID required | string or null^-?[0-9]+$ Lease this transaction is posted against. |
| billID required | string or null^-?[0-9]+$ Bill linked to this transaction, if any. |
| contactID required | string or null^-?[0-9]+$ The contact (tenant, owner or vendor) the transaction belongs to, or null. |
| bankAccountID required | string or null^-?[0-9]+$ Bank account the payment was deposited into, if applicable. |
| chargeAccountID required | string or null^-?[0-9]+$ Chart-of-account ID the charge posts against (present for charge transactions). |
| equityAccountID required | string or null^-?[0-9]+$ Equity account ID, if applicable. |
| destinationBankAccountID required | string or null^-?[0-9]+$ Destination bank account for transfer transactions. |
| managementFeeIncomeAccountID required | string or null^-?[0-9]+$ Income account used for management fee recording. |
required | account_filter_types (string) or null Filter type controlling which prepayment account is used.
|
| prepaymentAccountID required | string or null^-?[0-9]+$ Prepayment/unapplied account ID. Use |
| unallocatedAccountID required | string or null^-?[0-9]+$ Account used to hold unallocated payment funds. |
| payoutID required | string or null^-?[0-9]+$ Payout linked to this transaction, if any. |
| payoutReturnID required | string or null^-?[0-9]+$ Payout return linked to this transaction, if any. |
| amount required | string <decimal> Transaction amount as a decimal string. |
| amountPaid required | string or null <decimal> Amount of the charge that has been paid so far. |
| amountAllocated required | string or null <decimal> Portion of a payment that has been applied to charges. |
| processingFee required | string or null <decimal> Processing fee amount collected on this payment, if any. |
| convenienceFee required | string or null <decimal> Convenience fee charged on online payments. |
| convenienceFeeTransactionID required | string or null^-?[0-9]+$ Transaction ID of the associated convenience fee transaction. |
| description required | string or null <= 4000 characters Free-text label for this transaction. |
| reference required | string or null <= 200 characters External reference number (e.g. check number, ACH trace ID). |
| receivedFrom required | string or null <= 100 characters Name of the payer as recorded on the transaction. |
| returnTransactionID required | string or null^-?[0-9]+$ On a transaction that was returned (a payment), the ID of the return transaction that reversed it; null otherwise. The |
required | return_types (string) or null Return type code when this is a returned payment.
|
| returnDescription required | string or null <= 200 characters Reason for the return. |
| bulkPaymentID required | string or null^-?[0-9]+$ Bulk payment batch this transaction belongs to, if any. |
required | payment_types (string) or null How the payment was made, or null on a transaction that isn't a payment.
|
| billChargeTransactionID required | string or null^-?[0-9]+$ Charge transaction on a bill that this payment is applied to. |
| billCreditTransactionID required | string or null^-?[0-9]+$ Credit transaction on a bill associated with this transaction. |
| discountAmount required | string or null <decimal> Discount amount applied to this transaction. |
| markupAmount required | string or null <decimal> Markup amount applied to this transaction. |
| managementFeeAmountPaid required | string or null <decimal> Management fee portion that has been paid. |
| isAdditionalManagementFee required | string or null Enum: "0" "1" null Whether this transaction is an additional management fee charge ( |
| managementFeePercent required | string or null <decimal> Management fee percentage applied to this transaction. |
| isSuppressed required | string Enum: "0" "1" Whether this transaction is suppressed from certain reports ( |
| managementFeeExpenseAccountID required | string or null^-?[0-9]+$ Expense account used for management fee disbursements. |
| managementFeePeriodDate required | string or null <date> Period date for management fee calculation. |
| managementFeeSalesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to the management fee on this transaction. |
| managementFeeSalesTaxAmountPaid required | string or null <decimal> Sales tax amount on the management fee that has been paid. |
| managementFeeSalesTaxPercent required | string or null <decimal> Sales tax percentage applied to the management fee. |
| managementFeeSalesTaxIncomeAccountID required | string or null^-?[0-9]+$ Income account for management fee sales tax. |
| managementFeeSalesTaxExpenseAccountID required | string or null^-?[0-9]+$ Expense account for management fee sales tax. |
| managementFeeBatchID required | string or null^-?[0-9]+$ Management fee batch this transaction belongs to, if any. |
| isSalesTaxCharge required | string or null Enum: "0" "1" null Whether this transaction is a sales tax charge ( |
| salesTaxSettingID required | string or null^-?[0-9]+$ Sales tax setting applied to this charge transaction. |
| salesTaxInitiatedFromTransactionID required | string or null^-?[0-9]+$ ID of the parent transaction that triggered this sales tax charge. |
| isVoided required | integer Value: 1 Always |
| bankAccountGatewayID required | string or null^-?[0-9]+$ Payment gateway ID associated with the bank account. |
| bankAccountGatewayTransactionID required | string or null <= 100 characters Gateway-assigned transaction identifier. |
| settlementID required | string or null^-?[0-9]+$ Settlement batch this transaction was settled in. |
| paymentAccountName required | string or null <= 200 characters Bank account name of the payer (for ACH/card transactions). |
| paymentAccountNumberTruncated required | string or null <= 10 characters Last 4 digits of the payer's account number. |
| depositID required | string or null^-?[0-9]+$ Deposit batch this payment was included in. |
| reconciliationID required | string or null^-?[0-9]+$ Bank reconciliation this transaction has been reconciled in. |
| previousReconciliationID required | string or null^-?[0-9]+$ Previous reconciliation ID if the transaction was moved between reconciliations. |
required | transaction_statuses (string) or null ACH processing status code for electronic payments.
|
| bankTransferID required | string or null^-?[0-9]+$ Bank transfer record ID for ACH transactions. |
| lateFeePeriod required | string or null^-?[0-9]+$ On a late fee charge, the period the late fee was assessed for; null otherwise. |
| isFromManager required | string or null Enum: "0" "1" null Whether this transaction was entered directly by a manager ( |
| isMoveInCharge required | integer Value: 0 Always |
| isProrated required | integer Value: 0 Always |
| isMoveOutTransaction required | integer Value: 0 Always |
| moveOutAmount required | string or null <decimal> Amount applied during move-out settlement. |
| discountMarkupBillChargeTransactionID required | string or null^-?[0-9]+$ Bill charge transaction ID for discount or markup adjustments. |
| recurringObjectID required | string or null^-?[0-9]+$ Recurring charge object that generated this transaction, if any. |
| residentServiceID required | string or null^-?[0-9]+$ ID of the service this record points to. |
| residentPackageID required | string or null^-?[0-9]+$ ID of the package this record points to. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ Tax agency for withholding tax, if applicable. |
| withholdingTaxContactID required | string or null^-?[0-9]+$ Contact associated with withholding tax, if applicable. |
| datePosted required | string <date> Date the transaction was posted to the ledger. |
| dateTimeCreated required | string Timestamp when the transaction record was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the transaction record was last modified. UTC, formatted |
{- "transactionID": "11",
- "transactionTypeID": "11",
- "managementFeeMode": "2",
- "primaryLedgerID": "62",
- "portfolioID": "21",
- "propertyID": "21",
- "unitID": null,
- "leaseID": null,
- "billID": null,
- "contactID": null,
- "bankAccountID": null,
- "chargeAccountID": null,
- "equityAccountID": null,
- "destinationBankAccountID": null,
- "managementFeeIncomeAccountID": null,
- "prepaymentAccountFilterTypeID": null,
- "prepaymentAccountID": null,
- "unallocatedAccountID": null,
- "payoutID": null,
- "payoutReturnID": null,
- "amount": "125.00",
- "amountPaid": null,
- "amountAllocated": null,
- "processingFee": null,
- "convenienceFee": null,
- "convenienceFeeTransactionID": null,
- "description": "Reclassify October landscaping invoice to repairs",
- "reference": null,
- "receivedFrom": null,
- "returnTransactionID": null,
- "returnTypeID": null,
- "returnDescription": null,
- "bulkPaymentID": null,
- "paymentTypeID": null,
- "billChargeTransactionID": null,
- "billCreditTransactionID": null,
- "discountAmount": null,
- "markupAmount": null,
- "managementFeeAmountPaid": null,
- "isAdditionalManagementFee": null,
- "managementFeePercent": null,
- "isSuppressed": "0",
- "managementFeeExpenseAccountID": null,
- "managementFeePeriodDate": null,
- "managementFeeSalesTaxSettingID": null,
- "managementFeeSalesTaxAmountPaid": null,
- "managementFeeSalesTaxPercent": null,
- "managementFeeSalesTaxIncomeAccountID": null,
- "managementFeeSalesTaxExpenseAccountID": null,
- "managementFeeBatchID": null,
- "isSalesTaxCharge": null,
- "salesTaxSettingID": null,
- "salesTaxInitiatedFromTransactionID": null,
- "isVoided": 1,
- "bankAccountGatewayID": null,
- "bankAccountGatewayTransactionID": null,
- "settlementID": null,
- "paymentAccountName": null,
- "paymentAccountNumberTruncated": null,
- "depositID": null,
- "reconciliationID": null,
- "previousReconciliationID": null,
- "achStatusID": null,
- "bankTransferID": null,
- "lateFeePeriod": null,
- "isFromManager": null,
- "isMoveInCharge": 0,
- "isProrated": 0,
- "isMoveOutTransaction": 0,
- "moveOutAmount": null,
- "discountMarkupBillChargeTransactionID": null,
- "recurringObjectID": null,
- "residentServiceID": null,
- "residentPackageID": null,
- "withholdingTaxAgencyID": null,
- "withholdingTaxContactID": null,
- "datePosted": "2026-10-31",
- "dateTimeCreated": "2026-11-12 23:25:52",
- "dateTimeModified": "2026-11-12 23:25:53"
}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.
nextRunDateMin and nextRunDateMax.bankAccountIDs[], or those that touch a ledger with
ledgerIDs[].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.name[]=.recurringLedgerTransferID.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| search | string Example: search=reserve Substring matched against the reference and the description, or the exact amount ( |
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=8203 Only schedules with an entry on one of these ledgers, each as a separate |
| bankAccountIDs[] | Array of integers Example: bankAccountIDs[]=31 Only schedules paid from these bank accounts, each as a separate |
| 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 |
| endDateMax | string Example: endDateMax=2027-06-30 Only schedules whose end date is on or before this date, as |
| nextRunDateMin | string Example: nextRunDateMin=2026-12-01 Only schedules whose next run date is on or after this date, as |
| nextRunDateMax | string Example: nextRunDateMax=2026-12-01 Only schedules whose next run date is on or before this date, as |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The schedule. |
[- {
- "recurringLedgerTransfer": {
- "recurringLedgerTransferID": "1",
- "amount": "600.00",
- "bankAccountID": "750",
- "description": "Ashgrove monthly reserve",
- "endDate": "2027-06-30",
- "frequency": "1",
- "nextRunDate": "2026-12-01",
- "reference": "RLT-2001",
- "scheduleFrequencyID": "3",
- "ledgerNames": "BMLD605 - Runolfsson, Bartoletti and Friesen Portfolio, LAMT47 - Miller-Murray Portfolio"
}
}
]Returns a page of recurring journal entry schedules. Each row holds the schedule under recurringJournalEntry and
its ledger under ledger.
nextRunDateMin and nextRunDateMax.ledgerIDs[].search is a substring match on the description, or the exact amount (240.00).name[]=.recurringJournalEntryID.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| search | string Example: search=accrual Substring matched against the description, or the exact amount ( |
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=8303 Only schedules on these ledgers, each as a separate |
| 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 |
| endDateMax | string Example: endDateMax=2027-06-30 Only schedules whose end date is on or before this date, as |
| nextRunDateMin | string Example: nextRunDateMin=2026-12-01 Only schedules whose next run date is on or after this date, as |
| nextRunDateMax | string Example: nextRunDateMax=2026-12-01 Only schedules whose next run date is on or before this date, as |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The schedule. |
required | object (included_ledger) An accounting ledger (every column of the row; the shared ledger model lacks the timestamps). |
[- {
- "recurringJournalEntry": {
- "recurringJournalEntryID": "1",
- "ledgerID": "8303",
- "description": "Bramblecote monthly accrual",
- "amount": "240.00",
- "endDate": "2027-06-30",
- "nextRunDate": "2026-12-01",
- "frequency": "1",
- "scheduleFrequencyID": "3"
}, - "ledger": {
- "ledgerID": "8303",
- "ledgerTypeID": "4",
- "objectID": "2855",
- "name": "Bramblecote Unit Ledger",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:21:55",
- "dateTimeModified": "2026-11-16 19:21:55"
}
}
]The debit and credit lines that make up each transaction, each posted to one account on one ledger. Search entries across all transactions.
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.
ledgerIDs[]).isCash, isAccrual), or leave out suppressed lines (isSuppressed).dateTimeModifiedMin).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.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.| 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
|
| isSuppressed | string Example: isSuppressed=false
|
| isCash | string Example: isCash=false
|
| isAccrual | string Example: isAccrual=false
|
| 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 |
| datePostedMax | string Example: datePostedMax=2024-12-31 Only lines posted on or before this date, as |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-10-01 00:00:00 Only lines whose transaction changed at or after this time, in UTC, as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-10-31 23:59:59 Only lines whose transaction changed at or before this time, in UTC, as |
| transactionTypeIDs[] | Array of integers Example: transactionTypeIDs[]=12&transactionTypeIDs[]=15 Only lines whose transaction has one of these types (the values of |
| transactionTypeID | integer Example: transactionTypeID=12 The same filter for one ID, read only when |
| propertyIDs[] | Array of integers Example: propertyIDs[]=12&propertyIDs[]=15 Only lines whose transaction is on one of these properties ( |
| propertyID | integer Example: propertyID=12 The same filter for one ID, read only when |
| ledgerIDs[] | Array of integers Example: ledgerIDs[]=12&ledgerIDs[]=15 Only lines posted to these ledgers ( |
| ledgerID | integer Example: ledgerID=12 The same filter for one ID, read only when |
| 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. |
| pagination-page-size | integer Example: "2" Page size used -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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
|
required | object
|
required | object
|
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. |
[- {
- "transactionEntry": {
- "transactionEntryID": "612",
- "transactionLogID": "483",
- "accountID": "2087",
- "entryTypeID": "2",
- "receiptID": null,
- "description": "Eos quasi porro tempora accusamus quisquam.",
- "credit": "0.00",
- "debit": "2639.95",
- "isVoided": "0",
- "isSuppressed": "0",
- "reconciliationID": "165",
- "previousReconciliationID": "166",
- "isCash": "1",
- "isAccrual": "1",
- "datePosted": "2026-11-16",
- "dateTimeCreated": "2026-11-16 19:34:05"
}, - "ledger": {
- "ledgerID": "9663",
- "ledgerTypeID": "2",
- "name": "Sawayn-Bergnaum Portfolio"
}, - "transaction": {
- "transactionID": "860",
- "transactionTypeID": "1",
- "primaryLedgerID": "9663",
- "billID": null,
- "description": "Id aspernatur error quas maiores maiores.",
- "isVoided": "0",
- "amount": "4735.73",
- "datePosted": "2026-11-16",
- "reference": null,
- "payoutID": null,
- "payoutReturnID": null,
- "dateTimeCreated": "2026-11-16 19:34:05",
- "dateTimeModified": "2026-11-16 19:34:05"
}, - "primaryLedger": {
- "ledgerID": "9663",
- "ledgerTypeID": "2",
- "name": "Sawayn-Bergnaum Portfolio"
}, - "property": {
- "propertyID": "3761",
- "name": "5068 Larson Junctions",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "TX",
- "postalCode": "12345",
- "isMultiUnit": "0"
}, - "portfolio": {
- "portfolioID": "4564",
- "name": "Sawayn-Bergnaum Portfolio"
}, - "unit": {
- "unitID": "3209",
- "name": "Apt 339",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "NV",
- "postalCode": "12345"
}, - "reconciliation": {
- "reconciliationID": "165",
- "statementStartDate": "2026-08-31",
- "statementEndDate": "2026-10-01",
- "statementEndingBalance": "94387.06",
- "previousStatementEndingBalance": "83473.99",
- "isCurrent": "1",
- "dateTimeCreated": "2026-11-16 19:34:05"
}, - "previousReconciliation": {
- "reconciliationID": "166",
- "statementStartDate": "2026-07-23",
- "statementEndDate": "2026-08-23",
- "statementEndingBalance": "84593.89",
- "previousStatementEndingBalance": "70488.17",
- "isCurrent": "0",
- "dateTimeCreated": "2026-11-16 19:34:05"
}
}
]Owners are the contacts who own your properties, through the portfolios they belong to. List, search, create, read, update, activate, deactivate and delete 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.
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.name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /owners/search, which breaks ties on contactID.GET /owners/search - filtered search with computed insurance and tax columnsGET /owners/{contactID} - one owner, with includesPOST /owners - create an owner| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[0-9]+$ The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. |
[- {
- "contact": {
- "contactID": "2686",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "C-6af8ddd922c15",
- "name": "Jane Doe",
- "firstName": "Jane",
- "middleName": null,
- "lastName": "Doe",
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "MI",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "162",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "146",
- "dateTimeCreated": "2026-11-14 22:16:57",
- "dateTimeModified": "2026-11-14 22:16:57",
- "dateTimeDeactivated": null,
- "contactType": "Owner"
}, - "token": "1794694617"
}
]Creates 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.
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.3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request
with either and without them is refused with 400.firstName, middleName, lastName and suffix are parsed from name; payoutTypeID
defaults to 2 (Check), and holdPayments, preventConsolidatedPayments, achIsCorporateAccount and
isBillApprovalExempt to 0.contact.email,
contact.phone and the contact's address fields.contact.hasTaxIdentifier says one is stored.GET /owners/{contactID} - get the ownerPOST /owners/{contactID} - update the ownerGET /owners/search - search owners| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| name required | string [ 1 .. 100 ] characters The owner's full name. |
| 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 |
| 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
|
(bank_account_types_request (string or integer)) or null The kind of bank account payments go to; required with a payout type of | |
| achIsCorporateAccount | string or integer Default: 0 Enum: "0" "1" 0 1 Whether the owner's bank account is a business account. |
| holdPayments | string or integer Default: 0 Enum: "0" "1" 0 1 Whether payments to the owner are held. |
| 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. |
| payeeName | string or null <= 100 characters The name payments are made out to, when it isn't |
| 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. |
| 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 |
| 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).
|
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "name": "Jordan Rivera",
- "code": "OWN-1001",
- "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": [
- {
- "email": "jordan.rivera@example.com"
}, - {
- "email": "billing@example.com",
- "sendWorkOrderNotifications": 0
}, - {
- "sendEmailNotifications": 1
}
], - "phones": [
- {
- "phone": "+19195550100",
- "phoneTypeID": 1,
- "description": "Cell"
}
], - "addresses": [
- {
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601"
}
]
}{- "contact": {
- "contactID": "2702",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "OWN-1001",
- "name": "Jordan Rivera",
- "firstName": "Jordan",
- "middleName": null,
- "lastName": "Rivera",
- "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": "Rivera Holdings LLC",
- "taxPayerName": "Rivera Holdings LLC",
- "taxFormTypeID": "1",
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "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": null,
- "preventConsolidatedPayments": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-16 22:44:57",
- "dateTimeModified": "2026-11-16 22:44:57",
- "dateTimeDeactivated": null,
- "contactType": "Owner",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null
}
}Returns a page of owners with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.
code: read it from GET /owners/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive filters only when sent: without it the search returns active and inactive owners.search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.pageSize of 0 or less is served at 15.orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /owners - the plain list, with the full contact rowGET /owners/{contactID} - one owner, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "contact": {
- "contactID": "2763",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "CO",
- "postalCode": "12345",
- "countryID": "US",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "payoutTypeID": "1",
- "achDetailsCiphertextID": "167",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "holdPayments": "1",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "isBillingSalesTaxEnabled": "0",
- "daysUntilLiabilityInsuranceExpires": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "daysUntilWorkersCompInsuranceExpires": null,
- "insuranceExpiresDate": null,
- "daysUntilInsuranceExpires": null,
- "discountPercent": null,
- "discountGraceDays": null,
- "isActive": "1",
- "invoiceAutofillTemplateID": "151",
- "dateTimeCreated": "2026-11-14 22:17:12",
- "dateTimeModified": "2026-11-14 22:17:12",
- "dateTimeDeactivated": null,
- "isInsuranceRequiredForPayment": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "identificationCountryID": "US",
- "hasTaxIdentifier": "1",
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null,
- "hasDuplicateTaxIdentifier": "0",
- "propertyCount": "0"
}, - "search": {
- "rank": "10"
}
}
]Returns one owner: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.
{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact.hasTaxIdentifier says whether one is stored.includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportfolios - the portfolios the owner holds a share of, each as owner (the share) and portfolio. A user restricted to portfolio groups gets only the portfolios they may accessportalAccounts - the owner portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the owner portal, newest firsttaxAdjustments - the contact's 1099 tax adjustmentsGET /owners - list ownersGET /owners/search - search ownersPOST /owners/{contactID} - update the owner| contactID required | integer Example: 1042 The owner's contact ID. A well-formed ID that isn't an owner answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "contact": {
- "contactID": "2958",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "C-6af8ddfc7f21f",
- "name": "Jane Doe",
- "firstName": "Jane",
- "middleName": null,
- "lastName": "Doe",
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NH",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "172",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "156",
- "dateTimeCreated": "2026-11-14 22:17:32",
- "dateTimeModified": "2026-11-14 22:17:32",
- "dateTimeDeactivated": null,
- "contactType": "Owner",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null
}, - "emails": [
- {
- "email": {
- "contactEmailID": "105",
- "contactID": "2958",
- "isPrimary": "1",
- "email": "jane.doe@example.com",
- "sendEmailNotifications": "1",
- "sendPaymentNotifications": "1",
- "sendWorkOrderNotifications": "1"
}
}
], - "phones": [
- {
- "phone": {
- "contactPhoneID": "105",
- "contactID": "2958",
- "isPrimary": "1",
- "phone": "555-0100",
- "phoneTypeID": "1",
- "description": "Office",
- "isActive": "1"
}
}
], - "addresses": [
- {
- "address": {
- "contactAddressID": "105",
- "contactID": "2958",
- "isPrimary": "1",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345"
}
}
], - "portfolios": [
- {
- "owner": {
- "portfolioOwnerID": "61",
- "portfolioID": "732",
- "contactID": "2958",
- "percentOwned": "100.0000",
- "percentDistributed": "100.0000",
- "overrideContactPayoutSettings": "0",
- "payeeName": null,
- "payoutTypeID": "2",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0"
}, - "portfolio": {
- "portfolioID": "732",
- "code": "HQ183",
- "name": "Daniel, Rodriguez and Wunsch Portfolio",
- "contacts": null,
- "postingSettingID": "734",
- "assignedToUserID": null,
- "minimumDistributionAmount": null,
- "maximumDistributionAmount": null,
- "reserveAmount": "0.00",
- "additionalReserveAmount": "0.00",
- "additionalReserveDescription": null,
- "overdraftOverrideAmount": null,
- "fiscalYearEndMonth": "12",
- "statementSettingID": "733",
- "sendStatements": "1",
- "holdDistributions": "0",
- "holdDistributionsDescription": null,
- "isActive": "1",
- "isLiveLedgerEnabled": null,
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-14 22:17:32",
- "dateTimeModified": "2026-11-14 22:17:32",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": null
}
}
], - "portalAccounts": [
- {
- "userPortalAccountID": "106",
- "userID": "1923",
- "accountID": "1",
- "portalTypeID": "2",
- "portalID": "2958",
- "email": "jane.doe@example.com",
- "isActive": "1",
- "firstName": "Jane",
- "lastName": "Doe",
- "phone": "555-0100",
- "timeZone": "UTC"
}
], - "portalInvitations": [
- {
- "userPortalInvitationID": "104",
- "accountID": "1",
- "portalInvitationStatusID": "1",
- "portalTypeID": "2",
- "portalID": "2958",
- "email": "jane.doe@example.com",
- "roleID": "1",
- "portfolioGroupIDs": "[1, 2]",
- "dateTimeCreated": "2026-11-14 22:17:32",
- "dateTimeExpires": "2026-12-14 22:17:32",
- "nextReminderDateTime": "2026-11-16 22:17:32"
}
], - "taxAdjustments": [
- {
- "taxAdjustmentID": "104",
- "contactID": "2958",
- "amount": "125.50",
- "description": "Prior-year adjustment",
- "datePosted": "2025-12-31"
}
]
}Updates 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.
Contacts › UpdateOwner).{} 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.dateTimeModified changes.{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.name is copied into the owner list of each portfolio the owner holds a share of (the contacts of
GET /portfolios/{portfolioID}).GET /owners/{contactID} - get the ownerPOST /owners - create an ownerPOST /owners/{contactID}/deactivate - deactivate the ownerPOST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have
the same phones and addresses routesPOST /owners/{contactID}/tax-details (undocumented) - change the tax detailsPOST /owners/{contactID}/ach-details (undocumented) - change the payout settings| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| name | string [ 1 .. 100 ] characters The owner's full name. |
| 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 |
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "name": "Jordan A. Rivera",
- "code": "OWN-2002",
- "birthDate": "1981-05-13",
- "isBillApprovalExempt": 1
}{- "contact": {
- "contactID": "2707",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "OWN-2002",
- "name": "Jordan A. Rivera",
- "firstName": "Jordan",
- "middleName": "A.",
- "lastName": "Rivera",
- "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": "1981-05-13",
- "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": "317",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "307",
- "dateTimeCreated": "2026-11-16 22:45:01",
- "dateTimeModified": "2026-11-16 22:45:01",
- "dateTimeDeactivated": null,
- "contactType": "Owner",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateOwner).{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact, with no tax-identifier
keys.isActive 0), so text threads stay linked.GET /files/{fileID} too; a file still attached elsewhere is kept.POST /owners/{contactID}/deactivate - deactivate the owner insteadGET /owners/{contactID} - get the owner| contactID required | integer Example: 1042 The owner's contact ID. A well-formed ID that isn't an owner answers 400; one that isn't a whole number of digits, 404. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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: |
| vendorTypeID required | string or null^-?[0-9]+$ Vendor type, from |
| 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 |
| middleName required | string or null <= 100 characters Middle name, parsed from |
| lastName required | string or null <= 100 characters Last name, parsed from |
| suffix required | string or null <= 15 characters Name suffix, parsed from |
| 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 |
required | other_payout_types (string) or null How the contact is paid outside Rentvine when |
| 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"
|
| holdPayments required | string Enum: "0" "1"
|
| 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), |
| 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 |
| 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"
|
| isInsuranceRequiredForPayment required | string or null Enum: "0" "1" null
|
| maxLineItemsOnPayment required | string or null^-?[0-9]+$ Maximum number of bill line items allowed per payment, or null. |
| preventConsolidatedPayments required | string Enum: "0" "1"
|
| isFromImport required | string Enum: "0" "1"
|
| 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 |
| isBillApprovalExempt required | string Enum: "0" "1"
|
| isBillingSalesTaxEnabled required | string Enum: "0" "1"
|
| isQuickbooksExportEnabled required | string Enum: "0" "1"
|
| 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 |
| dateTimeModified required | string Date and time in UTC, formatted |
| dateTimeDeactivated required | string or null Date and time in UTC, formatted |
| contactType required | string Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead" The contact type's label, computed in PHP: |
{- "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,
- "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"
}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.
Contacts › UpdateOwner).dateTimeModified changes.{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /owners/{contactID}/deactivate - deactivate the ownerGET /owners/{contactID} - get the owner| contactID required | integer Example: 1042 The owner's contact ID. A well-formed ID that isn't an owner answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "contact": {
- "contactID": "2715",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "C-6afb8770b60b2",
- "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": "320",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "310",
- "dateTimeCreated": "2026-11-16 22:45:04",
- "dateTimeModified": "2026-11-16 22:45:04",
- "dateTimeDeactivated": null,
- "contactType": "Owner",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateOwner).dateTimeDeactivated keeps its value and only dateTimeModified changes.{"error": "Owner {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /owners/{contactID}/activate - activate the owner againDELETE /owners/{contactID} - delete the owner insteadGET /owners/{contactID} - get the owner| contactID required | integer Example: 1042 The owner's contact ID. A well-formed ID that isn't an owner answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (owner_portfolio_row) The portfolios the owner holds a share of, each as | |
Array of objects (contact_portal_account) The owner portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the owner portal, newest first. Requires the | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the |
{- "contact": {
- "contactID": "2717",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": "C-6afb8771a9204",
- "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": "321",
- "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": "0",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "311",
- "dateTimeCreated": "2026-11-16 22:45:05",
- "dateTimeModified": "2026-11-16 22:45:05",
- "dateTimeDeactivated": "2026-11-16 22:45:05",
- "contactType": "Owner",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Returns a page of tenants, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /tenants/search for more filters and computed columns.
isActive defaults to 1: only active tenants. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.search is a substring match on name and code.name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /tenants/search, which breaks ties on contactID.GET /tenants/search - filtered search with computed insurance and tax columnsGET /tenants/{contactID} - one tenant, with includesPOST /tenants - create a tenant| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[0-9]+$ The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. |
[- {
- "contact": {
- "contactID": "2687",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "C-6af8ddd9e2729",
- "name": "Jane Doe",
- "firstName": "Jane",
- "middleName": null,
- "lastName": "Doe",
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "OR",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "163",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "147",
- "dateTimeCreated": "2026-11-14 22:16:57",
- "dateTimeModified": "2026-11-14 22:16:57",
- "dateTimeDeactivated": null,
- "contactType": "Tenant"
}, - "token": "1794694618"
}
]Creates a 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.
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.firstName, middleName, lastName and suffix are parsed from name; payoutTypeID
is 2 (Check) and holdPayments 0.contact.email,
contact.phone and the contact's address fields.contact.hasTaxIdentifier says one is stored.GET /tenants/{contactID} - get the tenantPOST /tenants/{contactID} - update the tenantGET /tenants/search - search tenants| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| name required | string [ 1 .. 100 ] characters The tenant's full name. |
| 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 |
(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 |
| 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 |
| 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 |
| 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).
|
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "name": "Jordan Rivera",
- "code": "TEN-1001",
- "birthDate": "1980-04-12",
- "identificationTypeID": 1,
- "identificationNumber": "D1234567",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "taxPayerName": "Jordan Rivera",
- "taxIdentifier": "123456789",
- "emails": [
- {
- "email": "jordan.rivera@example.com"
}, - {
- "email": "billing@example.com",
- "sendWorkOrderNotifications": 0
}
], - "phones": [
- {
- "phone": "+19195550100",
- "phoneTypeID": 1,
- "description": "Cell"
}
], - "addresses": [
- {
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601"
}
]
}{- "contact": {
- "contactID": "2761",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "TEN-1001",
- "name": "Jordan Rivera",
- "firstName": "Jordan",
- "middleName": null,
- "lastName": "Rivera",
- "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": "Jordan Rivera",
- "taxFormTypeID": null,
- "identificationTypeID": "1",
- "identificationNumber": "D1234567",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": null,
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-16 22:45:18",
- "dateTimeModified": "2026-11-16 22:45:18",
- "dateTimeDeactivated": null,
- "contactType": "Tenant",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "1",
- "taxIdentifierCountryID": "US"
}
}Returns a page of tenants with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.
code: read it from GET /tenants/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive filters only when sent: without it the search returns active and inactive tenants.search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.pageSize of 0 or less is served at 15.orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /tenants - the plain list, with the full contact rowGET /tenants/{contactID} - one tenant, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "contact": {
- "contactID": "2764",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NY",
- "postalCode": "12345",
- "countryID": "US",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "payoutTypeID": "1",
- "achDetailsCiphertextID": "168",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "isBillingSalesTaxEnabled": "0",
- "daysUntilLiabilityInsuranceExpires": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "daysUntilWorkersCompInsuranceExpires": null,
- "insuranceExpiresDate": null,
- "daysUntilInsuranceExpires": null,
- "discountPercent": null,
- "discountGraceDays": null,
- "isActive": "1",
- "invoiceAutofillTemplateID": "152",
- "dateTimeCreated": "2026-11-14 22:17:12",
- "dateTimeModified": "2026-11-14 22:17:12",
- "dateTimeDeactivated": null,
- "isInsuranceRequiredForPayment": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "identificationCountryID": "US",
- "hasTaxIdentifier": "1",
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "1",
- "taxIdentifierCountryID": "US",
- "hasDuplicateTaxIdentifier": "0",
- "propertyCount": "0"
}, - "search": {
- "rank": "10"
}
}
]Returns one tenant: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.
{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact.hasTaxIdentifier says whether one is stored.includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressleases - the leases the tenant is on, each with leaseTenant, contact, lease, property and unit. Documented for a user with no portfolio-group restriction; a restricted user reads a tenant's leases through GET /leases/search (undocumented).portalAccounts - the resident portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the resident portal, newest firstGET /tenants - list tenantsGET /tenants/search - search tenantsPOST /tenants/{contactID} - update the tenant| contactID required | integer Example: 1042 The tenant's contact ID. A well-formed ID that isn't a tenant answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "contact": {
- "contactID": "2959",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "C-6af8ddfd2cfac",
- "name": "Jane Doe",
- "firstName": "Jane",
- "middleName": null,
- "lastName": "Doe",
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "MA",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "173",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "157",
- "dateTimeCreated": "2026-11-14 22:17:33",
- "dateTimeModified": "2026-11-14 22:17:33",
- "dateTimeDeactivated": null,
- "contactType": "Tenant",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "1",
- "taxIdentifierCountryID": "US"
}, - "emails": [
- {
- "email": {
- "contactEmailID": "106",
- "contactID": "2959",
- "isPrimary": "1",
- "email": "jane.doe@example.com",
- "sendEmailNotifications": "1",
- "sendPaymentNotifications": "1",
- "sendWorkOrderNotifications": "1"
}
}
], - "phones": [
- {
- "phone": {
- "contactPhoneID": "106",
- "contactID": "2959",
- "isPrimary": "1",
- "phone": "555-0100",
- "phoneTypeID": "1",
- "description": "Office",
- "isActive": "1"
}
}
], - "addresses": [
- {
- "address": {
- "contactAddressID": "106",
- "contactID": "2959",
- "isPrimary": "1",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345"
}
}
], - "leases": [
- {
- "leaseTenant": {
- "leaseTenantID": "276",
- "leaseID": "361",
- "contactID": "2959",
- "isPrimary": "1",
- "isActive": "1",
- "moveInDate": "2026-11-14",
- "moveOutDate": null
}, - "contact": {
- "contactID": "2959",
- "contactTypeID": "2",
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100"
}, - "lease": {
- "leaseID": "361",
- "propertyID": "590",
- "unitID": "463",
- "startDate": "2026-12-13",
- "endDate": "2027-12-13",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "1"
}, - "property": {
- "propertyID": "590",
- "isMultiUnit": "0",
- "propertyTypeID": "1",
- "name": "803 Dibbert Mall",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "MO",
- "postalCode": "12345",
- "countryID": "US"
}, - "unit": {
- "unitID": "463",
- "name": "Unit 452",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "AR",
- "postalCode": "12345",
- "addressValidationStatusID": "1"
}
}
], - "portalAccounts": [
- {
- "userPortalAccountID": "107",
- "userID": "1925",
- "accountID": "1",
- "portalTypeID": "3",
- "portalID": "2959",
- "email": "jane.doe@example.com",
- "isActive": "1",
- "firstName": "Jane",
- "lastName": "Doe",
- "phone": "555-0100",
- "timeZone": "UTC"
}
], - "portalInvitations": [
- {
- "userPortalInvitationID": "105",
- "accountID": "1",
- "portalInvitationStatusID": "1",
- "portalTypeID": "3",
- "portalID": "2959",
- "email": "jane.doe@example.com",
- "roleID": "1",
- "portfolioGroupIDs": "[1, 2]",
- "dateTimeCreated": "2026-11-14 22:17:33",
- "dateTimeExpires": "2026-12-14 22:17:33",
- "nextReminderDateTime": "2026-11-16 22:17:33"
}
]
}Updates 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.
Contacts › UpdateTenant).{} 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.dateTimeModified changes.{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.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.birthDate queues an update of the tenant's credit-reporting enrollment.name records a lease update event for each of those leases, which the account's webhooks receive.GET /tenants/{contactID} - get the tenantPOST /tenants - create a tenantPOST /tenants/{contactID}/deactivate - deactivate the tenantPOST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have
the same phones and addresses routesPOST /tenants/{contactID}/tax-details (undocumented) - change the tax details| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| name | string [ 1 .. 100 ] characters The tenant's full name. |
| 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 |
(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 |
| 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 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "name": "Jordan A. Rivera",
- "code": "TEN-2002",
- "birthDate": "1981-05-13",
- "identificationTypeID": 2,
- "identificationNumber": "P7654321",
- "identificationCountryID": "CA",
- "identificationIssuingLocation": "ON",
- "identificationExpirationDate": "2031-02-28"
}{- "contact": {
- "contactID": "2766",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "TEN-2002",
- "name": "Jordan A. Rivera",
- "firstName": "Jordan",
- "middleName": "A.",
- "lastName": "Rivera",
- "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": "1981-05-13",
- "defaultBillChargeAccountID": null,
- "payeeName": "Jordan Rivera",
- "taxPayerName": "Jordan Rivera",
- "taxFormTypeID": "1",
- "identificationTypeID": "2",
- "identificationNumber": "P7654321",
- "identificationCountryID": "CA",
- "identificationIssuingLocation": "ON",
- "identificationExpirationDate": "2031-02-28",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "326",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "316",
- "dateTimeCreated": "2026-11-16 22:45:20",
- "dateTimeModified": "2026-11-16 22:45:21",
- "dateTimeDeactivated": null,
- "contactType": "Tenant",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateTenant).{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact, with no tax-identifier
keys.isActive 0), so text threads stay linked.GET /files/{fileID} too; a file still attached elsewhere is kept.POST /tenants/{contactID}/deactivate - deactivate the tenant insteadGET /tenants/{contactID} - get the tenant| contactID required | integer Example: 1042 The tenant's contact ID. A well-formed ID that isn't a tenant answers 400; one that isn't a whole number of digits, 404. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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: |
| vendorTypeID required | string or null^-?[0-9]+$ Vendor type, from |
| 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 |
| middleName required | string or null <= 100 characters Middle name, parsed from |
| lastName required | string or null <= 100 characters Last name, parsed from |
| suffix required | string or null <= 15 characters Name suffix, parsed from |
| 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 |
required | other_payout_types (string) or null How the contact is paid outside Rentvine when |
| 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"
|
| holdPayments required | string Enum: "0" "1"
|
| 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), |
| 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 |
| 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"
|
| isInsuranceRequiredForPayment required | string or null Enum: "0" "1" null
|
| maxLineItemsOnPayment required | string or null^-?[0-9]+$ Maximum number of bill line items allowed per payment, or null. |
| preventConsolidatedPayments required | string Enum: "0" "1"
|
| isFromImport required | string Enum: "0" "1"
|
| 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 |
| isBillApprovalExempt required | string Enum: "0" "1"
|
| isBillingSalesTaxEnabled required | string Enum: "0" "1"
|
| isQuickbooksExportEnabled required | string Enum: "0" "1"
|
| 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 |
| dateTimeModified required | string Date and time in UTC, formatted |
| dateTimeDeactivated required | string or null Date and time in UTC, formatted |
| contactType required | string Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead" The contact type's label, computed in PHP: |
{- "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,
- "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"
}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.
Contacts › UpdateTenant).dateTimeModified changes.{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /tenants/{contactID}/deactivate - deactivate the tenantGET /tenants/{contactID} - get the tenant| contactID required | integer Example: 1042 The tenant's contact ID. A well-formed ID that isn't a tenant answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "contact": {
- "contactID": "2775",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "C-6afb87841eee5",
- "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": "329",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "319",
- "dateTimeCreated": "2026-11-16 22:45:24",
- "dateTimeModified": "2026-11-16 22:45:24",
- "dateTimeDeactivated": null,
- "contactType": "Tenant",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateTenant).dateTimeDeactivated keeps its value
and only dateTimeModified changes.{"error": "Tenant {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /tenants/{contactID}/activate - activate the tenant againDELETE /tenants/{contactID} - delete the tenant insteadGET /tenants/{contactID} - get the tenant| contactID required | integer Example: 1042 The tenant's contact ID. A well-formed ID that isn't a tenant answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (tenant_lease_row) The leases the tenant is on, each with | |
Array of objects (contact_portal_account) The resident portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the resident portal, newest first. Requires the |
{- "contact": {
- "contactID": "2777",
- "contactTypeID": "2",
- "vendorTypeID": null,
- "code": "C-6afb87850a675",
- "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": "330",
- "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": "0",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "320",
- "dateTimeCreated": "2026-11-16 22:45:25",
- "dateTimeModified": "2026-11-16 22:45:25",
- "dateTimeDeactivated": "2026-11-16 22:45:25",
- "contactType": "Tenant",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Returns a page of vendors, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /vendors/search for more filters and computed columns.
contactIDs[]isActive defaults to 1: only active vendors. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.search is a substring match on name and code.name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /vendors/search, which breaks ties on contactID.includeManager adds manager contacts and includeMaintenanceTechnician adds maintenance technicians to the list.contactIDs[] (or vendorContactIDs[]) returns those contacts when they are vendors, maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply.GET /vendors/search - filtered search with computed insurance and tax columnsGET /vendors/{contactID} - one vendor, with includesPOST /vendors - create a vendor| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 250 Example: pageSize=250 Items per page, from 1 (default 250). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| includeMaintenanceTechnician | string Also list maintenance technicians. |
| vendorTypeID | integer Only contacts of this vendor type, from |
| contactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| vendorContactIDs[] | Array of integers The older name of |
| pagination-page-size | integer Example: "250" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[0-9]+$ The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. |
[- {
- "contact": {
- "contactID": "2688",
- "contactTypeID": "3",
- "vendorTypeID": "402",
- "code": "C-6af8ddda885b4",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "ME",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "164",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera, Jordan",
- "invoiceAutofillTemplateID": "148",
- "dateTimeCreated": "2026-11-14 22:16:58",
- "dateTimeModified": "2026-11-14 22:16:58",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}, - "token": "1794694618"
}
]Creates a 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.
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.3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request
with either and without them is refused with 400.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.contact.email,
contact.phone and the contact's address fields.contact.hasTaxIdentifier says one is stored.attachments to the new vendor.GET /vendors/{contactID} - get the vendorPOST /vendors/{contactID} - update the vendorGET /vendors/search - search vendors| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| name required | string [ 1 .. 100 ] characters The vendor's name. |
| vendorTypeID | string or integer or null^-?[0-9]+$ The vendor's type; values from |
| 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 |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ The account the vendor's bills are charged to by default; values from |
| 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 |
| 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 |
| discountPercent | string or number or null <decimal> An early-payment discount, as a percentage from 0.1 to 99; |
| discountAmount | string or number or null <decimal> >= 0 An early-payment discount, as an amount. A vendor can't have both |
| discountAmountMin | string or number or null <decimal> >= 0 The smallest discount amount; |
| discountAmountMax | string or number or null <decimal> >= 0 The largest discount amount; |
| discountGraceDays | string or integer or null^[0-9]+$ How many days after the bill the discount still applies; a whole number, |
| 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. |
| ownerPortalNameOverride | string or null <= 100 characters The name owners see for the vendor in the owner portal; empty is stored as |
| isBillingSalesTaxEnabled | string or integer Default: 0 Enum: "0" "1" 0 1 Whether sales tax is billed on the vendor's invoices. |
| isQuickbooksExportEnabled | string or integer Default: 0 Enum: "0" "1" 0 1 Whether the vendor is exported to QuickBooks; needs |
| quickbooksCustomerName | string or null <= 100 characters The vendor's name in QuickBooks; required when |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ The template the vendor's invoices are filled from; values from |
| payeeName | string or null <= 100 characters The name payments are made out to, when it isn't |
| 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
|
(other_payout_types_request (string or integer)) or null How the vendor is paid when | |
(bank_account_types_request (string or integer)) or null The kind of bank account payments go to; required with a payout type of | |
| 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. |
| holdPayments | string or integer Default: 0 Enum: "0" "1" 0 1 Taken only on a create. Whether payments to the vendor are held. |
| 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. |
| 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. |
| 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 |
| 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).
|
| 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 |
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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Rivera Plumbing LLC",
- "code": "VEN-1001",
- "vendorTypeID": "436",
- "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": [
- "115"
], - "emails": [
- {
- "email": "office@example.com"
}
], - "phones": [
- {
- "phone": "+19195550100",
- "phoneTypeID": 3,
- "description": "Office"
}
], - "addresses": [
- {
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601"
}
]
}{- "contact": {
- "contactID": "2853",
- "contactTypeID": "3",
- "vendorTypeID": "436",
- "code": "VEN-1001",
- "name": "Rivera Plumbing LLC",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "office@example.com",
- "phone": "+19195550100",
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601",
- "birthDate": null,
- "defaultBillChargeAccountID": "1",
- "payeeName": "Rivera Plumbing LLC",
- "taxPayerName": "Rivera Plumbing LLC",
- "taxFormTypeID": "1",
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "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": null,
- "discountAmountMax": null,
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": "1",
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Plumbing",
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera Plumbing",
- "invoiceAutofillTemplateID": "325",
- "dateTimeCreated": "2026-11-16 22:45:39",
- "dateTimeModified": "2026-11-16 22:45:39",
- "dateTimeDeactivated": null,
- "contactType": "Vendor",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "3",
- "taxIdentifierCountryID": "US"
}
}Returns a page of vendors with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.
code: read it from GET /vendors/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive filters only when sent: without it the search returns active and inactive vendors.search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.pageSize of 0 or less is served at 15.orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.includeManager=1 adds manager contacts and includeMaintenanceTechnician=1 adds maintenance technicians. Only 1, true or yes turns them on.isLiabilityInsuranceExpired, isWorkersCompInsuranceExpired and isInsuranceExpired take only a yes value; 0, false and no aren't supported.GET /vendors - the plain list, with the full contact rowGET /vendors/{contactID} - one vendor, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| includeManager | string Also return manager contacts. |
| includeMaintenanceTechnician | string Also return maintenance technicians. |
| vendorTypeIDs[] | Array of integers Only contacts of these vendor types, from |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| vendorTradeIDs[] | Array of integers Only contacts assigned to at least one of these trades, from |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| isLiabilityInsuranceExpired | string
|
| daysUntilLiabilityInsuranceExpiresMin | integer Only contacts whose liability insurance expires at least this many days from today. |
| daysUntilLiabilityInsuranceExpiresMax | integer Only contacts whose liability insurance expires at most this many days from today (negative for already expired). |
| isWorkersCompInsuranceExpired | string
|
| daysUntilWorkersCompInsuranceExpiresMin | integer Only contacts whose workers' comp insurance expires at least this many days from today. |
| daysUntilWorkersCompInsuranceExpiresMax | integer Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). |
| isInsuranceExpired | string
|
| daysUntilInsuranceExpiresMin | integer Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. |
| daysUntilInsuranceExpiresMax | integer Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). |
| tagIDs[] | Array of integers Only contacts with at least one of these tags, from |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "contact": {
- "contactID": "2766",
- "contactTypeID": "3",
- "vendorTypeID": "410",
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "OK",
- "postalCode": "12345",
- "countryID": "US",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "payoutTypeID": "1",
- "achDetailsCiphertextID": "169",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "isBillingSalesTaxEnabled": "1",
- "daysUntilLiabilityInsuranceExpires": "1324",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "daysUntilWorkersCompInsuranceExpires": "1355",
- "insuranceExpiresDate": "2030-06-30",
- "daysUntilInsuranceExpires": "1324",
- "discountPercent": "2.5000",
- "discountGraceDays": "10",
- "isActive": "1",
- "invoiceAutofillTemplateID": "153",
- "dateTimeCreated": "2026-11-14 22:17:13",
- "dateTimeModified": "2026-11-14 22:17:13",
- "dateTimeDeactivated": null,
- "isInsuranceRequiredForPayment": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "identificationCountryID": "US",
- "hasTaxIdentifier": "1",
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null,
- "hasDuplicateTaxIdentifier": "0",
- "propertyCount": "0"
}, - "search": {
- "rank": "10"
}
}
]Returns one vendor: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.
{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact.hasTaxIdentifier says whether one is stored.includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportalAccounts - the vendor portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the vendor portal, newest firstvendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTradetaxAdjustments - the contact's 1099 tax adjustmentscontactPersons - the people on file at the contactreviewStats - one row counting the contact's completed maintenance reviews by ratinginvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /vendors - list vendorsGET /vendors/search - search vendorsPOST /vendors/{contactID} - update the vendor| contactID required | integer Example: 1042 The vendor's contact ID. A well-formed ID that isn't a vendor answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2961",
- "contactTypeID": "3",
- "vendorTypeID": "447",
- "code": "C-6af8ddfdd5c93",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "SC",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "174",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera, Jordan",
- "invoiceAutofillTemplateID": "158",
- "dateTimeCreated": "2026-11-14 22:17:33",
- "dateTimeModified": "2026-11-14 22:17:33",
- "dateTimeDeactivated": null,
- "contactType": "Vendor",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null
}, - "emails": [
- {
- "email": {
- "contactEmailID": "107",
- "contactID": "2961",
- "isPrimary": "1",
- "email": "jane.doe@example.com",
- "sendEmailNotifications": "1",
- "sendPaymentNotifications": "1",
- "sendWorkOrderNotifications": "1"
}
}
], - "phones": [
- {
- "phone": {
- "contactPhoneID": "107",
- "contactID": "2961",
- "isPrimary": "1",
- "phone": "555-0100",
- "phoneTypeID": "1",
- "description": "Office",
- "isActive": "1"
}
}
], - "addresses": [
- {
- "address": {
- "contactAddressID": "107",
- "contactID": "2961",
- "isPrimary": "1",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345"
}
}
], - "portalAccounts": [
- {
- "userPortalAccountID": "108",
- "userID": "1927",
- "accountID": "1",
- "portalTypeID": "4",
- "portalID": "2961",
- "email": "jane.doe@example.com",
- "isActive": "1",
- "firstName": "Jane",
- "lastName": "Doe",
- "phone": "555-0100",
- "timeZone": "UTC"
}
], - "portalInvitations": [
- {
- "userPortalInvitationID": "106",
- "accountID": "1",
- "portalInvitationStatusID": "1",
- "portalTypeID": "4",
- "portalID": "2961",
- "email": "jane.doe@example.com",
- "roleID": "1",
- "portfolioGroupIDs": "[1, 2]",
- "dateTimeCreated": "2026-11-14 22:17:33",
- "dateTimeExpires": "2026-12-14 22:17:33",
- "nextReminderDateTime": "2026-11-16 22:17:33"
}
], - "vendorTrades": [
- {
- "contactVendorTrade": {
- "contactVendorTradeID": "146",
- "vendorTradeID": "178",
- "contactID": "2961"
}, - "vendorTrade": {
- "vendorTradeID": "178",
- "name": "provident deleniti dolorum",
- "isVisibleTenantPortal": "1"
}
}
], - "taxAdjustments": [
- {
- "taxAdjustmentID": "106",
- "contactID": "2961",
- "amount": "125.50",
- "description": "Prior-year adjustment",
- "datePosted": "2025-12-31"
}
], - "contactPersons": [
- {
- "contactPersonID": "98",
- "contactID": "2961",
- "name": "Jane Doe",
- "title": "Office Manager",
- "email": "jane.doe@example.com",
- "phone": "555-0100"
}
], - "reviewStats": [
- {
- "totalRatingCount": "0",
- "averageRating": "0.0000",
- "oneStarRatingCount": "0",
- "oneStarRatingPercent": "0.0000",
- "twoStarRatingCount": "0",
- "twoStarRatingPercent": "0.0000",
- "threeStarRatingCount": "0",
- "threeStarRatingPercent": "0.0000",
- "fourStarRatingCount": "0",
- "fourStarRatingPercent": "0.0000",
- "fiveStarRatingCount": "0",
- "fiveStarRatingPercent": "0.0000"
}
], - "invoiceAutofillTemplate": {
- "invoiceAutofillTemplateID": "158",
- "name": "Contract Template 6af8ddfdd490c",
- "isDefault": "1",
- "billDescription": "Repairs",
- "paymentMemo": "Invoice payment",
- "chargeDescription": "Repair charge"
}
}Updates 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.
Contacts › UpdateVendor).{} 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.dateTimeModified changes.{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.GET /vendors/{contactID} - get the vendorPOST /vendors - create a vendorPOST /vendors/{contactID}/deactivate - deactivate the vendorPOST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have
the same phones and addresses routesPOST /vendors/{contactID}/tax-details (undocumented) - change the tax detailsPOST /vendors/{contactID}/ach-details (undocumented) - change the payout settings| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| vendorTypeID | string or integer or null^-?[0-9]+$ The vendor's type; values from |
| 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 |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ The account the vendor's bills are charged to by default; values from |
| 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 |
| 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 |
| discountPercent | string or number or null <decimal> An early-payment discount, as a percentage from 0.1 to 99; |
| discountAmount | string or number or null <decimal> >= 0 An early-payment discount, as an amount. A vendor can't have both |
| discountAmountMin | string or number or null <decimal> >= 0 The smallest discount amount; |
| discountAmountMax | string or number or null <decimal> >= 0 The largest discount amount; |
| discountGraceDays | string or integer or null^[0-9]+$ How many days after the bill the discount still applies; a whole number, |
| 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. |
| ownerPortalNameOverride | string or null <= 100 characters The name owners see for the vendor in the owner portal; empty is stored as |
| isBillingSalesTaxEnabled | string or integer Enum: "0" "1" 0 1 Whether sales tax is billed on the vendor's invoices. |
| isQuickbooksExportEnabled | string or integer Enum: "0" "1" 0 1 Whether the vendor is exported to QuickBooks; needs |
| quickbooksCustomerName | string or null <= 100 characters The vendor's name in QuickBooks; required when |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ The template the vendor's invoices are filled from; values from |
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Rivera Plumbing & Heating LLC",
- "code": "VEN-2002",
- "liabilityInsurancePolicyNumber": "L-3003",
- "liabilityInsuranceExpiresDate": "2031-06-30",
- "discountPercent": "3.00",
- "isBillApprovalExempt": 1
}{- "contact": {
- "contactID": "2863",
- "contactTypeID": "3",
- "vendorTypeID": "437",
- "code": "VEN-2002",
- "name": "Rivera Plumbing & Heating LLC",
- "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": "335",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-3003",
- "liabilityInsuranceExpiresDate": "2031-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "3.0000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera, Jordan",
- "invoiceAutofillTemplateID": "326",
- "dateTimeCreated": "2026-11-16 22:45:44",
- "dateTimeModified": "2026-11-16 22:45:44",
- "dateTimeDeactivated": null,
- "contactType": "Vendor",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateVendor).{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact, with no tax-identifier
keys.isActive 0), so text threads stay linked.GET /files/{fileID} too; a file still attached elsewhere is kept.POST /vendors/{contactID}/deactivate - deactivate the vendor insteadGET /vendors/{contactID} - get the vendor| contactID required | integer Example: 1042 The vendor's contact ID. A well-formed ID that isn't a vendor answers 400; one that isn't a whole number of digits, 404. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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: |
| vendorTypeID required | string or null^-?[0-9]+$ Vendor type, from |
| 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 |
| middleName required | string or null <= 100 characters Middle name, parsed from |
| lastName required | string or null <= 100 characters Last name, parsed from |
| suffix required | string or null <= 15 characters Name suffix, parsed from |
| 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 |
required | other_payout_types (string) or null How the contact is paid outside Rentvine when |
| 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"
|
| holdPayments required | string Enum: "0" "1"
|
| 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), |
| 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 |
| 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"
|
| isInsuranceRequiredForPayment required | string or null Enum: "0" "1" null
|
| maxLineItemsOnPayment required | string or null^-?[0-9]+$ Maximum number of bill line items allowed per payment, or null. |
| preventConsolidatedPayments required | string Enum: "0" "1"
|
| isFromImport required | string Enum: "0" "1"
|
| 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 |
| isBillApprovalExempt required | string Enum: "0" "1"
|
| isBillingSalesTaxEnabled required | string Enum: "0" "1"
|
| isQuickbooksExportEnabled required | string Enum: "0" "1"
|
| 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 |
| dateTimeModified required | string Date and time in UTC, formatted |
| dateTimeDeactivated required | string or null Date and time in UTC, formatted |
| contactType required | string Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead" The contact type's label, computed in PHP: |
{- "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,
- "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"
}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.
Contacts › UpdateVendor).dateTimeModified changes.{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /vendors/{contactID}/deactivate - deactivate the vendorGET /vendors/{contactID} - get the vendor| contactID required | integer Example: 1042 The vendor's contact ID. A well-formed ID that isn't a vendor answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2877",
- "contactTypeID": "3",
- "vendorTypeID": "444",
- "code": "C-6afb879f01ee4",
- "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": "342",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera, Jordan",
- "invoiceAutofillTemplateID": "333",
- "dateTimeCreated": "2026-11-16 22:45:51",
- "dateTimeModified": "2026-11-16 22:45:51",
- "dateTimeDeactivated": null,
- "contactType": "Vendor",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateVendor).dateTimeDeactivated keeps its value
and only dateTimeModified changes.{"error": "Vendor {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /vendors/{contactID}/activate - activate the vendor againDELETE /vendors/{contactID} - delete the vendor insteadGET /vendors/{contactID} - get the vendor| contactID required | integer Example: 1042 The vendor's contact ID. A well-formed ID that isn't a vendor answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The vendor portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the vendor portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2881",
- "contactTypeID": "3",
- "vendorTypeID": "446",
- "code": "C-6afb87a0d6de0",
- "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": "344",
- "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": "0",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Rivera, Jordan",
- "invoiceAutofillTemplateID": "335",
- "dateTimeCreated": "2026-11-16 22:45:52",
- "dateTimeModified": "2026-11-16 22:45:53",
- "dateTimeDeactivated": "2026-11-16 22:45:53",
- "contactType": "Vendor",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}Associations are the homeowners' and condominium associations your properties belong to. List, search, create, read, update, activate, deactivate and delete 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.
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.name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /associations/search, which breaks ties on contactID.includeManager adds manager contacts to the list.associationContactIDs[] limits the list to those contacts (associations, or managers with includeManager); the other filters, the isActive default included, still apply.GET /associations/search - filtered search with computed insurance and tax columnsGET /associations/{contactID} - one association, with includesPOST /associations - create an association| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| associationContactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[0-9]+$ The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. |
[- {
- "contact": {
- "contactID": "2689",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "C-6af8dddb1def7",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "MA",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "165",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "149",
- "dateTimeCreated": "2026-11-14 22:16:59",
- "dateTimeModified": "2026-11-14 22:16:59",
- "dateTimeDeactivated": null,
- "contactType": "Association"
}, - "token": "1794694619"
}
]Creates 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.
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.3 (eCheck) or 4 (NACHA) needs bank details this reference doesn't describe; a request
with either and without them is refused with 400.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.contact.email,
contact.phone and the contact's address fields.contact.hasTaxIdentifier says one is stored.attachments to the new association.GET /associations/{contactID} - get the associationPOST /associations/{contactID} - update the associationGET /associations/search - search associations| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| 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 |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ The account the association's bills are charged to by default; values from |
| 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 |
| 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 |
| discountPercent | string or number or null <decimal> An early-payment discount, as a percentage from 0.1 to 99; |
| discountGraceDays | string or integer or null^[0-9]+$ How many days after the bill the discount still applies; a whole number, |
| ownerPortalNameOverride | string or null <= 100 characters The name owners see for the association in the owner portal; empty is stored as |
| isBillingSalesTaxEnabled | string or integer Default: 0 Enum: "0" "1" 0 1 Whether sales tax is billed on the association's invoices. |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ The template the association's invoices are filled from; values from |
| payeeName | string or null <= 100 characters The name payments are made out to, when it isn't |
| 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
|
(other_payout_types_request (string or integer)) or null How the association is paid when | |
(bank_account_types_request (string or integer)) or null The kind of bank account payments go to; required with a payout type of | |
| 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. |
| holdPayments | string or integer Default: 0 Enum: "0" "1" 0 1 Taken only on a create. Whether payments to the association are held. |
| 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. |
| 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. |
| 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 |
| 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).
|
| 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 |
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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Oak Ridge HOA",
- "code": "HOA-1001",
- "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": [
- "116"
], - "emails": [
- {
- "email": "board@example.com"
}
], - "phones": [
- {
- "phone": "+19195550100",
- "phoneTypeID": 3,
- "description": "Office"
}
], - "addresses": [
- {
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601"
}
]
}{- "contact": {
- "contactID": "2927",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "HOA-1001",
- "name": "Oak Ridge HOA",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "board@example.com",
- "phone": "+19195550100",
- "countryID": "US",
- "address": "100 Main St",
- "address2": "Suite 200",
- "city": "Raleigh",
- "stateID": "NC",
- "postalCode": "27601",
- "birthDate": null,
- "defaultBillChargeAccountID": "1",
- "payeeName": "Oak Ridge Homeowners Association",
- "taxPayerName": "Oak Ridge Homeowners Association",
- "taxFormTypeID": "1",
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Oak Ridge",
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "345",
- "dateTimeCreated": "2026-11-16 22:46:13",
- "dateTimeModified": "2026-11-16 22:46:13",
- "dateTimeDeactivated": null,
- "contactType": "Association",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "3",
- "taxIdentifierCountryID": "US"
}
}Returns a page of associations with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.
code: read it from GET /associations/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive filters only when sent: without it the search returns active and inactive associations.search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.pageSize of 0 or less is served at 15.orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.GET /associations - the plain list, with the full contact rowGET /associations/{contactID} - one association, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "contact": {
- "contactID": "2767",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "CA",
- "postalCode": "12345",
- "countryID": "US",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "payoutTypeID": "1",
- "achDetailsCiphertextID": "170",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "isBillingSalesTaxEnabled": "1",
- "daysUntilLiabilityInsuranceExpires": "1324",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "daysUntilWorkersCompInsuranceExpires": "1355",
- "insuranceExpiresDate": "2030-06-30",
- "daysUntilInsuranceExpires": "1324",
- "discountPercent": "2.5000",
- "discountGraceDays": "10",
- "isActive": "1",
- "invoiceAutofillTemplateID": "154",
- "dateTimeCreated": "2026-11-14 22:17:14",
- "dateTimeModified": "2026-11-14 22:17:14",
- "dateTimeDeactivated": null,
- "isInsuranceRequiredForPayment": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "identificationCountryID": "US",
- "hasTaxIdentifier": "1",
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null,
- "hasDuplicateTaxIdentifier": "0",
- "propertyCount": "1"
}, - "search": {
- "rank": "10"
}
}
]Returns one association: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.
{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact.hasTaxIdentifier says whether one is stored.includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressproperties - the properties linked to the association, each as propertyAssociation and property. A user restricted to portfolio groups gets only the properties in those groups' portfolioscontactPersons - the people on file at the contactinvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /associations - list associationsGET /associations/search - search associationsPOST /associations/{contactID} - update the association| contactID required | integer Example: 1042 The association's contact ID. A well-formed ID that isn't an association answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2962",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "C-6af8ddfe73400",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "SC",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "175",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "159",
- "dateTimeCreated": "2026-11-14 22:17:34",
- "dateTimeModified": "2026-11-14 22:17:34",
- "dateTimeDeactivated": null,
- "contactType": "Association",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null
}, - "emails": [
- {
- "email": {
- "contactEmailID": "108",
- "contactID": "2962",
- "isPrimary": "1",
- "email": "jane.doe@example.com",
- "sendEmailNotifications": "1",
- "sendPaymentNotifications": "1",
- "sendWorkOrderNotifications": "1"
}
}
], - "phones": [
- {
- "phone": {
- "contactPhoneID": "108",
- "contactID": "2962",
- "isPrimary": "1",
- "phone": "555-0100",
- "phoneTypeID": "1",
- "description": "Office",
- "isActive": "1"
}
}
], - "addresses": [
- {
- "address": {
- "contactAddressID": "108",
- "contactID": "2962",
- "isPrimary": "1",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345"
}
}
], - "properties": [
- {
- "propertyAssociation": {
- "propertyAssociationID": "65",
- "propertyID": "591",
- "associationContactID": "2962"
}, - "property": {
- "propertyID": "591",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "734",
- "managementFeeSettingID": "593",
- "name": "224 Shanahan Tunnel",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": null,
- "stateID": "MN",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": null,
- "legalDescription": null,
- "maintenanceLimitAmount": null,
- "yearBuilt": null,
- "dateInsuranceExpires": null,
- "dateWarrantyExpires": null,
- "maintenanceNotes": null,
- "applicationTemplateID": null,
- "reserveAmount": "0.00",
- "markupPercent": null,
- "markupAmount": null,
- "markupAmountMin": null,
- "markupAmountMax": null,
- "dateContractBegins": null,
- "dateContractEnds": null,
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": null,
- "insuranceAgent": null,
- "insurancePolicyNumber": null,
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": null,
- "leaseReturnChargeAmount": null,
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-14 22:17:34",
- "dateTimeModified": "2026-11-14 22:17:34",
- "dateTimeDeactivated": null,
- "deactivationReasonID": "99",
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}
}
], - "contactPersons": [
- {
- "contactPersonID": "99",
- "contactID": "2962",
- "name": "Jane Doe",
- "title": "Office Manager",
- "email": "jane.doe@example.com",
- "phone": "555-0100"
}
], - "invoiceAutofillTemplate": {
- "invoiceAutofillTemplateID": "159",
- "name": "Contract Template 6af8ddfe71bb8",
- "isDefault": "1",
- "billDescription": "Repairs",
- "paymentMemo": "Invoice payment",
- "chargeDescription": "Repair charge"
}
}Updates 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.
Contacts › UpdateAssociation).{} 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.dateTimeModified changes.{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.GET /associations/{contactID} - get the associationPOST /associations - create an associationPOST /associations/{contactID}/deactivate - deactivate the associationPOST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have
the same phones and addresses routesPOST /associations/{contactID}/tax-details (undocumented) - change the tax detailsPOST /associations/{contactID}/ach-details (undocumented) - change the payout settings| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| 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 |
| defaultBillChargeAccountID | string or integer or null^-?[0-9]+$ The account the association's bills are charged to by default; values from |
| 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 |
| 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 |
| discountPercent | string or number or null <decimal> An early-payment discount, as a percentage from 0.1 to 99; |
| discountGraceDays | string or integer or null^[0-9]+$ How many days after the bill the discount still applies; a whole number, |
| ownerPortalNameOverride | string or null <= 100 characters The name owners see for the association in the owner portal; empty is stored as |
| isBillingSalesTaxEnabled | string or integer Enum: "0" "1" 0 1 Whether sales tax is billed on the association's invoices. |
| invoiceAutofillTemplateID | string or integer or null^-?[0-9]+$ The template the association's invoices are filled from; values from |
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Oak Ridge Homeowners Association",
- "code": "HOA-2002",
- "liabilityInsurancePolicyNumber": "L-3003",
- "liabilityInsuranceExpiresDate": "2031-06-30",
- "discountPercent": "3.00",
- "isBillApprovalExempt": 1
}{- "contact": {
- "contactID": "2933",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "HOA-2002",
- "name": "Oak Ridge Homeowners Association",
- "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": "354",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-3003",
- "liabilityInsuranceExpiresDate": "2031-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "3.0000",
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "1",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "346",
- "dateTimeCreated": "2026-11-16 22:46:18",
- "dateTimeModified": "2026-11-16 22:46:18",
- "dateTimeDeactivated": null,
- "contactType": "Association",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateAssociation).{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact, with no tax-identifier
keys.isActive 0), so text threads stay linked.GET /files/{fileID} too; a file still attached elsewhere is kept.associations of
GET /properties/{propertyID}).POST /associations/{contactID}/deactivate - deactivate the association insteadGET /associations/{contactID} - get the association| contactID required | integer Example: 1042 The association's contact ID. A well-formed ID that isn't an association answers 400; one that isn't a whole number of digits, 404. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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: |
| vendorTypeID required | string or null^-?[0-9]+$ Vendor type, from |
| 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 |
| middleName required | string or null <= 100 characters Middle name, parsed from |
| lastName required | string or null <= 100 characters Last name, parsed from |
| suffix required | string or null <= 15 characters Name suffix, parsed from |
| 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 |
required | other_payout_types (string) or null How the contact is paid outside Rentvine when |
| 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"
|
| holdPayments required | string Enum: "0" "1"
|
| 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), |
| 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 |
| 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"
|
| isInsuranceRequiredForPayment required | string or null Enum: "0" "1" null
|
| maxLineItemsOnPayment required | string or null^-?[0-9]+$ Maximum number of bill line items allowed per payment, or null. |
| preventConsolidatedPayments required | string Enum: "0" "1"
|
| isFromImport required | string Enum: "0" "1"
|
| 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 |
| isBillApprovalExempt required | string Enum: "0" "1"
|
| isBillingSalesTaxEnabled required | string Enum: "0" "1"
|
| isQuickbooksExportEnabled required | string Enum: "0" "1"
|
| 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 |
| dateTimeModified required | string Date and time in UTC, formatted |
| dateTimeDeactivated required | string or null Date and time in UTC, formatted |
| contactType required | string Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead" The contact type's label, computed in PHP: |
{- "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,
- "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"
}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.
Contacts › UpdateAssociation).dateTimeModified changes.{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /associations/{contactID}/deactivate - deactivate the associationGET /associations/{contactID} - get the association| contactID required | integer Example: 1042 The association's contact ID. A well-formed ID that isn't an association answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2939",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "C-6afb87bd5c53c",
- "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": "357",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "349",
- "dateTimeCreated": "2026-11-16 22:46:21",
- "dateTimeModified": "2026-11-16 22:46:21",
- "dateTimeDeactivated": null,
- "contactType": "Association",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateAssociation).dateTimeDeactivated keeps its value
and only dateTimeModified changes.{"error": "Association {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /associations/{contactID}/activate - activate the association againDELETE /associations/{contactID} - delete the association insteadGET /associations/{contactID} - get the association| contactID required | integer Example: 1042 The association's contact ID. A well-formed ID that isn't an association answers 400; one that isn't a whole number of digits, 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (association_property_row) The properties linked to the association, each as | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2941",
- "contactTypeID": "5",
- "vendorTypeID": null,
- "code": "C-6afb87be490ba",
- "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": "358",
- "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": "0",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Rivera Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": "350",
- "dateTimeCreated": "2026-11-16 22:46:22",
- "dateTimeModified": "2026-11-16 22:46:22",
- "dateTimeDeactivated": "2026-11-16 22:46:22",
- "contactType": "Association",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Returns a page of maintenance technicians, sorted by name. Each item holds the full contact row under contact, and a token. Use GET /maintenance-technicians/search for more filters and computed columns.
contactIDs[]isActive defaults to 1: only active maintenance technicians. 0 returns only inactive ones; any value other than 1, true, yes, 0, false or no (such as all) returns both.search is a substring match on name and code.name alone, with no tie-break, so contacts that share a name have no fixed order from one page to the next; for a complete sync, page through GET /maintenance-technicians/search, which breaks ties on contactID.includeManager adds manager contacts to the list. includeMaintenanceTechnician changes nothing here: the list already holds maintenance technicians.contactIDs[] (or vendorContactIDs[]) returns those contacts when they are maintenance technicians or managers, whatever the include flags say; other contact types in the list are left out. The other filters still apply.GET /maintenance-technicians/search - filtered search with computed insurance and tax columnsGET /maintenance-technicians/{contactID} - one maintenance technician, with includesPOST /maintenance-technicians - create a maintenance technician| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 250 Example: pageSize=250 Items per page, from 1 (default 250). Values above 5000 are served at 5000. |
| search | string Substring match on |
| isActive | string Default: "1"
|
| includeManager | string Also list manager contacts. |
| includeMaintenanceTechnician | string Changes nothing here: the list already holds maintenance technicians. |
| vendorTypeID | integer Only contacts of this vendor type, from |
| contactIDs[] | Array of integers Only these contacts. Send each ID as a separate |
| vendorContactIDs[] | Array of integers The older name of |
| pagination-page-size | integer Example: "250" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_record) A contact: every column of the row, plus the computed |
| token required | string^-?[0-9]+$ The Unix time the request ran, added by the list query (it selects one column set, so it adds a second column). Carries no meaning for clients. |
[- {
- "contact": {
- "contactID": "2690",
- "contactTypeID": "8",
- "vendorTypeID": "404",
- "code": "C-6af8dddba2c6a",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "IL",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-14 22:16:59",
- "dateTimeModified": "2026-11-14 22:16:59",
- "dateTimeDeactivated": null,
- "contactType": "Internal Technician"
}, - "token": "1794694619"
}
]Creates 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.
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.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.contact.email,
contact.phone and the contact's address fields.contact.hasTaxIdentifier says one is stored.attachments to the new technician.GET /maintenance-technicians/{contactID} - get the technicianPOST /maintenance-technicians/{contactID} - update the technicianGET /maintenance-technicians/search - search technicians| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| 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 |
| 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 |
| 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).
|
| 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 |
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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Jordan Rivera",
- "code": "TECH-1001",
- "birthDate": "1980-04-12",
- "maxLineItemsOnPayment": 12,
- "emails": [
- {
- "email": "jordan.rivera@example.com"
}
], - "phones": [
- {
- "phone": "+19195550100",
- "phoneTypeID": 1,
- "description": "Cell"
}
]
}{- "contact": {
- "contactID": "2854",
- "contactTypeID": "8",
- "vendorTypeID": null,
- "code": "TECH-1001",
- "name": "Jordan Rivera",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jordan.rivera@example.com",
- "phone": "+19195550100",
- "countryID": null,
- "address": null,
- "address2": null,
- "city": null,
- "stateID": null,
- "postalCode": null,
- "birthDate": "1980-04-12",
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "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:39",
- "dateTimeModified": "2026-11-16 22:45:39",
- "dateTimeDeactivated": null,
- "contactType": "Internal Technician",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}Returns a page of maintenance technicians with the search's own column set: the main contact columns plus insurance-expiry and tax-identifier values computed in SQL, under contact. With search, each row also carries search.rank.
code: read it from GET /maintenance-technicians/{contactID})dateTimeModifiedMinhasTaxIdentifier, isTaxIdentifierValid and hasDuplicateTaxIdentifierisActive filters only when sent: without it the search returns active and inactive maintenance technicians.search is a substring match on name, code, email, phone and address; spaces in the text match any run of characters. Each row then carries a search.rank.pageSize of 0 or less is served at 15.orderBy (default contact.name), then by contactID. An orderBy column that isn't sortable is dropped without an error: when no column in it is sortable, the rows come back in contactID order.1, true and yes as yes and 0, false and no as no; any other value is ignored.name[]=.includeManager=1 adds manager contacts. Only 1, true or yes turns it on.isLiabilityInsuranceExpired, isWorkersCompInsuranceExpired and isInsuranceExpired take only a yes value; 0, false and no aren't supported. Maintenance technicians store no insurance dates, so the other insurance filters return none.GET /maintenance-technicians - the plain list, with the full contact rowGET /maintenance-technicians/{contactID} - one maintenance technician, with includes| page | integer Default: 1 Example: page=1 Page number (default 1). A page below 1, or a value that isn't a number, is read as 1. |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). There is no upper limit today. |
| search | string Substring match on |
| includeManager | string Also return manager contacts. |
| includeMaintenanceTechnician | string Changes nothing here: the search already returns maintenance technicians. |
| vendorTypeIDs[] | Array of integers Only contacts of these vendor types, from |
| payoutTypeID | string or integer (payout_types_request) Enum: "1" "2" "3" "4" 1 2 3 4 Only contacts paid this way. A value that isn't a number is ignored. |
| holdPayments | string Only contacts whose payouts are on hold ( |
| isActive | string Only active ( |
| hasTaxIdentifier | string Only contacts with ( |
| isTaxIdentifierValid | string Only contacts whose stored tax identifier passed ( |
| taxIdentifierTypeIDs[] | Array of strings or integers (tax_identifier_types_request) Items Enum: "1" "2" "3" "4" "99" 1 2 3 4 99 Only contacts whose stored tax identifier is of these types. Send each value as a separate |
| hasDuplicateTaxIdentifier | string Only contacts whose tax identifier another contact also stores ( |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2024-01-01T10:00:00Z Only contacts last modified on or after this date and time, in UTC. Send it as |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2024-01-01T10:00:00Z Only contacts last modified on or before this date and time, in UTC. Send it as |
| isInsuranceRequiredForPayment | string Only contacts that must ( |
| vendorTradeIDs[] | Array of integers Only contacts assigned to at least one of these trades, from |
| propertyIDs[] | Array of integers Only contacts linked as the association of at least one of these properties ( |
| isLiabilityInsuranceExpired | string
|
| daysUntilLiabilityInsuranceExpiresMin | integer Only contacts whose liability insurance expires at least this many days from today. |
| daysUntilLiabilityInsuranceExpiresMax | integer Only contacts whose liability insurance expires at most this many days from today (negative for already expired). |
| isWorkersCompInsuranceExpired | string
|
| daysUntilWorkersCompInsuranceExpiresMin | integer Only contacts whose workers' comp insurance expires at least this many days from today. |
| daysUntilWorkersCompInsuranceExpiresMax | integer Only contacts whose workers' comp insurance expires at most this many days from today (negative for already expired). |
| isInsuranceExpired | string
|
| daysUntilInsuranceExpiresMin | integer Only contacts whose insurance (the earlier of the two dates) expires at least this many days from today. |
| daysUntilInsuranceExpiresMax | integer Only contacts whose insurance (the earlier of the two dates) expires at most this many days from today (negative for already expired). |
| tagIDs[] | Array of integers Only contacts with at least one of these tags, from |
| orderBy | string Default: "contact.name" Example: orderBy=contact.name|desc Sort columns, comma-separated, each optionally followed by |
| pagination-page-size | integer Example: "1" Page size used: the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number (a |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The contact columns the search selects, plus values computed in SQL. |
object Sent only when |
[- {
- "contact": {
- "contactID": "2768",
- "contactTypeID": "8",
- "vendorTypeID": "412",
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "OR",
- "postalCode": "12345",
- "countryID": "US",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "payoutTypeID": "1",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "isBillingSalesTaxEnabled": "0",
- "daysUntilLiabilityInsuranceExpires": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "daysUntilWorkersCompInsuranceExpires": null,
- "insuranceExpiresDate": null,
- "daysUntilInsuranceExpires": null,
- "discountPercent": null,
- "discountGraceDays": null,
- "isActive": "1",
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-14 22:17:14",
- "dateTimeModified": "2026-11-14 22:17:14",
- "dateTimeDeactivated": null,
- "isInsuranceRequiredForPayment": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "identificationCountryID": "US",
- "hasTaxIdentifier": "1",
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null,
- "hasDuplicateTaxIdentifier": "0",
- "propertyCount": "0"
}, - "search": {
- "rank": "10"
}
}
]Returns one maintenance technician: the full contact row under contact, with the tax-identifier flags, and the related records the includes parameter names, each under its own key.
{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact.hasTaxIdentifier says whether one is stored.includes names are comma-separated with no spaces: a name with a space before or after it isn't recognised. An unknown name is ignored.emails - the contact's email addresses, each under emailphones - the contact's phone numbers, each under phoneaddresses - the contact's addresses, each under addressportalAccounts - the maintenance portal accounts linked to the contactportalInvitations - the pending, unexpired invitations to the maintenance portal, newest firstvendorTrades - the trades assigned to the contact, each as contactVendorTrade and vendorTradetaxAdjustments - the contact's 1099 tax adjustmentscontactPersons - the people on file at the contactreviewStats - one row counting the contact's completed maintenance reviews by ratinginvoiceAutofillTemplate - the invoice autofill template the contact uses, or null when it has noneGET /maintenance-technicians - list maintenance techniciansGET /maintenance-technicians/search - search maintenance techniciansPOST /maintenance-technicians/{contactID} - update the maintenance technician| contactID required | integer Example: 1042 The maintenance technician's contact ID. A well-formed ID that isn't a maintenance technician answers 400; one that isn't a whole number of digits (a letter, a minus sign), 404. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2963",
- "contactTypeID": "8",
- "vendorTypeID": "449",
- "code": "C-6af8ddff177f4",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-14 22:17:35",
- "dateTimeModified": "2026-11-14 22:17:35",
- "dateTimeDeactivated": null,
- "contactType": "Internal Technician",
- "hasTaxIdentifier": 1,
- "isTaxIdentifierValid": "1",
- "taxIdentifierTypeID": "99",
- "taxIdentifierCountryID": null
}, - "emails": [
- {
- "email": {
- "contactEmailID": "109",
- "contactID": "2963",
- "isPrimary": "1",
- "email": "jane.doe@example.com",
- "sendEmailNotifications": "1",
- "sendPaymentNotifications": "1",
- "sendWorkOrderNotifications": "1"
}
}
], - "phones": [
- {
- "phone": {
- "contactPhoneID": "109",
- "contactID": "2963",
- "isPrimary": "1",
- "phone": "555-0100",
- "phoneTypeID": "1",
- "description": "Office",
- "isActive": "1"
}
}
], - "addresses": [
- {
- "address": {
- "contactAddressID": "109",
- "contactID": "2963",
- "isPrimary": "1",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345"
}
}
], - "portalAccounts": [
- {
- "userPortalAccountID": "110",
- "userID": "1931",
- "accountID": "1",
- "portalTypeID": "9",
- "portalID": "2963",
- "email": "jane.doe@example.com",
- "isActive": "1",
- "firstName": "Jane",
- "lastName": "Doe",
- "phone": "555-0100",
- "timeZone": "UTC"
}
], - "portalInvitations": [
- {
- "userPortalInvitationID": "108",
- "accountID": "1",
- "portalInvitationStatusID": "1",
- "portalTypeID": "9",
- "portalID": "2963",
- "email": "jane.doe@example.com",
- "roleID": "1",
- "portfolioGroupIDs": "[1, 2]",
- "dateTimeCreated": "2026-11-14 22:17:35",
- "dateTimeExpires": "2026-12-14 22:17:35",
- "nextReminderDateTime": "2026-11-16 22:17:35"
}
], - "vendorTrades": [
- {
- "contactVendorTrade": {
- "contactVendorTradeID": "148",
- "vendorTradeID": "180",
- "contactID": "2963"
}, - "vendorTrade": {
- "vendorTradeID": "180",
- "name": "maxime dolorum ea",
- "isVisibleTenantPortal": "1"
}
}
], - "taxAdjustments": [
- {
- "taxAdjustmentID": "108",
- "contactID": "2963",
- "amount": "125.50",
- "description": "Prior-year adjustment",
- "datePosted": "2025-12-31"
}
], - "contactPersons": [
- {
- "contactPersonID": "100",
- "contactID": "2963",
- "name": "Jane Doe",
- "title": "Office Manager",
- "email": "jane.doe@example.com",
- "phone": "555-0100"
}
], - "reviewStats": [
- {
- "totalRatingCount": "0",
- "averageRating": "0.0000",
- "oneStarRatingCount": "0",
- "oneStarRatingPercent": "0.0000",
- "twoStarRatingCount": "0",
- "twoStarRatingPercent": "0.0000",
- "threeStarRatingCount": "0",
- "threeStarRatingPercent": "0.0000",
- "fourStarRatingCount": "0",
- "fourStarRatingPercent": "0.0000",
- "fiveStarRatingCount": "0",
- "fiveStarRatingPercent": "0.0000"
}
], - "invoiceAutofillTemplate": null
}Updates 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.
Contacts › UpdateMaintenanceTechnician).{} counts as empty).
Only name, code and birthDate are read; any other key is ignored.dateTimeModified changes.{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.GET /maintenance-technicians/{contactID} - get the technicianPOST /maintenance-technicians - create a technicianPOST /maintenance-technicians/{contactID}/deactivate - deactivate the technicianPOST /contacts/{contactID}/emails (undocumented) - add an email address; phone numbers and addresses have
the same phones and addresses routes| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| 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 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "name": "Jordan A. Rivera",
- "code": "TECH-2002",
- "birthDate": "1981-05-13"
}{- "contact": {
- "contactID": "2865",
- "contactTypeID": "8",
- "vendorTypeID": "439",
- "code": "TECH-2002",
- "name": "Jordan A. Rivera",
- "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": "1981-05-13",
- "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:45",
- "dateTimeModified": "2026-11-16 22:45:45",
- "dateTimeDeactivated": null,
- "contactType": "Internal Technician",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateMaintenanceTechnician).{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.contact, with no tax-identifier
keys.isActive 0), so text threads stay linked.GET /files/{fileID} too; a file still attached elsewhere is kept.POST /maintenance-technicians/{contactID}/deactivate - deactivate the technician insteadGET /maintenance-technicians/{contactID} - get the technician| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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: |
| vendorTypeID required | string or null^-?[0-9]+$ Vendor type, from |
| 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 |
| middleName required | string or null <= 100 characters Middle name, parsed from |
| lastName required | string or null <= 100 characters Last name, parsed from |
| suffix required | string or null <= 15 characters Name suffix, parsed from |
| 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 |
required | other_payout_types (string) or null How the contact is paid outside Rentvine when |
| 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"
|
| holdPayments required | string Enum: "0" "1"
|
| 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), |
| 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 |
| 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"
|
| isInsuranceRequiredForPayment required | string or null Enum: "0" "1" null
|
| maxLineItemsOnPayment required | string or null^-?[0-9]+$ Maximum number of bill line items allowed per payment, or null. |
| preventConsolidatedPayments required | string Enum: "0" "1"
|
| isFromImport required | string Enum: "0" "1"
|
| 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 |
| isBillApprovalExempt required | string Enum: "0" "1"
|
| isBillingSalesTaxEnabled required | string Enum: "0" "1"
|
| isQuickbooksExportEnabled required | string Enum: "0" "1"
|
| 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 |
| dateTimeModified required | string Date and time in UTC, formatted |
| dateTimeDeactivated required | string or null Date and time in UTC, formatted |
| contactType required | string Enum: "Owner" "Tenant" "Vendor" "Manager" "Association" "Applicant" "Screening Prospect" "Internal Technician" "Owner Lead" The contact type's label, computed in PHP: |
{- "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"
}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.
Contacts › UpdateMaintenanceTechnician).dateTimeModified changes.{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /maintenance-technicians/{contactID}/deactivate - deactivate the technicianGET /maintenance-technicians/{contactID} - get the technician| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2878",
- "contactTypeID": "8",
- "vendorTypeID": "445",
- "code": "C-6afb879f9f9a9",
- "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:51",
- "dateTimeModified": "2026-11-16 22:45:51",
- "dateTimeDeactivated": null,
- "contactType": "Internal Technician",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Contacts › UpdateMaintenanceTechnician).dateTimeDeactivated keeps its value
and only dateTimeModified changes.{"error": "Internal Technician {contactID} not found"}. An ID that isn't a whole number of digits answers the stock 404.POST /maintenance-technicians/{contactID}/activate - activate the technician againDELETE /maintenance-technicians/{contactID} - delete the technician insteadGET /maintenance-technicians/{contactID} - get the technician| 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. |
| includes | string Example: includes=emails,phones,addresses Comma-separated related records to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (contact_detail) The contact: every column of the row plus the computed |
Array of objects (contact_email_row) The contact's email addresses, each under | |
Array of objects (contact_phone_row) The contact's phone numbers, each under | |
Array of objects (contact_address_row) The contact's addresses, each under | |
Array of objects (contact_portal_account) The maintenance portal accounts linked to the contact. Requires the | |
Array of objects (contact_portal_invitation) The pending, unexpired invitations to the maintenance portal, newest first. Requires the | |
Array of objects (vendor_trade_row) The trades assigned to the contact, each as | |
Array of objects (contact_tax_adjustment) The contact's 1099 tax adjustments. Requires the | |
Array of objects (contact_person) The people on file at the contact. Requires the | |
Array of objects (vendor_review_stats) One row counting the contact's completed maintenance reviews by rating. Requires the | |
contact_invoice_autofill_template (object) or null The invoice autofill template the contact uses, or null when it has none. Requires the |
{- "contact": {
- "contactID": "2882",
- "contactTypeID": "8",
- "vendorTypeID": "447",
- "code": "C-6afb87a17aeb5",
- "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": "0",
- "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:53",
- "dateTimeModified": "2026-11-16 22:45:53",
- "dateTimeDeactivated": "2026-11-16 22:45:53",
- "contactType": "Internal Technician",
- "hasTaxIdentifier": 0,
- "isTaxIdentifierValid": 0,
- "taxIdentifierTypeID": null,
- "taxIdentifierCountryID": null
}
}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.
Returns a page of the account's webhooks: each one's event type and the URL Rentvine sends that event to.
webhookID to update or delete a webhook, or to filter the delivery log byeventType that isn't one of the event types matches nothing.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.pagination-total-items is 0.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 webhookGET /events/webhooks/{webhookID} - one webhookGET /events/webhooks/calls - the delivery log| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). Not capped. |
| search | string Example: search=example.com Returns the webhooks whose event type or URL contains this text (case-insensitive). |
| eventType | string Example: eventType=maintenance::workOrder::created Returns only the webhooks for this event type, matched exactly (for example |
| orderBy | string Default: "webhook.dateTimeCreated|desc" Example: orderBy=webhook.url|asc Sort column, optionally followed by Columns: |
| pagination-page-size | integer Example: "2" When some webhooks match, the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "webhook": {
- "webhookID": "11",
- "eventType": "lease::lease::created",
- "dateTimeCreated": "2026-11-16 20:14:38"
}, - "lastCall": {
- "webhookCallID": null,
- "hasError": null,
- "statusCode": null,
- "dateTimeProcessed": null,
- "errorSummary": null
}
}, - {
- "webhook": {
- "webhookID": "12",
- "eventType": "maintenance::workOrder::updated",
- "dateTimeCreated": "2026-11-16 20:14:38"
}, - "lastCall": {
- "webhookCallID": "8419",
- "hasError": "1",
- "statusCode": "404",
- "dateTimeProcessed": "2026-11-16 20:14:40",
- "errorSummary": "Returned HTTP 404"
}
}
]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}).
Administration › ManageWebhooks), checked first.eventType and url are both required. url must be a valid URL starting with https://, in lowercase (HTTPS:// is refused).{} 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.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.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 registeredPOST /events/webhooks/{webhookID} - change a webhook's event or URLDELETE /events/webhooks/{webhookID} - stop sending an event| 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
|
| url required | string non-empty The URL to send the event to. Must be a valid URL starting with |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
{- "eventType": "maintenance::workOrder::created",
}{- "webhook": {
- "webhookID": "42",
- "eventType": "maintenance::workOrder::created",
- "dateTimeCreated": "2026-11-16 20:14:40"
}
}Returns one webhook: its event type and the URL Rentvine sends that event to.
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 webhookPOST /events/webhooks/{webhookID} - change the webhookGET /events/webhooks/calls - its delivery log, with webhookID| webhookID required | integer Example: 42 The webhook's ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
{- "webhook": {
- "webhookID": "1",
- "eventType": "maintenance::workOrder::created",
- "dateTimeCreated": "2026-11-16 20:14:39"
}
}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}).
Administration › ManageWebhooks), checked first: a key without it gets the 403 even for a webhook that doesn't exist.{} 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.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.webhookID that isn't all digits (abc, -1) answers the stock 404.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 nowDELETE /events/webhooks/{webhookID} - stop sending the event instead| webhookID required | integer Example: 42 The webhook's ID, from |
| 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
|
| url | string non-empty The URL to send the event to. Must be a valid URL starting with |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
{
}{- "webhook": {
- "webhookID": "47",
- "eventType": "lease::lease::created",
- "dateTimeCreated": "2026-11-16 20:14:41"
}
}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.
Administration › ManageWebhooks), checked first: a key without it gets the 403 even for a webhook that doesn't exist.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/calls?webhookID=<webhookID> returns nothing afterwards. Other webhooks' rows stay, even those sent to the same URL.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 leftPOST /events/webhooks/{webhookID} - change the URL instead, which keeps the delivery log| webhookID required | integer Example: 42 The webhook's ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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
|
| 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 |
| isActive | string Enum: "0" "1" Whether the webhook is active ( |
| dateTimeActivated | string or null When the webhook was last activated. UTC, |
| dateTimeDisabled | string or null When the webhook was stopped, or |
| disabledByUserID | string or null^-?[0-9]+$ The user who stopped the webhook, or |
| webhookDisableReasonID | string or null Enum: "1" "2" null Why the webhook is stopped - |
| createdByUserID | string or null^-?[0-9]+$ The user who created the webhook, or |
{- "webhookID": "53",
- "eventType": "lease::lease::created",
- "dateTimeCreated": "2026-11-16 20:14:42"
}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.
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).
hasError=1) and see what the receiver answered, then fix the receiverhasError, 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.eventID.url is the webhook's URL when the event was queued; a later change to the webhook doesn't change it.hasError other than 1/0/true/false/yes/no in any letter case, a webhookID that isn't a number, or 0).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.pagination-total-items is 0.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| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). Not capped. |
| webhookID | integer Example: webhookID=42 Returns only one webhook's rows. IDs come from |
| eventType | string Example: eventType=maintenance::workOrder::created Returns only the rows for this event type, matched exactly (for example |
| hasError | string Example: hasError=1
|
| search | string Example: search=example.com Returns the rows whose event type or URL contains this text (case-insensitive). |
| orderBy | string Default: "webhookCall.dateTimeCreated|desc" Example: orderBy=webhookCall.url|asc Sort column, optionally followed by Columns: |
| pagination-page-size | integer Example: "2" When some rows match, the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object One send of one event to one webhook. |
[- {
- "webhookCall": {
- "webhookCallID": "8419",
- "webhookID": "16",
- "eventID": "41735",
- "eventType": "maintenance::workOrder::updated",
- "hasError": "1",
- "statusCode": "404",
- "responseBody": null,
- "errorMessage": "{\"success\":false,\"error\":{\"message\":\"Token \\\"0b6f3c2e-5d41-4a8e-9c7b-2f1e8d6a9b30\\\" not found\",\"id\":\"\"}}",
- "dateTimeCreated": "2026-11-10 18:05:00"
}
}, - {
- "webhookCall": {
- "webhookCallID": "1699",
- "webhookID": "16",
- "eventID": "12277",
- "eventType": "maintenance::workOrder::updated",
- "hasError": "0",
- "statusCode": "200",
- "responseBody": "This URL has no default content configured. <a href=\"https://webhook.site/#!/edit/0b6f3c2e-5d41-4a8e-9c7b-2f1e8d6a9b30\">Change response in Webhook.site</a>.",
- "errorMessage": null,
- "dateTimeCreated": "2025-05-30 21:07:40"
}
}
]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.
Lists the account's attachable files, newest first, one page at a time. Each item wraps the file under file,
beside a token the list adds.
isAttachable 1; to include the others, use GET /files/search.search matches any part of the title, in any case. Without search, the list isn't filtered by title.dateTimeCreated, newest first, with no tie-breaker: files created in the same second can repeat or
be skipped across pages.GET /files/search - search the account's files, with filtersGET /files/{fileID} - one file, with its attachmentsPOST /files - upload a file| search | string Example: search=front door Part of the file's title, matched anywhere in it and in any case. |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 50 Example: pageSize=50 Items per page, from 1 (default 50). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "50" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the file. |
[- {
- "file": {
- "fileID": "39",
- "fileSourceID": "1",
- "isAttachable": "1",
- "title": "Front door photo",
- "fileName": "4765caf4-541f-39a5-a3a8-dccdb4c6bba0.jpg",
- "fileType": "jpg",
- "fileSize": "286",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": "preview-6af7cb0a183c5.jpg",
- "dateTimeCreated": "2026-11-14 02:44:26"
}, - "token": "1794624266"
}
]Uploading a file in Rentvine is generally a 2-step process.
To upload the file and attach it to an object in one step, provide the objectID and objectTypeID as query parameters.
E.g. if you uploaded the file using the path /files?objectTypeID=7&objectID=123, the file would be uploaded and attached to
the Unit (object type id for Unit is 7) with unitID of 123.
| objectID | integer The primary key of the object |
| objectTypeID | integer The id of the Object Type |
| includes | string Value: "attachment"
|
| file | string <binary> |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
object (attachment) Included if |
{- "file": {
- "fileID": "60",
- "fileSourceID": "1",
- "isAttachable": "0",
- "title": "string",
- "fileName": "string",
- "fileType": "string",
- "fileSize": "string",
- "userID": "string",
- "isImage": "0",
- "isPublic": "0",
- "previewFileName": "string",
- "dateTimeCreated": "2026-11-14 02:44:30"
}, - "attachment": {
- "fileAttachmentID": "string",
- "fileID": "string",
- "objectTypeID": "1",
- "objectID": "string",
- "isSharedWithOwner": "0",
- "isSharedWithTenant": "0",
- "isSharedWithVendor": "0",
- "isSharedWithApplicant": "0",
- "pathID": "string",
- "portalTypeID": "1",
- "contactID": "string",
- "subObjectTypeID": "1",
- "relatedObjectTypeID": "1",
- "relatedObjectID": "string"
}
}Searches the account's files, attachable or not, with filters on type, size, source and uploader, one
page at a time, sorted by title. Each item wraps the file under file.
fileSourceIDs[]isAttachable, fileSizeMin or
fileSizeMax value it can't read. A list filter given values that match nothing (fileSourceIDs[]=abc) returns
no files.fileTypes[], fileSourceIDs[], userIDs[]) takes one name[]= per value, and matches any of
them.title, then by fileID.attachedToObjectTypeIDs[], dateTimeCreatedMin and dateTimeCreatedMax fail with 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 firstGET /files/{fileID} - one file, with its attachments| search | string Example: search=front door Part of the file's title, matched anywhere in it and in any case. |
| isAttachable | string Example: isAttachable=true
|
| fileType | string Example: fileType=pdf One extension ( |
| fileTypes[] | Array of strings Example: fileTypes[]=pdf&fileTypes[]=jpg Extensions, any of which matches. Send one |
| fileSizeMin | integer Example: fileSizeMin=1 Smallest size in bytes, inclusive. A value that isn't a number doesn't filter. |
| fileSizeMax | integer Example: fileSizeMax=1000000 Largest size in bytes, inclusive. A value that isn't a number doesn't filter. |
| fileSourceIDs[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 Example: fileSourceIDs[]=1 File sources, any of which matches. Send one
|
| userIDs[] | Array of integers Example: userIDs[]=2 The users who uploaded or created the file (a file's |
| attachedToObjectTypeIDs[] | Array of integers Fails with 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). |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25), with no upper limit. |
| pagination-page-size | integer Example: "1" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
[- {
- "file": {
- "fileID": "50",
- "fileSourceID": "1",
- "isAttachable": "1",
- "title": "Front door photo",
- "fileName": "7457207c-64e9-36ce-9503-7ecd8ad326ff.jpg",
- "fileType": "jpg",
- "fileSize": "286",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": "preview-6af7cb0c11111.jpg",
- "dateTimeCreated": "2026-11-14 02:44:28"
}
}
]Returns one file's record under file, and with the fileAttachments include, every record the file is attached
to.
fileID of a file attached only to records
outside those portfolios.fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.fileAttachments - every attachment of the file, an empty list when it has nonePOST /files/{fileID} - rename the file or change whether it can be attachedDELETE /files/{fileID} - delete the fileGET /files/{fileID}/download (undocumented) - the file itself| fileID required | integer Example: 60 The file, from |
| includes | string Example: includes=fileAttachments Comma-separated includes. One is available, |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
Array of objects (attachment) Every attachment of the file, an empty list when it has none. Requires the |
{- "file": {
- "fileID": "60",
- "fileSourceID": "1",
- "isAttachable": "1",
- "title": "Front door photo",
- "fileName": "ac216f37-534d-37a6-a9cd-62a1c6267bb6.jpg",
- "fileType": "jpg",
- "fileSize": "286",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": "preview-6af7cb0e68a8d.jpg",
- "dateTimeCreated": "2026-11-14 02:44:30"
}, - "fileAttachments": [
- {
- "fileAttachmentID": "17",
- "fileID": "60",
- "objectTypeID": "7",
- "objectID": "17",
- "isSharedWithOwner": "0",
- "isSharedWithTenant": "0",
- "isSharedWithVendor": "0",
- "isSharedWithApplicant": "0",
- "pathID": "1",
- "portalTypeID": "1",
- "contactID": "18",
- "subObjectTypeID": "51",
- "relatedObjectTypeID": "6",
- "relatedObjectID": "19"
}
]
}Renames a file or changes whether it can be attached, and returns it in the GET /files/{fileID} shape (with
fileAttachments when the request's query string asks for it).
GET /files) without deleting itFiles › UpdateFile), checked
before anything else: a key without it gets the 403 whatever the body or ID.fileID of a file attached only to records
outside those portfolios.title and isAttachable are read; any other key in the body is ignored.{}, answers 400 invalid input..fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.title that is empty, only spaces or longer than 200 characters, or an isAttachable that isn't a boolean,
answers 400 with the validation messages, keyed by field.GET /files/{fileID} - the file| fileID required | integer Example: 60 The file, from |
| includes | string Example: includes=fileAttachments
|
| title | string [ 1 .. 200 ] characters The name of the file shown to users; not empty or only spaces. |
| isAttachable | boolean or string or integer Enum: true false "true" "false" "1" "0" "yes" "no" 1 0 Whether the file can be attached to records and is listed by |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
Array of objects (attachment) Every attachment of the file, an empty list when it has none. Requires the |
{- "title": "Front door photo (cropped)",
- "isAttachable": false
}{- "file": {
- "fileID": "66",
- "fileSourceID": "1",
- "isAttachable": "0",
- "title": "Front door photo (cropped)",
- "fileName": "20b7eb60-5585-36ee-96f4-be3106c48c9f.jpg",
- "fileType": "jpg",
- "fileSize": "286",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": "preview-6af7cb0fa8564.jpg",
- "dateTimeCreated": "2026-11-14 02:44:31"
}
}Deletes a file: its record, every attachment of it, and the stored file. Returns the deleted file under file.
Files › UpdateFile), checked
before anything else: a key without it gets the 403 whatever the body or ID.fileID of a file attached only to records
outside those portfolios.fileID with no file answers 400 File {fileID} not found; a fileID that isn't all digits
(abc, -1) answers the stock 404.imageFileID becomes null).GET /files/{fileID} - the file and its attachments, to check before deleting| fileID required | integer Example: 60 The file, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (file) A stored file: a document or image uploaded to the account, or one Rentvine created (a letter, a statement, an
invoice). The file itself is downloaded through |
{- "file": {
- "fileID": "86",
- "fileSourceID": "1",
- "isAttachable": "1",
- "title": "Front door photo",
- "fileName": "235016c0-7dac-39d1-9e1e-1d6f7a38b327.jpg",
- "fileType": "jpg",
- "fileSize": "286",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": "preview-6af7cb277547d.jpg",
- "dateTimeCreated": "2026-11-14 02:44:55"
}
}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.
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.
orderIndex, lowest firstpage and pageSize aren't read1 only on a status of its stage: isPendingMoveInStatus on a Pending status,
isPendingMoveOutStatus on an Active one, isCompletedMoveOutStatus on a Closed onePOST /leases/{leaseID}/status - Change a lease's statusGET /leases/{leaseID} - A lease, with its status through the leaseStatus include| search | string Example: search=Notice Returns only the statuses whose |
| isSystemStatus | string Example: isSystemStatus=0
|
| 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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_status) A lease status: one of the account's named, orderable statuses. |
[- {
- "leaseStatus": {
- "leaseStatusID": "1",
- "primaryLeaseStatusID": "1",
- "isSystemStatus": "1",
- "name": "Pending",
- "isPendingMoveInStatus": "1",
- "isPendingMoveOutStatus": "0",
- "isCompletedMoveOutStatus": "0",
- "orderIndex": "1"
}
}, - {
- "leaseStatus": {
- "leaseStatusID": "2",
- "primaryLeaseStatusID": "2",
- "isSystemStatus": "1",
- "name": "Active",
- "isPendingMoveInStatus": "0",
- "isPendingMoveOutStatus": "0",
- "isCompletedMoveOutStatus": "0",
- "orderIndex": "2"
}
}, - {
- "leaseStatus": {
- "leaseStatusID": "3",
- "primaryLeaseStatusID": "2",
- "isSystemStatus": "0",
- "name": "Active - Notice Given",
- "isPendingMoveInStatus": "0",
- "isPendingMoveOutStatus": "1",
- "isCompletedMoveOutStatus": "0",
- "orderIndex": "3"
}
}
]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.
search with includes=unitpropertyImage 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)unit in includes adds no key (the unit is always sent); send it with searchproperty - the lease's property, under property; the item then has no tokenpropertyImage - the property's main image, under propertyImage (send it with property)GET /leases/{leaseID} - One lease, with its includesGET /properties - The properties, for propertyIDGET /portfolios - The portfolios, for portfolioID| 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 |
| propertyID | integer Example: propertyID=152 Returns only the leases on this property. Non-digit characters are dropped before use ( |
| unitID | integer Example: unitID=152 Returns only the leases on this unit. Non-digit characters are dropped before use ( |
| portfolioID | integer Example: portfolioID=12 Returns only the leases on properties in this portfolio. Non-digit characters are dropped before use ( |
| includes | string Example: includes=property,unit Comma-separated related data to add to each item, with no spaces; |
| pagination-page-size | integer Example: "25" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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). |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
object (property) The lease's property. Sent with the | |
object (property_image) The property's main image, or Rentvine's placeholder ( | |
| token | string^[0-9]+$ The time of the request as a Unix timestamp; carries no data. Sent when the |
[- {
- "lease": {
- "leaseID": "425",
- "propertyID": "426",
- "unitID": "430",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "1",
- "moveOutStatusID": "1",
- "assignedToUserID": null,
- "applicationID": null,
- "leaseDocumentTransactionID": null,
- "code": "L-0412-AVR",
- "tenants": null,
- "moveInDate": "2026-11-29",
- "startDate": "2026-11-29",
- "endDate": "2027-11-29",
- "occupancyStartDate": "2026-11-29",
- "occupancyEndDate": null,
- "isOccupancy": "0",
- "isMonthToMonth": "0",
- "monthToMonthStartDate": null,
- "monthToMonthPremiumSettingID": null,
- "tenantLiabilityInsuranceProviderID": null,
- "tenantLiabilityInsuranceEffectiveDate": null,
- "rentersInsuranceCompany": null,
- "rentersInsurancePolicyNumber": null,
- "rentersInsuranceStartDate": null,
- "rentersInsuranceExpirationDate": null,
- "rentersInsuranceFileID": null,
- "rentersInsurancePolicyLiabilityAmount": null,
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "leaseFeeTransactionID": null,
- "leaseFeeBillID": null,
- "dateTimeCreated": "2026-11-16 19:12:15",
- "dateTimeModified": "2026-11-16 19:12:15",
- "lateFeeSettingID": "425",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "allowedPaymentAmountTypeID": null,
- "isAchDisabled": "0",
- "isCreditCardDisabled": "0",
- "isCashDisabled": "0",
- "closedDate": null,
- "closedDescription": null,
- "noticeDate": "2026-10-01",
- "expectedMoveOutDate": "2026-12-31",
- "moveOutDate": null,
- "depositRefundDueDate": null,
- "leaseReturnChargeAmount": "0.00",
- "moveOutReasonID": null,
- "moveOutUnitAvailabilityDate": null,
- "moveOutTenantRemarks": null,
- "moveOutLeaseTenantID": null,
- "isLeaseAgreementViolated": "0",
- "forwardingName": null,
- "forwardingCountryID": null,
- "forwardingAddress": null,
- "forwardingAddress2": null,
- "forwardingCity": null,
- "forwardingStateID": null,
- "forwardingPostalCode": null,
- "forwardingEmail": null,
- "forwardingPhone": null,
- "moveOutTenantReason": null,
- "tenantRefundPayoutTypeID": "1",
- "statementSettingID": null,
- "sendStatements": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "1",
- "rentvineInsuranceEnrollmentID": null,
- "rentvineInsuranceEnrollmentStatusID": null,
- "rentvineInsurancePackageID": null,
- "rentvineInsuranceRecurringChargeID": null,
- "rentvineInsuranceChargeID": null,
- "rentersInsuranceProviderTypeID": null,
- "leaseActivationOptionID": "1",
- "scheduledActivationFailedDateTime": null,
- "scheduledActivationFailureReasonID": null,
- "increaseEligibilityDate": "2027-11-30",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "1",
- "isMarkedToVacate": "0"
}, - "unit": {
- "unitID": "430",
- "propertyID": "426",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Apt 839",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": null,
- "stateID": "AL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "2493.87",
- "deposit": "2871.22",
- "size": null,
- "beds": "4",
- "fullBaths": "3",
- "halfBaths": "0",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-16 19:12:15",
- "dateTimeModified": "2026-11-16 19:12:15",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": null,
- "entryInstructions": null,
- "vendorEntryInstructions": null,
- "maintenanceNotes": null
}, - "token": "1794856336"
}
]Creates a new lease with all associated entities: tenants, recurring charges, move-in charges, occupants, pets, emergency contacts, and vehicles.
Update Lease permission in RolesunitID must exist and be activetenants array is requiredapplicationID is provided, the application must exist and be in a compatible statechargeLeaseFee is true, both leaseFeeAmount and leaseFeeDatePosted must be providedGET /leases/{leaseID} and returns the full lease detailGET /leases - List leasesGET /leases/{leaseID} - Get lease detail (same shape as the response here)POST /leases/{leaseID} - Update leaserequired | object |
required | Array of objects non-empty Primary tenants on the lease. At least one is required. |
object Optional application status update when converting an application to a lease. | |
| residentPackageID | string or integer or null^-?[0-9]+$ REP package to enroll the lease in ( |
Array of objects À la carte REP service entitlements to add alongside the lease (separate from a package), as
a top-level field. Each is created with its own recurring charge. Each | |
Array of objects Recurring charges (rent, pet fees, parking, etc.) to attach to the lease at creation. | |
Array of objects Additional recurring charges (utility fees, etc.) using a simplified structure without escalations. | |
Array of objects One-time move-in charges (security deposit, admin fee, etc.) posted when the lease is created. | |
Array of objects Co-signer tenants (guarantors) on the lease. | |
Array of objects Applicants from the linked application to convert to tenants. Only processed when | |
Array of objects Co-signer applicants from the linked application. Only processed when | |
Array of objects Non-tenant occupants (minors, roommates, etc.) listed on the lease. | |
| processPetsFromApplication | boolean Default: true When |
Array of objects Pets on the lease. Only used when | |
| processEmergencyContactsFromApplication | boolean Default: true When |
Array of objects Emergency contacts for the tenant. Only used when | |
| processVehiclesFromApplication | boolean Default: true When |
Array of objects Vehicles registered to the lease. Only used when | |
| sendPortalInvitations | boolean Default: false When |
| deactivateListing | boolean Default: false When |
| chargeLeaseFee | boolean Default: false When |
| leaseFeeAmount | string or number <decimal> Lease fee amount. Required when |
| leaseFeeDatePosted | string <date> Date to post the lease fee. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "lease": {
- "unitID": "585",
- "startDate": "04/29/2026",
- "endDate": "2027-04-30",
- "moveInDate": "04/29/2026",
- "lateFeeSettingID": "87",
- "leaseReturnChargeAmount": "15.00",
- "assignedToUserID": "51",
- "rentersInsuranceCompany": null,
- "rentersInsurancePolicyNumber": null,
- "rentersInsuranceExpirationDate": null,
- "tenantLiabilityInsuranceEffectiveDate": "2026-04-29",
- "tenantLiabilityInsuranceProviderID": null,
- "tenantLiabilityInsuranceRentvinePackageID": null,
- "rvInsuranceEnabled": false,
- "leaseActivationOptionID": "1"
}, - "application": {
- "applicationStatusID": "6"
}, - "applicants": [ ],
- "tenants": [
- {
- "contactID": "1352"
}
], - "cosignerTenants": [ ],
- "cosignerApplicants": [ ],
- "occupants": [ ],
- "processEmergencyContactsFromApplication": false,
- "emergencyContacts": [ ],
- "processPetsFromApplication": false,
- "pets": [ ],
- "processVehiclesFromApplication": false,
- "vehicles": [ ],
- "recurringCharges": [
- {
- "recurringChargeTempID": "recurring-rc_1776731117586_scxwgmuph",
- "accountID": "9",
- "amount": "1500.00",
- "startDate": "04/29/2026",
- "description": "Rent",
- "escalations": [ ],
- "nextChargeDate": "2026-06-01",
- "dayDue": 1,
- "frequency": 1,
- "isMoveInCharge": 1,
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "recurring-rc_1776731117586_tn3v4xkmd",
- "accountID": "4",
- "amount": "100.00",
- "startDate": "04/29/2026",
- "description": "Open Credit",
- "escalations": [ ],
- "nextChargeDate": "2026-06-01",
- "dayDue": 1,
- "frequency": 1,
- "isMoveInCharge": 1,
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "recurring-rc_1776731117586_t6dq0uo2h",
- "accountID": "16",
- "amount": "100.00",
- "startDate": "04/29/2026",
- "description": "Pet Rent",
- "escalations": [ ],
- "nextChargeDate": "2026-06-01",
- "dayDue": 1,
- "frequency": 1,
- "isMoveInCharge": 1,
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "recurring-rc_1776731117586_u3cewsy1o",
- "accountID": "45",
- "amount": "30.00",
- "startDate": "04/29/2026",
- "description": "Resident Benefit Package",
- "escalations": [ ],
- "nextChargeDate": "2026-06-01",
- "dayDue": 1,
- "frequency": 1,
- "isMoveInCharge": 1,
- "isForTLL": 0
}
], - "otherRecurringCharges": [
- {
- "accountID": "117",
- "amount": "120.00",
- "startDate": "10/21/2026",
- "description": "Pet Rent",
- "dayDue": 21,
- "frequency": 1
}
], - "charges": [
- {
- "recurringChargeTempID": "security-deposit",
- "chargeAccountID": "2",
- "description": "Security Deposit",
- "datePosted": "2026-04-20",
- "isMoveInCharge": 1,
- "isProrated": "0",
- "amount": "1500.00",
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "default-movein-2",
- "chargeAccountID": "43",
- "description": "Move In Admin Fee",
- "datePosted": "04/29/2026",
- "isMoveInCharge": 1,
- "isProrated": "0",
- "amount": "150.00",
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "recurring-rc_1776731117586_t6dq0uo2h",
- "chargeAccountID": "16",
- "description": "Pet Rent",
- "datePosted": "2026-05-01",
- "isMoveInCharge": 0,
- "isProrated": "1",
- "amount": "6.67",
- "isForTLL": 0
}, - {
- "recurringChargeTempID": "recurring-rc_1776731117586_u3cewsy1o",
- "chargeAccountID": "45",
- "description": "Resident Benefit Package",
- "datePosted": "2026-05-01",
- "isMoveInCharge": 0,
- "isProrated": "1",
- "amount": "2.00",
- "isForTLL": 0
}
], - "sendPortalInvitations": false,
- "deactivateListing": false,
- "chargeLeaseFee": true,
- "leaseFeeAmount": "1500.00",
- "leaseFeeDatePosted": "04/29/2026"
}{- "lease": {
- "leaseID": "3002",
- "propertyID": "603",
- "unitID": "585",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "13",
- "moveOutStatusID": "1",
- "assignedToUserID": "51",
- "applicationID": null,
- "leaseDocumentTransactionID": null,
- "code": null,
- "tenants": [
- "Valencia , Arthur"
], - "moveInDate": "2026-04-29",
- "startDate": "2026-04-29",
- "endDate": "2027-04-30",
- "tenantLiabilityInsuranceProviderID": null,
- "tenantLiabilityInsuranceEffectiveDate": "2026-04-29",
- "rentersInsuranceCompany": null,
- "rentersInsurancePolicyNumber": null,
- "rentersInsuranceExpirationDate": null,
- "rentersInsuranceFileID": null,
- "leaseFeeTransactionID": null,
- "leaseFeeBillID": "15017",
- "dateTimeCreated": "2026-04-21 00:26:41",
- "dateTimeModified": "2026-04-21 00:26:41",
- "lateFeeSettingID": "87",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "allowedPaymentAmountTypeID": null,
- "isAchDisabled": "0",
- "isCreditCardDisabled": "0",
- "isCashDisabled": "0",
- "closedDate": null,
- "closedDescription": null,
- "noticeDate": null,
- "expectedMoveOutDate": null,
- "moveOutDate": null,
- "depositRefundDueDate": null,
- "leaseReturnChargeAmount": "15.00",
- "moveOutReasonID": null,
- "moveOutUnitAvailabilityDate": null,
- "moveOutTenantRemarks": null,
- "moveOutLeaseTenantID": null,
- "isLeaseAgreementViolated": "0",
- "forwardingName": null,
- "forwardingCountryID": null,
- "forwardingAddress": null,
- "forwardingAddress2": null,
- "forwardingCity": null,
- "forwardingStateID": null,
- "forwardingPostalCode": null,
- "forwardingEmail": null,
- "forwardingPhone": null,
- "moveOutTenantReason": null,
- "tenantRefundPayoutTypeID": "1",
- "statementSettingID": null,
- "sendStatements": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "1",
- "rentvineInsuranceEnrollmentID": null,
- "rentvineInsuranceEnrollmentStatusID": null,
- "rentvineInsurancePackageID": null,
- "rentvineInsuranceRecurringChargeID": null,
- "rentvineInsuranceChargeID": null,
- "leaseActivationOptionID": "1",
- "increaseEligibilityDate": "2027-05-01",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "1",
- "isMarkedToVacate": "0",
- "rentAmount": 1600
}
}Returns 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.
{"error": "Lease <leaseID> not found"}. That check runs before the
portfolio restriction, so a restricted user gets the 400 tooincludes names are comma-separated with no spaces; a name with a space before or after it, and an unknown
name, are ignoredportfolio needs property; postingSetting and portfolioOwners need
portfolio and property; chargesForPayment needs property; propertyManager and
filterDeliveryConfiguration need unit. Without the include they need, they add nothingfalse, 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 portfoliotransactions returns every transaction on the leaseproperty - the lease's property, under propertyportfolio - 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 previousPropertyPortfoliounit - the lease's unit, under unitpropertyManager - 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 creditReportingConfigurationchargeNotificationEnabled - whether new charges notify tenants, under chargeNotificationEnabledleaseStatus - the lease's status, under leaseStatustenants - the lease's tenants, under tenantsleaseRecurringPayments - the tenants' automatic payments, under leaseRecurringPaymentsleaseRecurringCredits - the recurring credits, under leaseRecurringCreditsrecurringCharges - the recurring charges, under recurringChargesresidentPackage - the REP package enrollment and its package, under leaseResidentPackage and residentPackageresidentServices - the REP services, under residentServicesoccupants, vehicles, emergencyContacts - the lease's occupants, vehicles and emergency contacts, each under its own namepets - the pets under pets, and for a lease with an application petScreeningEnabled, petscreeningData and, when an applicant said they have none, noPetDatamoveOutContact - the move-out tenant's contact, under moveOutContactoutstandingCharges, outstandingCredits, outstandingPayments - the unpaid charges and unallocated credits and payments, each under its own nametransactions - every transaction on the lease, under transactionsrenewals and activeRenewal - the renewals, and the one in progress, each under its own namebalances - the lease's balances, under balanceslateFeeSetting - the late fee setting, under lateFeeSettingleaseFeeTransaction, leaseFeeBill, leaseFeeBillCharges - how the lease fee was billed, each under its own namerefundableTransactions - payments and credits that can still be refunded, under refundableTransactionstenantAddresses - the active tenants' addresses, under tenantAddressesapplication - the rental application, under applicationtenantLiabilityInsuranceProvider, tenantLiabilityInsurance - the tenant liability insurance, each under its own namerentersInsuranceFile, rentersInsuranceRequest, tenantPolicyStatus - the renters insurance, each under its own nameleaseDocumentTransaction - the lease document in Rentsign, under leaseDocumentTransactionstatementSetting - the lease's statement setting, under statementSettingGET /leases - List leasesGET /leases/{leaseID}/tenants - The lease's tenants, with their portal accessGET /leases/{leaseID}/recurring-charges - The lease's recurring charges, paginatedPOST /leases/{leaseID} - Update the lease| 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. |
| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object (included_portfolio) The property's portfolio. Sent with the | |
object (included_posting_setting) The portfolio's posting setting. Sent with the | |
object (account) The posting setting's operating bank account. Sent with the | |
Array of objects The portfolio's owners, each share with its owner contact. Sent with the | |
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 | |
object The portfolio that owned the property most recently before its current one. Sent with the | |
object (unit) The lease's unit. Sent with the | |
property_manager (object) or boolean The unit's property manager, or | |
object Whether the unit is set up for the Filter Delivery REP service. Sent with the | |
object Whether the lease's tenants can be reported for Positive Credit Reporting, and which can't and why. Sent with the | |
| chargeNotificationEnabled | boolean
|
object (lease_status) The lease's status. Sent with the | |
Array of objects (tenant) The lease's tenants, active and removed, sorted active first, then primary first. Sent with the | |
Array of objects The lease's automatic payments, each with the payment method it charges, sorted by next payment date. Sent with the | |
Array of objects The lease's recurring credits, sorted by next credit date. Sent with the | |
Array of objects (recurring_charge_summary) The lease's recurring charges, current first, then by start date and account. Sent with the | |
lease_resident_package (object) or null The lease's REP package enrollment, or null when it isn't enrolled. Sent with the | |
included_resident_package (object) or null The catalog package the lease is enrolled in, or null. Sent with the | |
Array of objects The lease's REP services, each with its catalog service. Sent with the | |
Array of objects (occupant) The lease's occupants, in no set order. Sent with the | |
Array of objects (lease_pet_with_photos) The lease's pets, in no set order. Sent with the | |
| petScreeningEnabled | boolean
|
Array of arrays or object The applicants' PetScreening results. Sent with the | |
object An applicant's confirmation that they have no pets. Sent with the | |
Array of objects (vehicle) The lease's vehicles, in no set order. Sent with the | |
Array of objects (emergency_contact) The lease's emergency contacts, in no set order. Sent with the | |
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 | |
Array of objects The lease's unpaid charges, newest first. Sent with the | |
Array of objects The lease's credits not fully allocated, newest first. Sent with the | |
Array of objects The lease's payments not fully allocated and not returned, newest first. Sent with the | |
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 | |
Array of objects (renewal_row) The lease's renewals, newest first (up to 2,500). Sent with the | |
renewal_row (object) or null The newest renewal that isn't complete ( | |
object (lease_balances-2) The lease's balances. Sent with the | |
object (included_late_fee_setting) The lease's late fee setting. Sent with the | |
transaction_record (object) or boolean The lease charge that billed the lease fee, or | |
included_bill (object) or boolean The bill that billed the lease fee, or | |
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 | |
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 | |
Array of objects (tenant_address) The addresses on file for the lease's active tenants. Sent with the | |
object (included_application) The rental application the lease came from. Sent with the | |
tenant_liability_insurance_provider (object) or null The tenant liability insurance provider the lease names, or null. Sent with the | |
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 | |
renters_insurance_request (object) or null The tenants' pending renters insurance request, or null. Sent with the | |
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 | |
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 | |
included_document_transaction (object) or boolean The lease's lease document in Rentsign, or | |
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 |
{- "lease": {
- "leaseID": "379",
- "propertyID": "379",
- "unitID": "383",
- "primaryLeaseStatusID": "2",
- "leaseStatusID": "2",
- "moveOutStatusID": "1",
- "assignedToUserID": null,
- "applicationID": "59",
- "leaseDocumentTransactionID": "16",
- "code": "L-0412-AVR",
- "tenants": [
- "Jane Doe",
- "Sam Doe"
], - "moveInDate": "2026-10-07",
- "startDate": "2026-07-26",
- "endDate": "2027-12-10",
- "occupancyStartDate": "2026-07-26",
- "occupancyEndDate": null,
- "isOccupancy": "0",
- "isMonthToMonth": "0",
- "monthToMonthStartDate": null,
- "monthToMonthPremiumSettingID": null,
- "tenantLiabilityInsuranceProviderID": "20",
- "tenantLiabilityInsuranceEffectiveDate": "2026-01-01",
- "rentersInsuranceCompany": "Harbor Mutual",
- "rentersInsurancePolicyNumber": "RI-55210",
- "rentersInsuranceStartDate": null,
- "rentersInsuranceExpirationDate": "2027-01-01",
- "rentersInsuranceFileID": "20",
- "rentersInsurancePolicyLiabilityAmount": null,
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "leaseFeeTransactionID": null,
- "leaseFeeBillID": "16",
- "dateTimeCreated": "2026-11-16 19:01:08",
- "dateTimeModified": "2026-11-16 19:01:09",
- "lateFeeSettingID": "379",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "allowedPaymentAmountTypeID": null,
- "isAchDisabled": "0",
- "isCreditCardDisabled": "0",
- "isCashDisabled": "0",
- "closedDate": null,
- "closedDescription": null,
- "noticeDate": "2026-10-01",
- "expectedMoveOutDate": "2026-12-31",
- "moveOutDate": null,
- "depositRefundDueDate": null,
- "leaseReturnChargeAmount": "0.00",
- "moveOutReasonID": null,
- "moveOutUnitAvailabilityDate": null,
- "moveOutTenantRemarks": null,
- "moveOutLeaseTenantID": "80",
- "isLeaseAgreementViolated": "0",
- "forwardingName": "Jane Doe",
- "forwardingCountryID": "US",
- "forwardingAddress": "123 Main St",
- "forwardingAddress2": "Apt 4",
- "forwardingCity": "Springfield",
- "forwardingStateID": "NC",
- "forwardingPostalCode": "12345",
- "forwardingEmail": "jane.doe@example.com",
- "forwardingPhone": "555-0100",
- "moveOutTenantReason": null,
- "tenantRefundPayoutTypeID": "1",
- "statementSettingID": "16",
- "sendStatements": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "1",
- "rentvineInsuranceEnrollmentID": null,
- "rentvineInsuranceEnrollmentStatusID": null,
- "rentvineInsurancePackageID": null,
- "rentvineInsuranceRecurringChargeID": null,
- "rentvineInsuranceChargeID": null,
- "rentersInsuranceProviderTypeID": null,
- "leaseActivationOptionID": "1",
- "scheduledActivationFailedDateTime": null,
- "scheduledActivationFailureReasonID": null,
- "increaseEligibilityDate": "2027-12-11",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "1",
- "isMarkedToVacate": "0",
- "rentAmount": 1450,
- "baseRentAmount": 1450,
- "hasPendingMonthToMonthConversion": false
}
}Updates an existing lease's details. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.
assignedToUserID)closedDate and closedDescription within the lease detailsUpdate Lease permission under the Leasing component400 is returned if not foundleaseStatusID is not updated by this endpoint; use POST /leases/{leaseID}/status to change statusGET /leases/{leaseID} - Get full lease detail (same response shape as returned here)POST /leases/{leaseID}/status - Update lease status onlyPOST /leases - Create a new lease| leaseID required | integer Example: 2213 |
| assignedToUserID | string or integer or null^-?[0-9]+$ ID of the user assigned to manage this lease. |
| leaseStatusID | string or integer or null^-?[0-9]+$ Lease status ID. Sent by the frontend but not applied by this endpoint — use |
| noticeDate | string or null <date> Date the tenant gave notice to vacate. |
| expectedMoveOutDate | string or null <date> Expected date the tenant will move out. |
| moveInDate | string or null <date> Tenant move-in date. |
| moveOutDate | string or null <date> Actual move-out date. |
| depositRefundDueDate | string or null <date> Date by which the security deposit refund is due. |
| closedDate | string or null <date> Date the lease was closed. Set along with |
| closedDescription | string or null Reason or notes recorded when the lease is closed. |
| startDate | string <date> Lease start date. |
| endDate | string or null <date> Lease end date. Omit or set null for month-to-month leases. |
| increaseEligibilityDate | string or null <date> Date after which the lease is eligible for a rent increase. |
| leaseReturnChargeAmount | string or number <decimal> Amount charged for returned payments (NSF fee). |
| lateFeeSettingID | string or integer or null^-?[0-9]+$ ID of the late fee configuration to apply to this lease. |
| showOverriddenAllowedPaymentType | boolean Frontend flag controlling whether the allowed payment type override UI is shown. Sent in the payload but not persisted by this endpoint. |
| allowedPaymentAmountTypeID | string or integer or null^-?[0-9]+$ Restricts the payment amount type tenants may submit. Null means no restriction. (1 means any amount, 2 means full amount only) |
| isTenantPastDueNoticeEnabled | string or integer Enum: "0" "1" 0 1 Whether past-due notice emails are sent for this lease (0 or 1). |
| statementSettingID | string or integer or null^-?[0-9]+$ Statement setting override for this lease. Null uses the portfolio default. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether statements are sent to tenants (0 or 1). |
| code | string or null Optional lease reference code. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease) |
{- "assignedToUserID": "122188",
- "leaseStatusID": "21",
- "noticeDate": "2025-03-21",
- "expectedMoveOutDate": "2025-08-05",
- "moveInDate": "2025-03-05",
- "moveOutDate": "2025-08-05",
- "depositRefundDueDate": "2026-04-21",
- "closedDate": "2026-04-21",
- "closedDescription": "test 1",
- "startDate": "2026-04-17",
- "endDate": "2026-10-17",
- "increaseEligibilityDate": "2028-03-05",
- "rentAmount": 100,
- "leaseReturnChargeAmount": "35.00",
- "lateFeeSettingID": "87",
- "showOverriddenAllowedPaymentType": true,
- "allowedPaymentAmountTypeID": 1,
- "isTenantPastDueNoticeEnabled": "1",
- "statementSettingID": "1",
- "sendStatements": "1"
}{- "lease": {
- "leaseID": "2213",
- "propertyID": "406",
- "unitID": "391",
- "primaryLeaseStatusID": "2",
- "leaseStatusID": "21",
- "moveOutStatusID": "1",
- "assignedToUserID": "122188",
- "applicationID": null,
- "leaseDocumentTransactionID": null,
- "code": null,
- "tenants": [
- "John Tester",
- "Joe Michael"
], - "moveInDate": "2025-03-05",
- "startDate": "2026-04-17",
- "endDate": "2026-10-25",
- "tenantLiabilityInsuranceProviderID": null,
- "tenantLiabilityInsuranceEffectiveDate": null,
- "rentersInsuranceCompany": "rentersInsuranceCompany",
- "rentersInsurancePolicyNumber": "111222333-4",
- "rentersInsuranceExpirationDate": "2028-02-03",
- "rentersInsuranceFileID": null,
- "leaseFeeTransactionID": null,
- "leaseFeeBillID": null,
- "dateTimeCreated": "2025-03-06 17:04:46",
- "dateTimeModified": "2026-04-21 15:03:58",
- "lateFeeSettingID": "87",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "allowedPaymentAmountTypeID": null,
- "isAchDisabled": "0",
- "isCreditCardDisabled": "1",
- "isCashDisabled": "0",
- "closedDate": null,
- "closedDescription": null,
- "noticeDate": "2025-03-21",
- "expectedMoveOutDate": "2025-08-05",
- "moveOutDate": "2025-08-05",
- "depositRefundDueDate": null,
- "leaseReturnChargeAmount": "35.00",
- "moveOutReasonID": "8",
- "moveOutUnitAvailabilityDate": null,
- "moveOutTenantRemarks": null,
- "moveOutLeaseTenantID": null,
- "isLeaseAgreementViolated": "0",
- "forwardingName": null,
- "forwardingCountryID": "US",
- "forwardingAddress": null,
- "forwardingAddress2": null,
- "forwardingCity": null,
- "forwardingStateID": "FL",
- "forwardingPostalCode": null,
- "forwardingEmail": null,
- "forwardingPhone": null,
- "moveOutTenantReason": null,
- "tenantRefundPayoutTypeID": "1",
- "statementSettingID": null,
- "sendStatements": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "0",
- "rentvineInsuranceEnrollmentID": null,
- "rentvineInsuranceEnrollmentStatusID": null,
- "rentvineInsurancePackageID": null,
- "rentvineInsuranceRecurringChargeID": null,
- "rentvineInsuranceChargeID": null,
- "leaseActivationOptionID": "3",
- "increaseEligibilityDate": "2028-03-05",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "1",
- "isMarkedToVacate": "0",
- "rentAmount": 100
}
}Permanently deletes a lease from the system. On success, returns the deleted lease record as it existed at time of deletion.
This endpoint will only succeed if the lease has never had any accounting transactions, payouts, or deposit releases tied to it. Voiding or deleting individual charges, tenant credits, or tenant receipts does not satisfy this requirement — once any transaction has ever been recorded against a lease, the lease cannot be deleted. Use lease closure or move-out workflows instead to retire a lease that has financial history.
Update Lease permission under the Leasing component400 is returned if not found400 is returned with "Cannot delete a lease that has accounting transactions" if any existGET /leases/{leaseID} - Get the lease detail before deletingPOST /leases/{leaseID}/status - Close or change lease status (for leases with transaction history)| leaseID required | integer Example: 2213 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease) |
{- "leaseID": "2213",
- "propertyID": "406",
- "unitID": "391",
- "primaryLeaseStatusID": "1",
- "leaseStatusID": "21",
- "moveOutStatusID": "1",
- "assignedToUserID": null,
- "applicationID": null,
- "leaseDocumentTransactionID": null,
- "code": null,
- "moveInDate": "2026-05-01",
- "startDate": "2026-05-01",
- "endDate": "2027-04-30",
- "dateTimeCreated": "2026-04-22 10:00:00",
- "dateTimeModified": "2026-04-22 10:00:00",
- "lateFeeSettingID": null,
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "isLeaseAgreementViolated": "0",
- "tenantRefundPayoutTypeID": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "0",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "0",
- "isMarkedToVacate": "0"
}Updates the status of an existing lease. On success the endpoint internally forwards to GET /leases/{leaseID} and returns the full lease detail.
Update Lease permission under the Leasing component400 is returned if not foundleaseStatusID is the only required field; all other fields are optional and will be updated only when providedleaseStatusID references custom statuses configured in the account (see GET /leases/statuses)GET /leases/{leaseID} - Get full lease detail (same response shape as returned here)POST /leases/{leaseID} - Update other lease fields (dates, settings, insurance info)GET /leases/statuses - List available custom lease statuses| leaseID required | integer Example: 2213 |
| leaseStatusID required | string or integer^-?[0-9]+$ ID of the custom lease status to assign. References the account-configured statuses from |
| noticeDate | string or null <date> Date the tenant gave notice to vacate. |
| expectedMoveOutDate | string or null <date> Expected date the tenant will move out. |
| moveOutDate | string or null <date> Actual date the tenant moved out. |
| depositRefundDueDate | string or null <date> Date by which the security deposit refund must be issued. |
| closedDate | string or null <date> Date the lease was closed. |
| closedDescription | string or null Optional description or reason for closing the lease. |
| isPortalPaymentDisabled | string or integer or null Enum: "0" "1" 0 1 null Whether portal payments are disabled for this lease (0 or 1). |
| isTenantPastDueNoticeEnabled | string or integer or null Enum: "0" "1" 0 1 null Whether past-due notices are sent to tenants (0 or 1). |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease) |
{- "leaseStatusID": 2
}{- "lease": {
- "leaseID": "2213",
- "propertyID": "406",
- "unitID": "391",
- "primaryLeaseStatusID": "2",
- "leaseStatusID": "2",
- "moveOutStatusID": "1",
- "assignedToUserID": "122188",
- "applicationID": null,
- "leaseDocumentTransactionID": null,
- "code": "test",
- "tenants": [
- "John Tester",
- "Joe Michael"
], - "moveInDate": "2025-03-05",
- "startDate": "2026-04-17",
- "endDate": "2026-10-17",
- "tenantLiabilityInsuranceProviderID": null,
- "tenantLiabilityInsuranceEffectiveDate": null,
- "rentersInsuranceCompany": "rentersInsuranceCompany",
- "rentersInsurancePolicyNumber": "111222333-4",
- "rentersInsuranceExpirationDate": "2028-02-03",
- "rentersInsuranceFileID": null,
- "leaseFeeTransactionID": null,
- "leaseFeeBillID": null,
- "dateTimeCreated": "2025-03-06 17:04:46",
- "dateTimeModified": "2026-04-21 20:44:34",
- "lateFeeSettingID": "87",
- "isPortalDisabled": "0",
- "isPortalPaymentDisabled": "0",
- "isCertifiedFundsRequired": "0",
- "isLateFeesActive": "1",
- "allowedPaymentAmountTypeID": "1",
- "isAchDisabled": "0",
- "isCreditCardDisabled": "1",
- "isCashDisabled": "0",
- "closedDate": "2026-04-21",
- "closedDescription": "test 1",
- "noticeDate": "2025-03-21",
- "expectedMoveOutDate": "2025-08-05",
- "moveOutDate": "2025-08-05",
- "depositRefundDueDate": "2026-04-21",
- "leaseReturnChargeAmount": "35.00",
- "moveOutReasonID": "8",
- "moveOutUnitAvailabilityDate": null,
- "moveOutTenantRemarks": null,
- "moveOutLeaseTenantID": null,
- "isLeaseAgreementViolated": "0",
- "forwardingName": null,
- "forwardingCountryID": "US",
- "forwardingAddress": null,
- "forwardingAddress2": null,
- "forwardingCity": null,
- "forwardingStateID": "FL",
- "forwardingPostalCode": null,
- "forwardingEmail": null,
- "forwardingPhone": null,
- "moveOutTenantReason": null,
- "tenantRefundPayoutTypeID": "1",
- "statementSettingID": "1",
- "sendStatements": "1",
- "isFromImport": "0",
- "importSourceKey": null,
- "isTenantPastDueNoticeEnabled": "1",
- "rentvineInsuranceEnrollmentID": null,
- "rentvineInsuranceEnrollmentStatusID": null,
- "rentvineInsurancePackageID": null,
- "rentvineInsuranceRecurringChargeID": null,
- "rentvineInsuranceChargeID": null,
- "leaseActivationOptionID": "3",
- "increaseEligibilityDate": "2028-03-05",
- "isAutoClosed": "0",
- "isPublicStatementEnabled": "1",
- "isMarkedToVacate": "0",
- "rentAmount": 100
}
}Returns 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.
0 answers 400 (a restricted user gets the 403
instead, since the restriction is checked first)leaseTenantIDtaxIdentifierTruncated)POST /leases/{leaseID}/tenants - Add a tenant to the leaseDELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the leaseGET /tenants/{contactID} - A tenant's full contact record| 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. |
| isActive | string Example: isActive=1
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_tenant_link) A tenant's place on a lease ( |
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. |
[- {
- "leaseTenant": {
- "leaseTenantID": "188",
- "leaseID": "811",
- "contactID": "494",
- "isPrimary": "1",
- "isCosigner": "0",
- "isActive": "1",
- "moveInDate": "2026-01-01",
- "moveOutDate": null,
- "leaseTenantCashCardID": null
}, - "contact": {
- "contactID": "494",
- "contactTypeID": "2",
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "birthDate": "1990-01-01",
- "applicantID": "128",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationIssuingLocation": "CO",
- "identificationExpirationDate": "2031-04-12",
- "identificationCountryID": "US",
- "taxIdentifierTruncated": "6789",
- "hasPortalAccess": 1,
- "hasPortalInvitation": 1,
- "invitationDateTimeCreated": "2026-11-16 19:17:17",
- "hasApplicantUser": 1
}
}
]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.
Update Lease permission under the Leasing component400 is returned otherwiseClosed status (primaryLeaseStatusID = 3)contactID is omitted or empty, a new contact is created using name (required), plus optional emails, phones, and addressescontactID is provided, the existing contact is linked directly — name, emails, phones, and addresses are ignoredTenant (contactTypeID = 2) and must be active400moveInDate is requiredGET /leases/{leaseID}/tenants - List all tenants on the leaseGET /leases/{leaseID}/tenants/{leaseTenantID} (undocumented) - Get a single tenant (same response shape returned here)DELETE /leases/{leaseID}/tenants/{leaseTenantID} - Remove a tenant from the lease| leaseID required | integer Example: 2213 |
| moveInDate required | string <date> Date the tenant moves in. Required. |
| name required | string Full name of the new tenant contact. Required when |
| contactID | string or integer or null^-?[0-9]+$ ID of an existing contact to link to the lease. When provided, the contact must already be of type Tenant and be active.
If omitted or null, a new tenant contact is created using |
Array of objects Email addresses to attach to the new tenant contact. Ignored when | |
Array of objects Phone numbers to attach to the new tenant contact. Ignored when | |
Array of objects Addresses to attach to the new tenant contact. Ignored when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The newly created lease tenant record. |
required | object The contact record for the tenant. |
{- "moveInDate": "2026-04-21",
- "isCosigner": 0,
- "name": "Testing Doc",
- "emails": [
- {
- "email": "testingdoc@email.com"
}
], - "phones": [
- {
- "phone": "+12399995555",
- "phoneTypeID": "1"
}
]
}{- "leaseTenant": {
- "leaseTenantID": "3389",
- "leaseID": "2213",
- "contactID": "5244",
- "isPrimary": "0",
- "isCosigner": "0",
- "isActive": "1",
- "moveInDate": "2026-04-21",
- "moveOutDate": null,
- "leaseTenantCashCardID": null
}, - "contact": {
- "contactID": "5244",
- "contactTypeID": "2",
- "name": "Testing Doc",
- "email": "testingdoc@email.com",
- "phone": "+12399995555",
- "birthDate": null,
- "applicantID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "identificationCountryID": null,
- "taxIdentifierTruncated": null
}
}Removes a tenant from a lease. On success, returns the deleted lease tenant record as it existed at time of deletion.
Update Lease permission under the Leasing component400 is returned otherwiseleaseTenantID must belong to the specified leaseID; a 400 is returned if the lease tenant is not found400 is returned if the lease has no active tenantsGET /leases/{leaseID}/tenants - List all tenants on the leaseGET /leases/{leaseID}/tenants/{leaseTenantID} - Get a single tenant detailPOST /leases/{leaseID}/tenants - Add a tenant to the lease| leaseID required | integer Example: 2213 |
| leaseTenantID required | integer Example: 3391 The |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| leaseTenantID required | string^-?[0-9]+$ Unique identifier for the lease tenant record. |
| leaseID required | string^-?[0-9]+$ ID of the lease this tenant belonged to. |
| contactID required | string^-?[0-9]+$ ID of the linked contact record. |
| isPrimary required | string Enum: "0" "1" Whether this tenant was the primary tenant on the lease ( |
| isCosigner required | string Enum: "0" "1" Whether this tenant was a co-signer ( |
| isActive required | string Enum: "0" "1" Active status at time of deletion ( |
| moveInDate | string or null <date> Date the tenant moved in. |
| moveOutDate | string or null <date> Date the tenant moved out. Null for active tenants. |
| orderIndex | string or null^-?[0-9]+$ Display order index for the tenant on the lease. |
{- "leaseTenantID": "3391",
- "leaseID": "2213",
- "contactID": "5246",
- "isPrimary": "0",
- "isCosigner": "0",
- "isActive": "1",
- "moveInDate": "2026-05-01",
- "moveOutDate": null,
- "orderIndex": "4"
}Returns a 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.
nextChargeDate, earliest first; charges on the same date come in no set orderaccount is always sent, whatever includes says. A list item has no recurringStatusID: read one charge
for itlease - the lease, under leaseproperty - the lease's property, under propertyGET /leases/{leaseID}/recurring-charges/{chargeID} - One recurring charge, with its computed statusPOST /leases/{leaseID}/recurring-charges - Add a recurring charge to the leaseGET /accounting/accounts - The chart of accounts, for the accountID filter| 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. |
| 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 |
| accountID | integer Example: accountID=9 Returns only the charges that post to this chart-of-accounts account ( |
| includes | string Example: includes=lease,property Comma-separated related data to add to each item; |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (recurring_charge) A recurring charge on a lease ( |
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 | |
object (property) The lease's property. Sent with the |
[- {
- "recurringCharge": {
- "leaseRecurringChargeID": "704",
- "leaseID": "1366",
- "rentIncreaseID": null,
- "leaseRenewalID": null,
- "accountID": "9",
- "amount": "1450.00",
- "description": "Monthly Rent",
- "dayDue": "2",
- "frequency": "1",
- "startDate": "2026-11-07",
- "endDate": "2027-12-31",
- "nextChargeDate": "2026-12-02",
- "isMoveInCharge": "0",
- "isFromImport": "1",
- "importSourceKey": "IMPORT-1",
- "monthToMonthPremiumRecurringChargeID": null
}, - "account": {
- "accountID": "9",
- "parentAccountID": null,
- "accountTypeID": "7",
- "accountCategoryID": "1",
- "number": "4100",
- "name": "Rent Income",
- "isActive": "1",
- "isSubjectToManagementFees": "1",
- "isSubjectToLateFees": "1",
- "isDeposit": "0",
- "depositTypeID": null,
- "isEscrow": "0",
- "isRent": "1",
- "isSubsidized": "0",
- "isTaxable": "1",
- "isSubjectToSalesTax": "1",
- "isSubjectToMarkup": "1",
- "isPrepayment": "0",
- "isManagementFee": "0",
- "isBudgetEnabled": "1",
- "isHeld": "0",
- "bankName": null,
- "bankAccountTypeID": null,
- "bankAccountCiphertextID": null,
- "bankAccountNumberTruncated": null,
- "bankAccountAddress": null,
- "bankAccountAddress2": null,
- "bankAccountCity": null,
- "bankAccountStateID": null,
- "bankAccountPostalCode": null,
- "bankAccountCountryID": null,
- "isCheckingEnabled": "0",
- "checkCompanyName": null,
- "checkSignatory": null,
- "checkAddress": null,
- "checkAddress2": null,
- "checkCity": null,
- "checkStateID": null,
- "checkPostalCode": null,
- "checkCountryID": null,
- "bankAccountNextCheckNumber": null,
- "bankAccountNextDepositNumber": null,
- "checkTemplateID": null,
- "creditCardGatewayID": null,
- "achGatewayID": null,
- "cashCardGatewayID": null,
- "remoteCheckGatewayID": null,
- "isFromImport": "1",
- "importSourceKey": "4100",
- "isNachaEnabled": "0",
- "isNachaFileBalanced": "0",
- "nachaOriginName": null,
- "nachaOriginNumber": null,
- "nachaDestinationName": null,
- "nachaDestinationNumber": null,
- "nachaCompanyIdentification": null,
- "nachaCompanyName": null,
- "nachaOriginatingFinancialInstitutionID": null,
- "nachaAdapterID": null,
- "isBillApprovalExempt": "0",
- "exportInvoiceServiceName": null,
- "dateTimeCreated": "2023-01-14 18:39:10",
- "dateTimeModified": "2023-11-01 17:15:49",
- "dateTimeDeactivated": null
}
}
]Creates a new recurring charge on a lease. On success the endpoint internally forwards to GET /leases/{leaseID}/recurring-charges/{chargeID} and returns the full charge detail along with the previous charge on the lease.
Update Lease permission under the Leasing component400 is returned otherwiseaccountID must reference a valid chart-of-account entry of a charge typestartDate is the date the charge appears on reports such as the Rent Roll; accepted as MM/DD/YYYYdayDue is the day of the month (1–31) on which recurring charge transactions are generatedfrequency is the number of months between charge occurrences; defaults to 1 (monthly)endDate is optional — leaving it blank causes the charge to continue until the lease reaches a Primary Closed StatusGET /leases/{leaseID}/recurring-charges - List all recurring charges for the leaseGET /leases/{leaseID}/recurring-charges/{chargeID} - Get a single recurring charge (same response shape returned here)POST /leases/{leaseID}/recurring-charges/{chargeID} - Update an existing recurring chargeDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete a recurring charge| leaseID required | integer Example: 2213 |
| dayDue required | string or integer [ 1 .. 31 ] ^-?[0-9]+$ Day of the month (1–31) on which charge transactions are generated. |
| frequency required | string or integer [ 1 .. 24 ] ^-?[0-9]+$ Default: "1" Number of months between charge occurrences. Use |
| accountID required | string or integer^-?[0-9]+$ ID of the chart-of-account entry to post the charge against. Must be a charge-type account. |
| amount required | string or number <decimal> Charge amount as a decimal string. |
| description required | string Label for the charge as it appears on statements and reports. |
| startDate required | string Date the charge begins appearing on reports such as the Rent Roll. Accepted format is |
| endDate | string or null Date the charge stops being generated. Accepted format is |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The newly created recurring charge. |
object or null The previous recurring charge on this lease (immediately before the new one), if any. Does not include |
{- "dayDue": 1,
- "frequency": 1,
- "accountID": "16",
- "amount": "1500.00",
- "description": "Monthly Rent",
- "startDate": "04/20/2027",
- "endDate": "04/12/2028"
}{- "recurringCharge": {
- "leaseRecurringChargeID": "12012",
- "leaseID": "2213",
- "rentIncreaseID": null,
- "accountID": "16",
- "amount": "100.00",
- "description": "More Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2027-04-20",
- "endDate": "2028-04-12",
- "nextChargeDate": "2027-05-01",
- "isMoveInCharge": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "recurringStatusID": 2
}, - "previousCharge": {
- "leaseRecurringChargeID": "11950",
- "leaseID": "2213",
- "rentIncreaseID": null,
- "accountID": "9",
- "amount": "200.00",
- "description": "Base Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2027-03-05",
- "endDate": null,
- "nextChargeDate": "2027-04-01",
- "isMoveInCharge": "0",
- "isFromImport": "0",
- "importSourceKey": null
}
}Returns 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.
{"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 chargeaccount is sent only with includes=accountaccount - the chart-of-accounts account the charge posts to, under accountGET /leases/{leaseID}/recurring-charges - The lease's recurring chargesPOST /leases/{leaseID}/recurring-charges/{chargeID} - Update this recurring chargeDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge| 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 |
| includes | string Example: includes=account
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
{- "recurringCharge": {
- "leaseRecurringChargeID": "718",
- "leaseID": "1374",
- "rentIncreaseID": null,
- "leaseRenewalID": null,
- "accountID": "9",
- "amount": "1450.00",
- "description": "Monthly Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2026-01-01",
- "endDate": "2026-12-31",
- "nextChargeDate": "2026-12-01",
- "isMoveInCharge": "0",
- "isFromImport": "1",
- "importSourceKey": "IMPORT-4",
- "monthToMonthPremiumRecurringChargeID": null,
- "recurringStatusID": 1
}, - "previousCharge": {
- "leaseRecurringChargeID": "717",
- "leaseID": "1374",
- "rentIncreaseID": null,
- "leaseRenewalID": null,
- "accountID": "9",
- "amount": "1400.00",
- "description": "Monthly Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2025-01-01",
- "endDate": "2025-12-31",
- "nextChargeDate": "2026-12-01",
- "isMoveInCharge": "0",
- "isFromImport": "1",
- "importSourceKey": "IMPORT-3",
- "monthToMonthPremiumRecurringChargeID": null
}
}Updates an existing recurring charge on a lease. Only include the fields you want to change — fields omitted from the request body retain their current values. Fields cannot be set to null via this endpoint.
On success the endpoint internally forwards to GET /leases/{leaseID}/recurring-charges/{chargeID} and returns the full charge detail along with the previous charge on the lease.
Update Lease permission under the Leasing component400 is returned if either is not foundnull; omit a field to leave it unchangedstartDate and endDate are accepted as MM/DD/YYYY in the requestPOST /leases/{leaseID}/recurring-charges - Create a new recurring charge (use this to get the chargeID)GET /leases/{leaseID}/recurring-charges - List all recurring charges for the leaseDELETE /leases/{leaseID}/recurring-charges/{chargeID} - Delete this recurring charge| leaseID required | integer Example: 2213 |
| chargeID required | integer Example: 12012 The |
| accountID | string or integer^-?[0-9]+$ ID of the chart-of-account entry to post the charge against. Must be a charge-type account. |
| amount | string or number <decimal> Charge amount as a decimal string. |
| description | string Label for the charge as it appears on statements and reports. |
| dayDue | string or integer^-?[0-9]+$ Day of the month (1–31) on which charge transactions are generated. |
| frequency | string or integer^-?[0-9]+$ Number of months between charge occurrences. Use |
| startDate | string Date the charge begins appearing on reports such as the Rent Roll. Accepted format is |
| endDate | string Date the charge stops being generated. Accepted format is |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The updated recurring charge. |
object or null The previous recurring charge on this lease (immediately before this one), if any. Does not include |
{- "amount": "120.00"
}{- "recurringCharge": {
- "leaseRecurringChargeID": "12012",
- "leaseID": "2213",
- "rentIncreaseID": null,
- "accountID": "16",
- "amount": "120.00",
- "description": "More Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2027-04-20",
- "endDate": "2028-04-12",
- "nextChargeDate": "2027-05-01",
- "isMoveInCharge": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "recurringStatusID": 2
}, - "previousCharge": {
- "leaseRecurringChargeID": "11950",
- "leaseID": "2213",
- "rentIncreaseID": null,
- "accountID": "9",
- "amount": "200.00",
- "description": "Base Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2027-03-05",
- "endDate": null,
- "nextChargeDate": "2027-04-01",
- "isMoveInCharge": "0",
- "isFromImport": "0",
- "importSourceKey": null
}
}Permanently deletes a recurring charge from a lease. On success, returns the deleted recurring charge record as it existed at time of deletion.
Update Lease permission under the Leasing component400 is returned if not foundPOST /leases/{leaseID}/recurring-charges/{chargeID} to set an endDate instead if you want to stop future postings while preserving historyGET /leases/{leaseID}/recurring-charges/{chargeID} - Get the charge detail before deletingGET /leases/{leaseID}/recurring-charges - List all recurring charges for the leasePOST /leases/{leaseID}/recurring-charges/{chargeID} - Update the charge (e.g. set an end date)| leaseID required | integer Example: 2213 |
| chargeID required | integer Example: 12012 The |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| leaseRecurringChargeID required | string^-?[0-9]+$ Unique identifier for the recurring charge. |
| leaseID required | string^-?[0-9]+$ ID of the lease this charge belonged to. |
| accountID required | string^-?[0-9]+$ Chart-of-account ID the charge posted against. |
| amount required | string <decimal> Charge amount as a decimal string. |
| description required | string Label for the charge as it appeared on statements and reports. |
| dayDue required | string^-?[0-9]+$ Day of the month on which charge transactions were generated. |
| frequency required | string^-?[0-9]+$ Number of months between charge occurrences. |
| startDate required | string <date> Date the charge began appearing on reports. |
| isMoveInCharge required | string Enum: "0" "1" Whether this charge was created as a move-in charge ( |
| isFromImport required | string Enum: "0" "1" Whether this charge was created via import ( |
| rentIncreaseID | string or null^-?[0-9]+$ ID of the rent increase that created this charge, if any. |
| endDate | string or null <date> Date the charge was scheduled to stop. Null means it was open-ended. |
| nextChargeDate | string or null <date> Next charge date at time of deletion. |
| importSourceKey | string or null Import source key if the charge came from an import, otherwise null. |
{- "leaseRecurringChargeID": "12012",
- "leaseID": "2213",
- "rentIncreaseID": null,
- "accountID": "16",
- "amount": "120.00",
- "description": "More Rent",
- "dayDue": "1",
- "frequency": "1",
- "startDate": "2027-04-20",
- "endDate": "2028-04-12",
- "nextChargeDate": "2027-05-01",
- "isMoveInCharge": "0",
- "isFromImport": "0",
- "importSourceKey": null
}Lists the pets on one lease, sorted by name, one page at a time. Each item wraps the pet under pet, beside a
token the search adds.
Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.leaseID with no lease answers 200 with an empty list (a restricted key gets the 403 above
instead); a value that isn't a number answers the stock 404.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.GET /leases/{leaseID}/pets/{leasePetID} - get one petPOST /leases/{leaseID}/pets - add a pet to the leaseGET /leases/{leaseID} - the lease| leaseID required | integer >= 1 Example: 60 The lease, from |
| search | string Example: search=bisc Part of the pet's name, matched anywhere in it and in any case. |
| page | integer Default: 1 Example: page=1 Page number (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" Current page number, as requested (1 for |
| pagination-next-page | integer Example: "1" Next page number. When there is no next page it repeats the last page number, so it is lower than the current page past the end, and 0 when nothing matches. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number; 0 when nothing matches |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_pet) An animal living at the lease's unit, as the lease's Animals card shows it. Each pet belongs to one lease; the flags are
|
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the search to every item. Carries no information about the pet. |
[- {
- "pet": {
- "leasePetID": "66",
- "leaseID": "60",
- "type": "Dog",
- "name": "Biscuit",
- "age": "4",
- "weight": "45 lbs",
- "isTrained": "1",
- "color": "Brown",
- "hasShots": "1",
- "isNeutered": "1",
- "isDeclawed": "0",
- "isEmotionalSupportAnimal": "0",
- "isServiceAnimal": "1",
- "gender": "Male",
- "dateTimeCreated": "2026-11-12 07:37:59",
- "petScreeningAnimalID": "88123"
}, - "token": "1794469079"
}
]Adds a pet to the lease and returns it as GET /leases/{leaseID}/pets/{leasePetID} does, including any
includes the request asks for.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.{} answers 400 {"error": "invalid input."}.type is required and can't be empty or only spaces ({"type": ["Type is required"]}). type, name,
weight, color and gender take up to 100 characters, and age digits only; each failure is a message
under its field, all of them in one response.leaseID with no lease answers 400 {"leaseID": ["Lease does not exist."]} (a restricted key gets
a 403 Lease {leaseID}: Access Denied instead); a value that isn't a number answers the stock 404.Pet Added entry, naming the pet's type and name, to the lease's history log.GET /leases/export (its lease.dateTimeModified, which that export reports
and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID}
and the lease include send it, doesn't change.GET /leases/{leaseID}/pets - list the lease's petsPOST /leases/{leaseID}/pets/{leasePetID} - update a petGET /leases - find the lease| leaseID required | integer Example: 60 The lease to add the pet to, from |
| includes | string Example: includes=lease
|
| type required | string [ 1 .. 100 ] characters Kind of animal, free text ( |
| name | string or null <= 100 characters The pet's name. |
| age | string or integer or null >= 0 ^[0-9]+$ Age in whole years; digits only ( |
| weight | string or null <= 100 characters Weight, free text with its unit ( |
| color | string or null <= 100 characters Color, free text. |
| gender | string or null <= 100 characters Gender, free text. |
| hasShots | string or integer or boolean or null Whether the pet's vaccinations are current; the flag values above. Unlike the other flags, no check refuses
another number: |
| isTrained | string or integer or boolean or null Whether the pet is house-trained; the flag values above. |
| isNeutered | string or integer or boolean or null Whether the pet is spayed or neutered; the flag values above. |
| isDeclawed | string or integer or boolean or null Whether the pet is declawed; the flag values above. |
| isEmotionalSupportAnimal | string or integer or boolean or null Whether the pet is an emotional support animal; the flag values above. |
| isServiceAnimal | string or integer or boolean or null Whether the pet is a service animal; the flag values above. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_pet) An animal living at the lease's unit, as the lease's Animals card shows it. Each pet belongs to one lease; the flags are
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "type": "Dog",
- "name": "Maple",
- "age": 3,
- "weight": "52 lbs",
- "color": "Golden",
- "gender": "Female",
- "hasShots": 1,
- "isTrained": 1,
- "isNeutered": 1,
- "isDeclawed": 0,
- "isEmotionalSupportAnimal": 0,
- "isServiceAnimal": 0
}{- "pet": {
- "leasePetID": "90",
- "leaseID": "81",
- "type": "Dog",
- "name": "Maple",
- "age": "3",
- "weight": "52 lbs",
- "isTrained": "1",
- "color": "Golden",
- "hasShots": "1",
- "isNeutered": "1",
- "isDeclawed": "0",
- "isEmotionalSupportAnimal": "0",
- "isServiceAnimal": "0",
- "gender": "Female",
- "dateTimeCreated": "2026-11-12 07:38:03",
- "petScreeningAnimalID": null
}
}Returns one of the lease's pets under pet, plus the lease under lease when the lease include is asked for.
Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet {leasePetID} not found"}; a
value that isn't a number answers the stock 404.lease - the pet's lease, every column of the lease rowGET /leases/{leaseID}/pets - list the lease's petsPOST /leases/{leaseID}/pets/{leasePetID} - update the petDELETE /leases/{leaseID}/pets/{leasePetID} - remove the pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet, from |
| includes | string Example: includes=lease
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_pet) An animal living at the lease's unit, as the lease's Animals card shows it. Each pet belongs to one lease; the flags are
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "pet": {
- "leasePetID": "81",
- "leaseID": "73",
- "type": "Dog",
- "name": "Biscuit",
- "age": "4",
- "weight": "45 lbs",
- "isTrained": "1",
- "color": "Brown",
- "hasShots": "1",
- "isNeutered": "1",
- "isDeclawed": "0",
- "isEmotionalSupportAnimal": "0",
- "isServiceAnimal": "1",
- "gender": "Male",
- "dateTimeCreated": "2026-11-12 07:38:01",
- "petScreeningAnimalID": "88123"
}
}Updates one of the lease's pets and returns it as GET /leases/{leaseID}/pets/{leasePetID} does, including any
includes the request asks for. Only the keys sent are changed.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.{} answers 400 {"error": "invalid input."}.{"extraKey": "x"}) is accepted: 200, nothing changes.leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet not found"}
(without the ID, unlike the GET); a value that isn't a number answers the stock 404.type can't be set to null, empty or only spaces ({"type": ["Type is required"]}). The other limits are
those of POST /leases/{leaseID}/pets, each failure a message under its field.Pet Modified entry, listing the changes, to the lease's history log.GET /leases/export (its lease.dateTimeModified, which that export reports
and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID}
and the lease include send it, doesn't change.GET /leases/{leaseID}/pets/{leasePetID} - get the petDELETE /leases/{leaseID}/pets/{leasePetID} - remove the petPOST /leases/{leaseID}/pets - add a pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet, from |
| includes | string Example: includes=lease
|
| type | string [ 1 .. 100 ] characters Kind of animal, free text ( |
| name | string or null <= 100 characters The pet's name. |
| age | string or integer or null >= 0 ^[0-9]+$ Age in whole years; digits only ( |
| weight | string or null <= 100 characters Weight, free text with its unit ( |
| color | string or null <= 100 characters Color, free text. |
| gender | string or null <= 100 characters Gender, free text. |
| hasShots | string or integer or boolean or null Whether the pet's vaccinations are current; the flag values above. Unlike the other flags, no check refuses
another number: |
| isTrained | string or integer or boolean or null Whether the pet is house-trained; the flag values above. |
| isNeutered | string or integer or boolean or null Whether the pet is spayed or neutered; the flag values above. |
| isDeclawed | string or integer or boolean or null Whether the pet is declawed; the flag values above. |
| isEmotionalSupportAnimal | string or integer or boolean or null Whether the pet is an emotional support animal; the flag values above. |
| isServiceAnimal | string or integer or boolean or null Whether the pet is a service animal; the flag values above. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_pet) An animal living at the lease's unit, as the lease's Animals card shows it. Each pet belongs to one lease; the flags are
|
object (included_lease) The pet's lease, every column of the lease row. Sent only with the |
{- "weight": "48 lbs",
- "isTrained": 0
}{- "pet": {
- "leasePetID": "102",
- "leaseID": "91",
- "type": "Dog",
- "name": "Biscuit",
- "age": "4",
- "weight": "48 lbs",
- "isTrained": "0",
- "color": "Brown",
- "hasShots": "1",
- "isNeutered": "1",
- "isDeclawed": "0",
- "isEmotionalSupportAnimal": "0",
- "isServiceAnimal": "1",
- "gender": "Male",
- "dateTimeCreated": "2026-11-12 07:38:05",
- "petScreeningAnimalID": "88123"
}
}Removes a pet from the lease for good and returns the removed pet as it was, without the pet wrapper the GET
uses.
Leasing › UpdateLease); without it the request is refused with
{"error": "Permission Denied"}.Lease {leaseID}: Access Denied for a lease whose property is
outside those groups' portfolios.leasePetID with no pet, or a pet of another lease, answers 400 {"error": "Pet {leasePetID} not found"}; a
value that isn't a number answers the stock 404.GET /leases/{leaseID}/pets.Pet Removed entry, naming the pet's type and name, to the lease's history log.GET /leases/export (its lease.dateTimeModified, which that export reports
and filters on) with now and the API user. The lease record's own dateTimeModified, as GET /leases/{leaseID}
and the lease include send it, doesn't change.GET /leases/{leaseID}/pets - list the lease's remaining petsPOST /leases/{leaseID}/pets - add a pet| leaseID required | integer Example: 60 The pet's lease, from |
| leasePetID required | integer Example: 66 The pet to remove, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| leasePetID required | string^-?[0-9]+$ Unique identifier of the pet. |
| leaseID required | string^-?[0-9]+$ The lease the pet belongs to. |
| type required | string <= 100 characters Kind of animal, free text ( |
| name required | string or null <= 100 characters The pet's name. |
| age required | string or null^[0-9]+$ Age in whole years. |
| weight required | string or null <= 100 characters Weight, free text with its unit ( |
| isTrained required | string or null Enum: "0" "1" null Whether the pet is house-trained. |
| color required | string or null <= 100 characters Color, free text. |
| hasShots required | string or null^[0-9]+$ Whether the pet's vaccinations are current: |
| isNeutered required | string or null Enum: "0" "1" null Whether the pet is spayed or neutered. |
| isDeclawed required | string or null Enum: "0" "1" null Whether the pet is declawed. |
| isEmotionalSupportAnimal required | string or null Enum: "0" "1" null Whether the pet is an emotional support animal. |
| isServiceAnimal required | string or null Enum: "0" "1" null Whether the pet is a service animal. |
| gender required | string or null <= 100 characters Gender, free text. |
| dateTimeCreated required | string When the pet was added. UTC, formatted |
| petScreeningAnimalID required | string or null^-?[0-9]+$ The animal's ID at the pet-screening provider, set when the pet came from the applicant's pet screening or was
sent with the pet when the lease was created; |
{- "leasePetID": "110",
- "leaseID": "99",
- "type": "Dog",
- "name": "Biscuit",
- "age": "4",
- "weight": "45 lbs",
- "isTrained": "1",
- "color": "Brown",
- "hasShots": "1",
- "isNeutered": "1",
- "isDeclawed": "0",
- "isEmotionalSupportAnimal": "0",
- "isServiceAnimal": "1",
- "gender": "Male",
- "dateTimeCreated": "2026-11-12 07:38:07",
- "petScreeningAnimalID": "88123"
}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.
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.
leaseResidentPackage and
residentPackage both nullleaseResidentPackageStatusID 2POST /leases/{leaseID}/resident-package - Enroll the lease, or change its enrollmentGET /leases/{leaseID}/resident-services - The services active on the leaseGET /resident/packages/{residentPackageID} - The package in the catalog| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
{- "leaseResidentPackage": {
- "leaseResidentPackageID": "5",
- "leaseID": "213",
- "residentPackageID": "9",
- "leaseResidentPackageStatusID": "1",
- "leaseRecurringChargeID": "155",
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}, - "residentPackage": {
- "residentPackageID": "9",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Essentials Package",
- "recurringChargeAccountID": "123",
- "defaultRecurringChargeAmount": "22.45",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}
}Creates or updates the lease's one package enrollment in a single call — located by leaseID, no
enrollment id in the path. Not enrolled yet → enrolls the lease (opening the bundled recurring charge
and snapshotting the package's services as member entitlements); already enrolled → updates the same
row in place.
leaseResidentPackageStatusID)The enrollment is never deleted — it's turned off and back on via its status:
residentPackageID on an active enrollment) → re-prices the same bundled
charge to the new package and reconciles members: services in the new package are kept/added, services
dropped from the old package are cancelled (converted to cancelled à la carte).leaseResidentPackageStatusID = 2) → stops the bundled recurring charge and cancels the
member services.leaseResidentPackageStatusID = 1 on a cancelled enrollment) → resumes the bundled
charge and reactivates the members.400 otherwise) and be within the user's accessible portfolios.residentPackageID is always required (even for a status-only change) and must reference an existing,
active catalog package with at least one active service.leaseResidentPackageStatusID is optional — omit it to leave the current status unchanged.GET /leases/{leaseID}/resident-package and returns that shape.| leaseID required | integer Example: 995 |
| residentPackageID required | string or integer^-?[0-9]+$ The catalog package ( |
| leaseResidentPackageStatusID | string or integer Enum: "1" "2" 1 2 Enrollment status — |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
object A lease's REP (Resident Experience Package) enrollment — a row in | |
object A REP (Resident Experience Package) package — a PM-built bundle in |
{- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "2"
}{- "leaseResidentPackage": {
- "leaseResidentPackageID": "2",
- "leaseID": "995",
- "residentPackageID": "1",
- "leaseResidentPackageStatusID": "1",
- "leaseRecurringChargeID": "3020",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentPackage": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
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.
leaseResidentServiceID, oldest firstsalePrice, which GET /leases/{leaseID}/resident-services/{id}
returnsPOST /leases/{leaseID}/resident-services - Add a service to the lease on its ownGET /leases/{leaseID}/resident-services/{id} - One of the lease's servicesGET /leases/{leaseID}/resident-package - The lease's package enrollment| 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. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
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. |
[- {
- "leaseResidentService": {
- "leaseResidentServiceID": "49",
- "leaseID": "216",
- "residentPackageID": "10",
- "residentServiceID": "49",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": null,
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}, - "residentService": {
- "residentServiceID": "49",
- "serviceTypeID": "1",
- "name": "Package Locker Access",
- "description": "Around-the-clock access to the package lockers.",
- "recurringChargeDescription": "Package Locker Access",
- "recurringChargeAccountID": "124",
- "defaultRecurringChargeAmount": "45.19",
- "residentServiceStatusID": "1",
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}
}, - {
- "leaseResidentService": {
- "leaseResidentServiceID": "50",
- "leaseID": "216",
- "residentPackageID": null,
- "residentServiceID": "50",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "156",
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}, - "residentService": {
- "residentServiceID": "50",
- "serviceTypeID": "1",
- "name": "Bike Storage",
- "description": "A reserved space in the bike room.",
- "recurringChargeDescription": "Bike Storage",
- "recurringChargeAccountID": "124",
- "defaultRecurringChargeAmount": "11.29",
- "residentServiceStatusID": "1",
- "dateTimeCreated": "2026-11-16 18:54:13",
- "dateTimeModified": "2026-11-16 18:54:13"
}
}
]Adds a single à la carte REP service to the lease (lease_resident_services) — a standalone
service with its own recurring charge, separate from any package. This endpoint manages à la carte
services only; services provided by the lease's package are managed through the package.
404 otherwise) and be within the user's accessible portfolios.residentServiceID must reference an active catalog service (resident_services).400
("provided by the lease's package… cannot be added separately"). Manage it through the package instead.GET /leases/{leaseID}/resident-services/{id} and returns that shape.POST /leases/{leaseID}/resident-services/{id} — turn an à la carte service off / back on (status)POST /leases/{leaseID}/resident-package — manage the lease's package (and package-provided services)| leaseID required | integer Example: 995 |
| residentServiceID required | string or integer^-?[0-9]+$ ID of the catalog service ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
{- "residentServiceID": "3"
}{- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "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"
}
}Returns one Resident Experience Package (REP) service on the lease, with its full catalog service.
POST /leases/{leaseID}/resident-services/{id} - Turn the service off or back onGET /leases/{leaseID}/resident-services - Every service on the lease| 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 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (included_resident_service) A Resident Experience Package (REP) service in the account's catalog ( |
{- "leaseResidentService": {
- "leaseResidentServiceID": "189",
- "leaseID": "837",
- "residentPackageID": null,
- "residentServiceID": "189",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "540",
- "dateTimeCreated": "2026-11-16 19:17:23",
- "dateTimeModified": "2026-11-16 19:17:23"
}, - "residentService": {
- "residentServiceID": "189",
- "serviceTypeID": "1",
- "name": "Bike Storage",
- "description": "A reserved space in the bike room.",
- "recurringChargeDescription": "Bike Storage",
- "recurringChargeAccountID": "375",
- "defaultRecurringChargeAmount": "3.27",
- "salePrice": "0.00",
- "residentServiceStatusID": "1",
- "dateTimeCreated": "2026-11-16 19:17:23",
- "dateTimeModified": "2026-11-16 19:17:23"
}
}Updates an à la carte service entitlement. The only mutable field is its status — setting it to Cancelled turns the service off, setting it back to Active turns it on. The service reacts to the transition by adjusting the à la carte recurring charge.
leaseResidentServiceStatusID)2) → stops the service's recurring charge. A charge that has already started billing is
end-dated as of today (history kept); a charge that hasn't started yet is deleted.1) → resumes the charge (or mints a fresh one if the prior charge was deleted).404 otherwise).residentPackageID) cannot be modified here —
returns 400 ("part of a package and cannot be modified directly"). Manage it through the package.GET /leases/{leaseID}/resident-services/{id} and returns that shape.| leaseID required | integer Example: 995 |
| id required | integer Example: 7 The lease resident service (entitlement) id. |
| leaseResidentServiceStatusID required | string or integer Enum: "1" "2" 1 2 New status — |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (lease_resident_service) A lease's REP service entitlement — a row in |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
{- "leaseResidentServiceStatusID": "2"
}{- "leaseResidentService": {
- "leaseResidentServiceID": "7",
- "leaseID": "995",
- "residentPackageID": "1",
- "residentServiceID": "3",
- "leaseResidentServiceStatusID": "1",
- "leaseRecurringChargeID": "3021",
- "dateTimeCreated": "2026-06-27 02:42:45",
- "dateTimeModified": "2026-06-27 02:42:45"
}, - "residentService": {
- "residentServiceID": "3",
- "serviceTypeID": "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"
}
}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 a new work order. Requires the Manage Work Orders permission. On success, returns the full work order detail (same shape as GET /maintenance/work-orders/{workOrderID}).
workOrderTemplateIDpropertyID is required; unitID and leaseID are optionaltechnicianContactIDs assigns one or more technician contacts to the work ordersendVendorNotification is true and a vendor is assigned, a notification email is dispatchedworkOrderTemplateID pre-populates fields from an existing template when suppliedMM/DD/YYYY or ISO 8601 YYYY-MM-DD formatGET /maintenance/work-orders/{workOrderID} - Get the created work orderGET /maintenance/work-orders - List all work ordersPOST /maintenance/work-orders/{workOrderID} - Update a work order| propertyID required | string or integer^-?[0-9]+$ Property the work order is attached to |
| workOrderStatusID required | string or integer^-?[0-9]+$ Initial status ID for the work order |
| priorityID required | string or integer^-?[0-9]+$
|
| isOwnerApproved required | string or integer Enum: "0" "1" 0 1 Whether the owner has approved the work order |
| isVacant required | string or integer Enum: "0" "1" 0 1 Whether the unit is vacant |
| description required | string Description of the maintenance issue (may contain HTML) |
| isSharedWithTenant required | string or integer Enum: "0" "1" 0 1
|
| isSharedWithOwner required | string or integer Enum: "0" "1" 0 1 Whether the work order is visible in the Owner Portal |
| unitID | string or integer or null^-?[0-9]+$ Unit the work order is attached to (null for property-level) |
| leaseID | string or integer or null^-?[0-9]+$ Lease associated with the work order |
| isInternal | string or integer Enum: "0" "1" 0 1
|
| vendorWorkOrderStatusID | string or integer or null^-?[0-9]+$ Vendor-specific status ID |
| vendorContactID | string or integer or null^-?[0-9]+$ Vendor contact ID to assign to the work order |
| vendorTradeID | string or integer or null^-?[0-9]+$ Vendor trade / maintenance category ID |
| assignedToUserID | string or integer or null^-?[0-9]+$ Internal user ID to assign to the work order |
| requestedByContactID | string or integer or null^-?[0-9]+$ Contact ID of the person who requested the work |
| technicianContactIDs | Array of strings One or more contact IDs to assign as technicians |
| estimatedAmount | string or number or null <decimal> Estimated cost as a decimal string (e.g. |
| scheduledStartDate | string or null Scheduled start date ( |
| scheduledEndDate | string or null Scheduled end date ( |
| actualStartDate | string or null <date> |
| actualEndDate | string or null <date> |
| dateDue | string or null Due date ( |
| dateClosed | string or null <date> |
| vendorInstructions | string or null HTML instructions for the assigned vendor |
| entryInstructions | string or null Entry instructions for the vendor |
| residentProvidedEntryInstructions | string or null |
| closingDescription | string or null |
| vendorAccessTypeID | string or integer or null^-?[0-9]+$
|
| appointmentWindowStartDateTime | string or null Date and time in UTC, formatted |
| appointmentWindowEndDateTime | string or null Date and time in UTC, formatted |
| inspectionID | string or integer or null^-?[0-9]+$ |
| incidentLocation | string or null |
| workOrderProjectID | string or integer or null^-?[0-9]+$ Project ID to attach this work order to |
| workOrderTemplateID | string or integer or null^-?[0-9]+$ Template ID to pre-populate work order fields |
| orderIndex | string or integer or null^-?[0-9]+$ |
| sourceTypeID | string or integer or null^-?[0-9]+$ |
| isTenantFinanciallyResponsible | string or integer or null Enum: "0" "1" 0 1 null
|
| sendVendorNotification | boolean Default: true Whether to send a notification email to the assigned vendor |
| sendEmail | boolean or null Whether to send an email notification (separate from vendor notification) |
object or null Custom email content for the vendor notification | |
| attachments | Array of integers File IDs to attach to the work order |
| issueImages | Array of integers File IDs to attach as issue images (shared with vendor) |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (work_order) |
| schedulingStatusID required | integer or null |
{- "propertyID": "172",
- "unitID": null,
- "leaseID": null,
- "isInternal": "0",
- "isVacant": "0",
- "description": "Leaky faucet in kitchen",
- "priorityID": "2",
- "workOrderStatusID": "1",
- "isOwnerApproved": "0",
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "vendorContactID": "5150",
- "vendorTradeID": "5",
- "vendorInstructions": "<p>Call tenant before arriving.</p>",
- "technicianContactIDs": [
- "5150"
], - "sendVendorNotification": true,
- "vendorAccessTypeID": "1",
- "attachments": [ ],
- "issueImages": [ ]
}{- "workOrder": {
- "workOrderID": "5960",
- "workOrderNumber": "105787",
- "workOrderProjectID": "156",
- "recurringWorkOrderID": null,
- "isInternal": "1",
- "propertyID": "172",
- "unitID": null,
- "leaseID": null,
- "vendorContactID": "5150",
- "primaryWorkOrderStatusID": "2",
- "workOrderStatusID": "1",
- "vendorWorkOrderStatusID": "1",
- "portalVendorWorkOrderStatusID": "1",
- "vendorWorkOrderStatusUpdated": null,
- "priorityID": "1",
- "sourceTypeID": null,
- "isOwnerApproved": "1",
- "isVacant": "1",
- "description": "Clean carpet",
- "diagnosticSummary": null,
- "aiSessionID": null,
- "isResolvedByRequestor": "0",
- "vendorInstructions": "<p>Instructions</p>",
- "dateClosed": null,
- "closingDescription": null,
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "isNew": "1",
- "createdByUserID": "1",
- "closedByUserID": null,
- "cancelledByUserID": null,
- "dateTimeCreated": "2026-04-26 10:00:00",
- "modifiedByUserID": "501195",
- "dateTimeModified": "2026-04-26 10:00:01",
- "inspectionID": null,
- "incidentLocation": null,
- "appointmentWindowStartDateTime": null,
- "appointmentWindowEndDateTime": null,
- "isTenantPresenceRequired": "0",
- "rejectedByVendorContactID": null,
- "vendorRejectReason": null,
- "vendorClosingComments": null,
- "orderIndex": "0",
- "dateDue": "2026-04-30",
- "reviewID": null,
- "vendorAccessTypeID": "3",
- "residentProvidedEntryInstructions": null,
- "entryInstructions": null,
- "isTenantFinanciallyResponsible": "0",
- "portfolioID": "85",
- "vendorTradeID": "5",
- "assignedToUserID": "501195",
- "requestedByContactID": null,
- "estimatedAmount": "12.00",
- "scheduledStartDate": "2026-04-26",
- "actualStartDate": null,
- "scheduledEndDate": "2026-04-28",
- "actualEndDate": null,
- "daysOverdue": 0,
- "isOverdue": 0,
- "technicianContactIDs": [
- 5150
], - "technicianData": [
- {
- "technicianID": 5150,
- "name": "ABC Plumbing",
- "phone": "+15551234567",
- "contactTypeID": 3,
- "appointmentWindowStartDateTime": null,
- "appointmentWindowEndDateTime": null
}
]
}, - "schedulingStatusID": 1
}Returns a page of work orders, newest first, each with its assigned vendor contact.
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.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.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.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 orderGET /maintenance/work-orders/search - Search work orders with more filtersGET /maintenance/work-order/statuses - The values of workOrderStatusID| 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 |
| unitID | integer Example: unitID=383 Returns the work orders of this unit, from |
| workOrderStatusID | integer Example: workOrderStatusID=4 Returns the work orders in this status, from |
| isOwnerApproved | string Example: isOwnerApproved=1
|
| vendorContactID | integer Example: vendorContactID=522 Returns the work orders assigned to this contact ( |
| startDate | string Example: startDate=2026-02-27 Returns the work orders created on or after this date ( |
| endDate | string Example: endDate=2026-02-27 Leaves out the work orders created after this date ( |
| leaseID | integer Example: leaseID=184 Returns the work orders of this lease, from |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
[- {
- "workOrder": {
- "workOrderID": "1074",
- "workOrderNumber": "100001",
- "workOrderProjectID": "61",
- "recurringWorkOrderID": "73",
- "isInternal": "0",
- "propertyID": "993",
- "unitID": "383",
- "leaseID": "184",
- "portfolioID": "1458",
- "vendorTradeID": "131",
- "vendorContactID": "522",
- "primaryWorkOrderStatusID": "1",
- "workOrderStatusID": "4",
- "vendorWorkOrderStatusID": "1",
- "portalVendorWorkOrderStatusID": "1",
- "vendorWorkOrderStatusUpdated": null,
- "priorityID": "3",
- "sourceTypeID": "1",
- "isOwnerApproved": "1",
- "isVacant": "0",
- "assignedToUserID": "763",
- "requestedByContactID": "520",
- "estimatedAmount": "450.00",
- "scheduledStartDate": "2026-03-02",
- "actualStartDate": "2026-03-02",
- "scheduledEndDate": "2026-03-04",
- "actualEndDate": "2026-03-03",
- "description": "Kitchen sink is leaking",
- "diagnosticSummary": {
- "summary": {
- "issue_description": {
- "summary": "Kitchen sink is leaking"
}
}, - "narrative": "The tenant reports a slow leak under the kitchen sink.",
- "agent_type": "maintenance",
- "session_id": "3f1c2a7e-5b0d-4c6e-9a51-2d8b7e4f6a10",
- "message_count": 6,
- "processing_time_seconds": 2.4
}, - "agentSummary": "The tenant reports a slow leak under the kitchen sink.",
- "aiSessionID": "3f1c2a7e-5b0d-4c6e-9a51-2d8b7e4f6a10",
- "isResolvedByRequestor": "0",
- "vendorInstructions": "Call the tenant before arriving",
- "dateClosed": null,
- "closingDescription": null,
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "isNew": "1",
- "createdByUserID": "1",
- "closedByUserID": null,
- "cancelledByUserID": null,
- "dateTimeCreated": "2026-02-27 15:04:11",
- "modifiedByUserID": "1",
- "dateTimeModified": "2026-03-06 18:22:40",
- "inspectionID": "266",
- "incidentLocation": "Kitchen",
- "appointmentWindowStartDateTime": "2026-03-02 14:00:00",
- "appointmentWindowEndDateTime": "2026-03-02 16:00:00",
- "isTenantPresenceRequired": "0",
- "rejectedByVendorContactID": null,
- "vendorRejectReason": null,
- "vendorClosingComments": null,
- "orderIndex": "0",
- "dateDue": "2026-03-05",
- "reviewID": null,
- "vendorAccessTypeID": "3",
- "residentProvidedEntryInstructions": "Dog in the yard",
- "entryInstructions": "Lockbox on the back door",
- "isTenantFinanciallyResponsible": "0",
- "workOrderTypeID": "85"
}, - "contact": {
- "contactID": "522",
- "contactTypeID": "3",
- "vendorTypeID": "58",
- "code": "C-6afb5c69aafa6",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "CT",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "49",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Doe Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Doe, Jane",
- "invoiceAutofillTemplateID": "49",
- "dateTimeCreated": "2026-11-16 19:41:29",
- "dateTimeModified": "2026-11-16 19:41:29",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}
}
]Returns a filtered page of work orders, each row denormalized: the workOrder (with its days open and overdue, the amounts billed and paid on its bills, its image counts and its technicians), its workOrderStatus, workOrderType, portfolio, property and unit, its vendorContact and requestedByContact, its vendorTrade and its propertyGroup names.
Unlike GET /maintenance/work-orders, it filters on when a work order last changed (dateTimeModifiedMin, dateTimeModifiedMax), which is how an integration pulls only the work orders that changed since its last sync.
This reference covers paging, sorting, the modified-date filters and the filters documented below, which GET /maintenance/work-orders also takes. The endpoint reads more filters and an include that aren't documented here yet.
dateTimeModifiedMin (YYYY-MM-DD), sort by workOrder.dateTimeModified|desc, and ask for page 1, 2, 3 and so on until a page comes back with fewer rows than pageSize. Keep each work order once, by workOrderID, then store the start time for the next sync.dateTimeModified to the current UTC time. Changes stored in other records don't, although this search returns their values: a bill on the work order changes amountBilled and a rename of its vendor changes vendorContact.name while dateTimeModified stays put, and the same goes for the joined property, unit, requester, status, type and trade records and the image counts. A sync keyed on dateTimeModified misses those until the work order itself is next saved.dateTimeModified. Sorted by workOrder.dateTimeModified|desc, a work order saved while you page moves to the front, ahead of the rows you haven't read: the rows behind it shift back, so you may read one twice but never skip one, and the saved work order comes back in the next sync, whose dateTimeModifiedMin covers the time it was saved. Sorted any other way, a save can move a row you've read behind you and push one you haven't across a page boundary, where you skip it. A work order deleted while you page shifts the rows behind it forward and can do the same.dateTimeModifiedMin and dateTimeModifiedMax take a date (YYYY-MM-DD), read as midnight UTC. A sync bounded by the date of its last run gets back the work orders changed earlier that day too; keep each once by workOrderID.workOrderStatusID, startDate and endDate, which GET /maintenance/work-orders takes, aren't read here: sent to this endpoint they're ignored and the list isn't filtered by them.1/0/true/false/yes/no in any letter case, an ID that isn't a number).pagination-page-size reports the page size or the number that match, whichever is smaller. A pageSize of 0 or below, or one with no digit in it, is read as 15.pagination-total-items is 0.page and pageSize keep only their digits: 10abc is read as 10, 3.4 as 34 and 1e2 as 12. Send whole numbers.orderBy (default workOrder.dateTimeCreated|desc, newest first), then workOrderID ascending.null.dateTimeModifiedMin[]=2026-01-01) fails with a 500.GET /maintenance/work-orders - the plain work order list, without the modified-date filtersGET /maintenance/work-orders/{workOrderID} - one work order, with includesGET /properties - property IDs for propertyIDGET /leases - lease IDs for leaseIDGET /vendors - vendor contact IDs for vendorContactID| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=100 Items per page (default 25). No cap today; a cap is planned, so don't rely on very large pages. |
| orderBy | string Example: orderBy=workOrder.dateTimeModified|desc Sort column, optionally followed by Columns: |
| dateTimeModifiedMin | string <date> Example: dateTimeModifiedMin=2026-01-01 Only work orders last modified on or after midnight UTC of this date ( |
| dateTimeModifiedMax | string <date> Example: dateTimeModifiedMax=2026-01-31 Only work orders last modified on or before midnight UTC of this date ( |
| search | string Example: search=leak Case-insensitive substring match on the work order's number, description, vendor instructions, closing description and incident location, the vendor's name, the property's name, address and city, the unit's name, address and address 2, and the names of an internal work order's technicians; matches the property's state and postal code exactly. |
| propertyID | integer Example: propertyID=30 Only this property's work orders (from |
| unitID | integer Example: unitID=15 Only this unit's work orders (unit IDs from |
| leaseID | integer Example: leaseID=9 Only the work orders linked to this lease (from |
| vendorContactID | integer Example: vendorContactID=18 Only the work orders assigned to this vendor (from |
| isOwnerApproved | string Example: isOwnerApproved=1
|
| isNew | string Example: isNew=1
|
| pagination-page-size | integer Example: "2" When some work orders match, the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The work order, with values the search computes. |
required | object The work order's status. |
required | object The work order's type. Every key is |
required | object The portfolio the work order belongs to. |
required | object The work order's property. |
required | object The work order's unit. Every key is |
required | object (work_order_search_contact) A contact on a work order search row, its vendor ( |
required | object (work_order_search_contact) A contact on a work order search row, its vendor ( |
required | object The work order's vendor trade (maintenance category). Every key is |
required | object The property groups the work order's property is in. |
[- {
- "workOrder": {
- "workOrderID": "1087",
- "workOrderNumber": "100001",
- "workOrderStatusID": "4",
- "vendorWorkOrderStatusID": "1",
- "portalVendorWorkOrderStatusID": "1",
- "isOwnerApproved": "1",
- "description": "Kitchen sink is leaking",
- "diagnosticSummary": "{\"summary\": {\"issue_description\": {\"summary\": \"Kitchen sink is leaking\"}}}",
- "agentSummary": "The tenant reports a slow leak under the kitchen sink.",
- "vendorContactID": "395",
- "vendorInstructions": "Call the tenant before arriving",
- "dateTimeCreated": "2026-02-27 15:04:11",
- "dateClosed": null,
- "vendorTradeID": "44",
- "propertyID": "1011",
- "portfolioID": "1202",
- "unitID": "601",
- "leaseID": "329",
- "priorityID": "3",
- "sourceTypeID": "1",
- "isVacant": "0",
- "requestedByContactID": "393",
- "estimatedAmount": "450.00",
- "scheduledStartDate": "2026-03-02",
- "actualStartDate": "2026-03-02",
- "scheduledEndDate": "2026-03-04",
- "actualEndDate": "2026-03-03",
- "dateDue": "2026-03-05",
- "closingDescription": null,
- "dateTimeModified": "2026-03-06 18:22:40",
- "assignedToUserID": "2",
- "assignedToUserName": "Pat Manager",
- "isTenantFinanciallyResponsible": "0",
- "orderIndex": "0",
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "isNew": "1",
- "appointmentWindowStartDateTime": "2026-03-02 14:00:00",
- "appointmentWindowEndDateTime": "2026-03-02 16:00:00",
- "isInternal": "0",
- "incidentLocation": "Kitchen",
- "isResolvedByRequestor": "0",
- "daysOpen": "260",
- "daysOverdue": "254",
- "daysOverdueVendor": "254",
- "amountBilled": null,
- "amountPaid": null,
- "workOrderTypeID": "28",
- "issueImageCount": "0",
- "resolutionImageCount": "0",
- "technicianData": [
- {
- "technicianID": 395,
- "name": "Example Plumbing Co",
- "phone": "555-0101",
- "contactTypeID": 3,
- "appointmentWindowStartDateTime": "2026-03-02 14:00:00",
- "appointmentWindowEndDateTime": "2026-03-02 16:00:00"
}
]
}, - "workOrderStatus": {
- "workOrderStatusID": "4",
- "primaryWorkOrderStatusID": "1",
- "name": "Requested"
}, - "workOrderType": {
- "workOrderTypeID": "28",
- "systemWorkOrderTypeID": "1",
- "name": "Inspection Follow-up"
}, - "portfolio": {
- "portfolioID": "1202",
- "name": "Metz Ltd Portfolio"
}, - "property": {
- "propertyID": "1011",
- "name": "Example Property",
- "address": "123 Main St",
- "address2": "Suite 2",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "isMultiUnit": "0",
- "portfolioID": "1202"
}, - "unit": {
- "unitID": "601",
- "name": "Example Property",
- "address": "123 Main St",
- "address2": "Unit 1A",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000"
}, - "vendorContact": {
- "contactID": "395",
- "name": "Example Plumbing Co",
- "email": "service@example.com",
- "phone": "555-0101"
}, - "requestedByContact": {
- "contactID": "393",
- "name": "Pat Tenant",
- "email": "pat.tenant@example.com",
- "phone": "555-0100"
}, - "vendorTrade": {
- "vendorTradeID": "44",
- "name": "Plumbing"
}, - "propertyGroup": {
- "propertyGroupNames": "North Side"
}
}, - {
- "workOrder": {
- "workOrderID": "1088",
- "workOrderNumber": "100002",
- "workOrderStatusID": "2",
- "vendorWorkOrderStatusID": "1",
- "portalVendorWorkOrderStatusID": "3",
- "isOwnerApproved": "0",
- "description": "Replace the furnace filter",
- "diagnosticSummary": null,
- "agentSummary": null,
- "vendorContactID": null,
- "vendorInstructions": null,
- "dateTimeCreated": "2026-02-27 15:04:11",
- "dateClosed": "2026-03-06",
- "vendorTradeID": null,
- "propertyID": "1011",
- "portfolioID": "1202",
- "unitID": "601",
- "leaseID": null,
- "priorityID": "2",
- "sourceTypeID": null,
- "isVacant": "1",
- "requestedByContactID": null,
- "estimatedAmount": null,
- "scheduledStartDate": null,
- "actualStartDate": null,
- "scheduledEndDate": null,
- "actualEndDate": null,
- "dateDue": "2026-03-07",
- "closingDescription": "Filter replaced",
- "dateTimeModified": "2026-03-06 18:22:40",
- "assignedToUserID": null,
- "assignedToUserName": null,
- "isTenantFinanciallyResponsible": "0",
- "orderIndex": "0",
- "isSharedWithTenant": "0",
- "isSharedWithOwner": "0",
- "isNew": "1",
- "appointmentWindowStartDateTime": "2026-03-05 09:00:00",
- "appointmentWindowEndDateTime": "2026-03-05 11:00:00",
- "isInternal": "1",
- "incidentLocation": null,
- "isResolvedByRequestor": "0",
- "daysOpen": "7",
- "daysOverdue": null,
- "daysOverdueVendor": null,
- "amountBilled": "125.50",
- "amountPaid": "25.50",
- "workOrderTypeID": "1",
- "issueImageCount": "0",
- "resolutionImageCount": "0",
- "technicianData": [
- {
- "technicianID": 396,
- "name": "Sam Technician",
- "phone": "555-0102",
- "contactTypeID": 8,
- "appointmentWindowStartDateTime": "2026-03-05 09:00:00",
- "appointmentWindowEndDateTime": "2026-03-05 11:00:00"
}
]
}, - "workOrderStatus": {
- "workOrderStatusID": "2",
- "primaryWorkOrderStatusID": "3",
- "name": "Completed"
}, - "workOrderType": {
- "workOrderTypeID": "1",
- "systemWorkOrderTypeID": "2",
- "name": "Service Request"
}, - "portfolio": {
- "portfolioID": "1202",
- "name": "Metz Ltd Portfolio"
}, - "property": {
- "propertyID": "1011",
- "name": "Example Property",
- "address": "123 Main St",
- "address2": "Suite 2",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "isMultiUnit": "0",
- "portfolioID": "1202"
}, - "unit": {
- "unitID": "601",
- "name": "Example Property",
- "address": "123 Main St",
- "address2": "Unit 1A",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000"
}, - "vendorContact": {
- "contactID": null,
- "name": null,
- "email": null,
- "phone": null
}, - "requestedByContact": {
- "contactID": null,
- "name": null,
- "email": null,
- "phone": null
}, - "vendorTrade": {
- "vendorTradeID": null,
- "name": null
}, - "propertyGroup": {
- "propertyGroupNames": "North Side"
}
}
]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.
403 (Work Order Access Not Allowed) for a work order outside its portfolios.400 with Work Order {workOrderID} not found.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 ordersGET /maintenance/work-orders/{workOrderID}/print - The work order as a PDFPOST /maintenance/work-orders/{workOrderID} - Update the work order| workOrderID required | integer Example: 1116 The work order ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (work_order_detail) A work order as |
| schedulingStatusID required | integer Enum: 1 2 3 4 Where scheduling the work stands (a JSON number):
|
{- "workOrder": {
- "workOrderID": "1116",
- "workOrderNumber": "100001",
- "workOrderProjectID": "75",
- "recurringWorkOrderID": "87",
- "isInternal": "0",
- "propertyID": "1014",
- "unitID": "399",
- "leaseID": "198",
- "portfolioID": "1479",
- "vendorTradeID": "145",
- "vendorContactID": "578",
- "primaryWorkOrderStatusID": "1",
- "workOrderStatusID": "4",
- "vendorWorkOrderStatusID": "1",
- "portalVendorWorkOrderStatusID": "1",
- "vendorWorkOrderStatusUpdated": null,
- "priorityID": "3",
- "sourceTypeID": "1",
- "isOwnerApproved": "1",
- "isVacant": "0",
- "assignedToUserID": "797",
- "requestedByContactID": "576",
- "estimatedAmount": "450.00",
- "scheduledStartDate": "2026-03-02",
- "actualStartDate": "2026-03-02",
- "scheduledEndDate": "2026-03-04",
- "actualEndDate": "2026-03-03",
- "description": "Kitchen sink is leaking",
- "diagnosticSummary": {
- "summary": {
- "issue_description": {
- "summary": "Kitchen sink is leaking"
}
}, - "narrative": "The tenant reports a slow leak under the kitchen sink.",
- "agent_type": "maintenance",
- "session_id": "3f1c2a7e-5b0d-4c6e-9a51-2d8b7e4f6a10",
- "message_count": 6,
- "processing_time_seconds": 2.4
}, - "agentSummary": "The tenant reports a slow leak under the kitchen sink.",
- "aiSessionID": "3f1c2a7e-5b0d-4c6e-9a51-2d8b7e4f6a10",
- "isResolvedByRequestor": "0",
- "vendorInstructions": "Call the tenant before arriving",
- "dateClosed": null,
- "closingDescription": null,
- "isSharedWithTenant": "1",
- "isSharedWithOwner": "1",
- "isNew": "1",
- "createdByUserID": "1",
- "closedByUserID": null,
- "cancelledByUserID": null,
- "dateTimeCreated": "2026-02-27 15:04:11",
- "modifiedByUserID": "1",
- "dateTimeModified": "2026-03-06 18:22:40",
- "inspectionID": "280",
- "incidentLocation": "Kitchen",
- "appointmentWindowStartDateTime": "2026-03-02 14:00:00",
- "appointmentWindowEndDateTime": "2026-03-02 16:00:00",
- "isTenantPresenceRequired": "0",
- "rejectedByVendorContactID": null,
- "vendorRejectReason": null,
- "vendorClosingComments": null,
- "orderIndex": "0",
- "dateDue": "2026-03-05",
- "reviewID": null,
- "vendorAccessTypeID": "3",
- "residentProvidedEntryInstructions": "Dog in the yard",
- "entryInstructions": "Lockbox on the back door",
- "isTenantFinanciallyResponsible": "0",
- "workOrderTypeID": "99",
- "daysOverdue": 256,
- "isOverdue": 1,
- "technicianContactIDs": [ ],
- "technicianData": [
- {
- "technicianID": 578,
- "name": "Jane Doe",
- "phone": "555-0100",
- "contactTypeID": 3,
- "appointmentWindowStartDateTime": "2026-03-02 14:00:00",
- "appointmentWindowEndDateTime": "2026-03-02 16:00:00"
}
]
}, - "schedulingStatusID": 4
}Update an existing work order. Supports updating all work order fields including status, assignment, scheduling, and shared visibility settings.
GET /maintenance/work-orders/{workOrderID} - View work orderDELETE /maintenance/work-orders/{workOrderID} - Delete work order| workOrderID required | integer Example: 12345 The unique work order ID to update |
| isInternal | string or integer Enum: "0" "1" 0 1 Internal work order flag (0=no, 1=yes) |
| propertyID | string or integer^-?[0-9]+$ Property ID |
| unitID | string or integer or null^-?[0-9]+$ Unit ID (null for property-level) |
| leaseID | string or integer or null^-?[0-9]+$ Associated lease ID |
| vendorTradeID | string or integer or null^-?[0-9]+$ Vendor trade/specialty |
| vendorContactID | string or integer or null^-?[0-9]+$ Assigned vendor contact ID |
| workOrderStatusID | string or integer^-?[0-9]+$ Work order status |
| vendorWorkOrderStatusID | string or integer or null^-?[0-9]+$ Vendor-specific status |
| priorityID | string or integer^-?[0-9]+$ Priority (1=Low, 2=Normal, 3=High, 4=Emergency) |
| sourceTypeID | string or integer^-?[0-9]+$ Work order source/origin |
| isOwnerApproved | string or integer Enum: "0" "1" 0 1 Owner approval (0=pending, 1=approved) |
| isVacant | string or integer Enum: "0" "1" 0 1 Vacant unit flag |
| assignedToUserID | string or integer or null^-?[0-9]+$ Assigned internal user |
| requestedByContactID | string or integer or null^-?[0-9]+$ Contact who requested work |
| estimatedAmount | string or number or null <decimal> Estimated cost |
| scheduledStartDate | string or null <date> Scheduled start date |
| actualStartDate | string or null <date> Actual start date |
| scheduledEndDate | string or null <date> Scheduled end date |
| actualEndDate | string or null <date> Actual end date |
| dateDue | string or null <date> Due date |
| dateClosed | string or null <date> Closed date |
| description | string Work order description/issue |
| vendorInstructions | string or null Instructions for vendor |
| closingDescription | string or null Closing notes/resolution |
| isSharedWithOwner | string or integer Enum: "0" "1" 0 1 Share with owner portal (0=no, 1=yes) |
| isSharedWithTenant | string or integer Enum: "0" "1" 0 1 Share with resident portal (0=no, 1=yes) |
| inspectionID | string or integer or null^-?[0-9]+$ Related inspection ID |
| incidentLocation | string or null Location within property |
| workOrderProjectID | string or integer or null^-?[0-9]+$ Parent project ID |
| orderIndex | string or integer^-?[0-9]+$ Display order |
| vendorAccessTypeID | string or integer or null^-?[0-9]+$ Access type for vendor |
| residentProvidedEntryInstructions | string or null Entry instructions from tenant |
| entryInstructions | string or null Entry instructions for vendor |
| isTenantFinanciallyResponsible | string or integer Enum: "0" "1" 0 1 Tenant pays for work (0=no, 1=yes) |
| appointmentWindowStartDateTime | string or null Appointment window start. UTC, formatted |
| appointmentWindowEndDateTime | string or null Appointment window end. UTC, formatted |
| sendVendorNotification | boolean Default: true Send notification to vendor on changes |
| sendReview | boolean Default: false Send review request on completion |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| workOrder | object Updated work order details (same structure as GET response) |
{- "workOrderStatusID": 2,
- "sendVendorNotification": false
}{- "workOrder": {
- "workOrderID": 12345,
- "workOrderNumber": "WO-2024-12345",
- "workOrderStatusID": 2,
- "priorityID": 4,
- "description": "Kitchen sink is leaking under the cabinet - URGENT: Water damage spreading",
- "dateTimeModified": "2024-10-23 10:30:00"
}
}Delete a work order. This operation removes the work order and all associated data including attachments, messages, and timeline events.
GET /maintenance/work-orders/{workOrderID} - View work orderGET /maintenance/work-orders - View work orders| workOrderID required | string Example: 12345 The unique work order ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| workOrderID | string^-?[0-9]+$ |
| workOrderNumber | string^-?[0-9]+$ |
| description | string |
| dateTimeCreated | string Date and time in UTC, formatted |
| dateTimeModified | string Date and time in UTC, formatted |
{- "workOrderID": "12345",
- "workOrderNumber": "WO-2024-12345",
- "description": "Kitchen sink is leaking under the cabinet",
- "dateTimeCreated": "2024-10-23 08:30:00",
- "dateTimeModified": "2024-10-23 09:15:00"
}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.
403 (Access Denied) for a work order outside its portfolios.400 with Work Order not found.404.GET /maintenance/work-orders/{workOrderID} - The work order as JSON| workOrderID required | integer Example: 1116 The work order ID, from |
| Cache-Control | string Example: "no-cache" Always |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "error": "Work Order not found"
}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.
| primaryWorkOrderStatusID required | string or integer (primary_statuses_request) Enum: "1" "2" "3" "4" "5" 1 2 3 4 5
|
| name required | string The name of the status |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| workOrderStatusID required | string^-?[0-9]+$ Unique identifier. |
| primaryWorkOrderStatusID required | string (primary_statuses) Enum: "1" "2" "3" "4" "5"
|
| isSystemStatus required | string Enum: "0" "1"
|
| 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. |
{- "primaryWorkOrderStatusID": "1",
- "name": "string"
}{- "workOrderStatusID": "5",
- "primaryWorkOrderStatusID": "1",
- "isSystemStatus": "1",
- "name": "On Hold",
- "orderIndex": "5"
}Returns every work-order status in the account, system and custom, in one response sorted by orderIndex.
workOrderStatusID values a work order can carry, and the primary status each belongs toisSystemStatus=0)page or pageSize, and the pagination headers always describe page 1.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 statusGET /maintenance/work-orders - List work orders, filterable by workOrderStatusID| search | string Example: search=Hold Returns the statuses whose name contains this text. |
| isSystemStatus | string Example: isSystemStatus=0
|
| 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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (work_order_status) A work-order status: the label a work order carries ( |
[- {
- "workOrderStatus": {
- "workOrderStatusID": "1",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "1",
- "name": "Open",
- "orderIndex": "1"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "2",
- "primaryWorkOrderStatusID": "3",
- "isSystemStatus": "1",
- "name": "Completed",
- "orderIndex": "2"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "3",
- "primaryWorkOrderStatusID": "5",
- "isSystemStatus": "1",
- "name": "Cancelled",
- "orderIndex": "3"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "4",
- "primaryWorkOrderStatusID": "1",
- "isSystemStatus": "1",
- "name": "Requested",
- "orderIndex": "4"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "5",
- "primaryWorkOrderStatusID": "4",
- "isSystemStatus": "1",
- "name": "On Hold",
- "orderIndex": "5"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "6",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "1",
- "name": "Estimating",
- "orderIndex": "6"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "7",
- "primaryWorkOrderStatusID": "3",
- "isSystemStatus": "1",
- "name": "Rejected",
- "orderIndex": "7"
}
}, - {
- "workOrderStatus": {
- "workOrderStatusID": "10",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "0",
- "name": "Waiting On Parts",
- "orderIndex": "900"
}
}
]Returns one work-order status, system or custom.
workOrderStatusID a work order carries400 with Work Order Status {workOrderStatusID} not found.404.GET /maintenance/work-order/statuses - List every status| workOrderStatusID required | integer Example: 5 The status ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (work_order_status) A work-order status: the label a work order carries ( |
{- "workOrderStatus": {
- "workOrderStatusID": "18",
- "primaryWorkOrderStatusID": "4",
- "isSystemStatus": "0",
- "name": "Waiting On Parts",
- "orderIndex": "7"
}
}Delete a custom work order status. Only custom statuses (those with isSystemStatus = 0) can be deleted; system statuses are protected.
Manage Work Order Statuses permission400 with "Work Order Status {id} not found" if the status does not existisSystemStatus = 1) cannot be deleted via this endpointGET /maintenance/work-order/statuses - List all statusesGET /maintenance/work-order/statuses/{workOrderStatusID} - Get a status by ID| workOrderStatusID required | integer Example: 9 The unique work order status ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| workOrderStatusID required | string^-?[0-9]+$ |
| primaryWorkOrderStatusID required | string^-?[0-9]+$ |
| isSystemStatus required | string Enum: "0" "1" |
| name required | string |
| orderIndex required | string^-?[0-9]+$ |
{- "workOrderStatusID": "9",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "0",
- "name": "Tech Completed",
- "orderIndex": "1"
}Update an existing custom work order status by ID.
400 with "Work Order Status {id} not found" if the status does not existworkOrderStatusprimaryWorkOrderStatusID cannot be modifiedGET /maintenance/work-order/statuses/{workOrderStatusID} - Get status by IDDELETE /maintenance/work-order/statuses/{workOrderStatusID} - Delete a custom statusGET /maintenance/work-order/statuses - List all statuses| workOrderStatusID required | integer Example: 9 The unique work order status ID to update |
| name required | string Display name for the custom status |
| primaryWorkOrderStatusID required | string or integer Enum: "1" "2" "3" "4" "5" 1 2 3 4 5 The primary status group this custom status belongs to.
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (work_order_status) A work-order status: the label a work order carries ( |
{- "name": "Tech Completed",
- "primaryWorkOrderStatusID": 2
}{- "workOrderStatus": {
- "workOrderStatusID": "9",
- "primaryWorkOrderStatusID": "2",
- "isSystemStatus": "0",
- "name": "Tech Completed",
- "orderIndex": "1"
}
}Trades are the maintenance categories, such as plumbing or HVAC, that classify work orders and vendors. List, create, read and update them.
| name required | string Name of the vendor trade |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Indicates whether the trade is visible to the resident when they are creating work orders. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| vendorTradeID required | string^-?[0-9]+$ Unique identifier. |
| name required | string <= 500 characters Name of the vendor trade |
| isVisibleTenantPortal required | string Enum: "0" "1"
|
{- "name": "string",
- "isVisibleTenantPortal": "0"
}{- "vendorTradeID": "string",
- "name": "string",
- "isVisibleTenantPortal": "0"
}Returns every vendor trade (maintenance category) in the account, sorted by name, in one unpaginated array.
vendorTradeID to file a work order under, or to filter vendors byisVisibleTenantPortal 0) are listed too.search matches any part of the name.GET /maintenance/vendor-trades/{vendorTradeID} - Get one trade, with its vendors| search | string Example: search=Plumb Returns the trades whose name contains this text. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
| 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. |
[- {
- "vendorTrade": {
- "vendorTradeID": "2",
- "name": "Appliances",
- "isVisibleTenantPortal": "1"
}, - "token": "1794856794"
}, - {
- "vendorTrade": {
- "vendorTradeID": "3",
- "name": "Building Improvements",
- "isVisibleTenantPortal": "1"
}, - "token": "1794856794"
}, - {
- "vendorTrade": {
- "vendorTradeID": "5",
- "name": "Cleaning Service",
- "isVisibleTenantPortal": "1"
}, - "token": "1794856794"
}
]Returns one vendor trade (a maintenance category) by ID, and with includes=vendors every contact linked to it.
vendors includevendors include lists every contact linked to the trade, vendors and maintenance technicians alike, active or not, ordered by contactID.400 with Maintenance Category {vendorTradeID} not found.404, except a word that is another route's (search), which that route answers instead.vendors - Every contact linked to the trade: the link (contactVendorTrade) and the contact's record (contact); an empty array when none isGET /maintenance/vendor-trades - List all vendor tradesGET /vendors/{contactID} - Get one of the vendorsPOST /maintenance/vendor-trades/{vendorTradeID} - Update a vendor trade| vendorTradeID required | integer Example: 84 The trade ID, from |
| includes | string Example: includes=vendors Comma-separated related records to add, with no spaces. Available value, |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
Array of objects Every contact linked to the trade, ordered by |
{- "vendorTrade": {
- "vendorTradeID": "84",
- "name": "Roofing",
- "isVisibleTenantPortal": "1"
}, - "vendors": [
- {
- "contactVendorTrade": {
- "contactVendorTradeID": "3",
- "vendorTradeID": "84",
- "contactID": "342"
}, - "contact": {
- "contactID": "342",
- "contactTypeID": "3",
- "vendorTypeID": "12",
- "code": "C-6afb5a20bcf45",
- "name": "Jane Doe",
- "firstName": null,
- "middleName": null,
- "lastName": null,
- "suffix": null,
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NC",
- "postalCode": "12345",
- "birthDate": "1990-01-01",
- "defaultBillChargeAccountID": "1",
- "payeeName": "Jane Doe",
- "taxPayerName": "Jane Doe",
- "taxFormTypeID": "1",
- "identificationTypeID": "1",
- "identificationNumber": "X0000000",
- "identificationCountryID": "US",
- "identificationIssuingLocation": "NC",
- "identificationExpirationDate": "2030-01-31",
- "payoutTypeID": "1",
- "otherPayoutTypeID": "1",
- "achDetailsCiphertextID": "3",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0",
- "holdPayments": "1",
- "liabilityInsuranceName": "Acme Insurance",
- "liabilityInsurancePolicyNumber": "L-1001",
- "liabilityInsuranceExpiresDate": "2030-06-30",
- "workersCompInsuranceName": "Acme Workers Comp",
- "workersCompInsurancePolicyNumber": "W-2002",
- "workersCompInsuranceExpiresDate": "2030-07-31",
- "discountPercent": "2.5000",
- "discountAmount": null,
- "discountAmountMin": "1.00",
- "discountAmountMax": "50.00",
- "discountGraceDays": "10",
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": "12",
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "applicantID": null,
- "ownerPortalNameOverride": "Doe Holdings",
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "1",
- "isQuickbooksExportEnabled": "1",
- "quickbooksCustomerName": "Doe, Jane",
- "invoiceAutofillTemplateID": "3",
- "dateTimeCreated": "2026-11-16 19:31:44",
- "dateTimeModified": "2026-11-16 19:31:44",
- "dateTimeDeactivated": null,
- "contactType": "Vendor"
}
}
]
}Update an existing vendor trade (maintenance category). Requires the ManageMaintenanceCategories permission.
400 with "Maintenance Category {id} not found" if the trade does not existvendorTradeGET /maintenance/vendor-trades/{vendorTradeID} - Get vendor trade detailsDELETE /maintenance/vendor-trades/{vendorTradeID} (undocumented) - Delete a vendor tradeGET /maintenance/vendor-trades - List all vendor trades| vendorTradeID required | integer Example: 5 The unique vendor trade ID to update |
| name required | string Name of the vendor trade / maintenance category |
| isVisibleTenantPortal required | string or integer Enum: "0" "1" 0 1 Whether residents can select this trade when submitting work orders via the Resident Portal |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
{- "name": "Plumbing",
- "isVisibleTenantPortal": "1"
}{- "vendorTrade": {
- "vendorTradeID": "5",
- "name": "Plumbing",
- "isVisibleTenantPortal": "1"
}
}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.
| unitID required | string or integer (unit_id_required) ^-?[0-9]+$ The unique id of the Unit object. See the Unit API for more information. |
| inspectionTypeID required | string or integer (inspection_types_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| inspectionStatusID required | string or integer (inspection_statuses_request) Enum: "1" "2" "3" "4" 1 2 3 4
|
| description | string or null |
| scheduledDate | string or null <date> |
| inspectionDate | string or null <date> |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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"
|
| inspectionStatusID required | string (inspection_statuses) Enum: "1" "2" "3" "4"
|
| 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). |
{- "unitID": "string",
- "inspectionTypeID": "1",
- "inspectionStatusID": "1",
- "description": "string",
- "scheduledDate": "2019-08-24",
- "inspectionDate": "2019-08-24"
}{- "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"
}Returns a page of inspections, newest first, filterable by property, unit, lease, assignee, type and status.
dateTimeCreated is a date, so inspections created the same day have no fixed order between them.abc) is ignored, so the list comes back unfiltered by it, and 12abc reads as 12.property - The inspection's propertyunit - The inspected unitlease - The inspection's lease; every key null when it has noneGET /maintenance/inspections/{inspectionID} - Get one inspection, with its areas, items and photos| 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 |
| unitID | integer Example: unitID=311 Returns the inspections of this unit, from |
| leaseID | integer Example: leaseID=128 Returns the inspections of this lease, from |
| 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:
|
| inspectionStatusID | integer Enum: 1 2 3 4 Example: inspectionStatusID=4 Returns the inspections in this status:
|
| includes | string Example: includes=property,unit,lease Comma-separated related records to add to each row, with no spaces: |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object (included_unit) The inspected unit. Sent only with the | |
object (included_lease_left_joined) The inspection's lease, every key | |
| token | string^[0-9]+$ The time the list was read, as a Unix timestamp. Sent on each row when |
[- {
- "inspection": {
- "inspectionID": "185",
- "propertyID": "880",
- "unitID": "311",
- "leaseID": "128",
- "assignedToUserID": "586",
- "inspectionTypeID": "3",
- "inspectionStatusID": "4",
- "description": "Move-out walkthrough",
- "scheduledDate": "2026-10-01",
- "inspectionDate": "2026-10-02",
- "dateTimeCreated": "2026-11-16"
}, - "token": "1794857734"
}
]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.
403 (Access Denied) for an inspection whose property is outside its portfolios.400 with Inspection not found; the ID 0 answers 400 with Invalid Request.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.property - The inspection's propertyunit - The inspected unitlease - The inspection's lease, or null when it has noneworkOrders - The work orders created from the inspection; an empty array when there are noneareas - The areas checked; an empty array when there are noneitems - With areas: each area's items, sorted by name, each with its follow-up actionfiles - With areas: the photos of each area, and with items the photos of each itemGET /maintenance/inspections - List inspectionsGET /maintenance/work-orders/{workOrderID} - Get one of the inspection's work orders| inspectionID required | integer Example: 215 The inspection ID, from |
| includes | string Example: includes=areas,items,files Comma-separated related records to add, with no spaces: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object (included_unit) The inspected unit. Sent only with the | |
included_lease (object) or null The inspection's lease, or | |
Array of objects (included_work_order) The work orders created from the inspection. Sent only with the | |
Array of objects (inspection_area) The areas checked. Sent only with the |
{- "inspection": {
- "inspectionID": "215",
- "propertyID": "896",
- "unitID": "327",
- "leaseID": "137",
- "assignedToUserID": "613",
- "inspectionTypeID": "3",
- "inspectionStatusID": "4",
- "description": "Move-out walkthrough",
- "scheduledDate": "2026-10-01",
- "inspectionDate": "2026-10-02",
- "dateTimeCreated": "2026-11-16"
}, - "areas": [
- {
- "inspectionAreaID": "19",
- "inspectionID": "215",
- "areaID": "19",
- "areaTypeID": "4",
- "name": "Kitchen",
- "items": [
- {
- "item": {
- "inspectionItemID": "32",
- "inspectionID": "215",
- "inspectionAreaID": "19",
- "itemID": "1",
- "name": "Cabinet doors",
- "isExcluded": "0",
- "inspectionItemStatusID": "1",
- "comments": null,
- "actionID": null,
- "areaItemID": "19"
}, - "action": [ ],
- "files": [ ]
}, - {
- "item": {
- "inspectionItemID": "31",
- "inspectionID": "215",
- "inspectionAreaID": "19",
- "itemID": "1",
- "name": "Countertop",
- "isExcluded": "0",
- "inspectionItemStatusID": "2",
- "comments": "Burn mark near the sink",
- "actionID": "19",
- "areaItemID": "19"
}, - "action": {
- "actionID": "19",
- "actionCategoryTypeID": "5",
- "isActive": "1",
- "description": "Replace countertop"
}, - "files": [
- {
- "fileID": "37",
- "inspectionID": "215",
- "areaID": "19",
- "itemID": "1",
- "inspectionAreaID": "19",
- "inspectionItemID": "31",
- "userID": "2",
- "title": "Countertop burn",
- "filePath": "inspections",
- "fileName": "6afb5b0d168ef.jpg",
- "fileType": "jpg",
- "fileSize": "204800",
- "dateTimeCreated": "2026-11-16 19:35:41"
}
]
}
], - "files": [
- {
- "fileID": "38",
- "inspectionID": "215",
- "areaID": "19",
- "itemID": null,
- "inspectionAreaID": "19",
- "inspectionItemID": null,
- "userID": "2",
- "title": "Kitchen overview",
- "filePath": "inspections",
- "fileName": "6afb5b0d17c37.jpg",
- "fileType": "jpg",
- "fileSize": "102400",
- "dateTimeCreated": "2026-11-16 19:35:41"
}
]
}
]
}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.
Returns a page of the price-book materials that aren't deleted, each with the name, type and size of its image file.
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.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 notPOST /maintenance/materials — create a material| 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 ( |
| search | string Example: search=Register Returns the materials whose name, description or UPC contains this text. |
| isActive | string Example: isActive=1
|
| orderBy | string Default: "material.name" Example: orderBy=material.sellPrice|desc Comma-separated sort keys, each |
| pagination-page-size | integer Example: "25" The requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested (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-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (material_list_item) A material as |
required | object The material's image file. Every key is |
[- {
- "material": {
- "materialID": "176",
- "name": "Floor Register 4x10",
- "description": "Box of ten 4x10 floor registers",
- "isActive": "1",
- "upc": "036000291452",
- "purchasePrice": "12.50",
- "sellPrice": "19.99",
- "imageFileID": "206",
- "dateTimeCreated": "2026-11-16 19:28:56",
- "dateTimeModified": "2026-11-16 19:28:56"
}, - "file": {
- "fileID": "206",
- "title": "Floor register",
- "fileName": "6afb59782c4f0.jpg",
- "fileType": "jpg",
- "fileSize": "33455406"
}
}
]Adds a material to the account's price book and returns it, in the same shape as
GET /maintenance/materials/{materialID}.
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.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.isActive 1) and not deleted.includes=file adds the image's file record to the response, as on GET /maintenance/materials/{materialID}.file - The image's file record, or null when the material has no imageGET /maintenance/materials — list materials, or find one by nameGET /maintenance/materials/{materialID} — get the created materialPOST /maintenance/materials/{materialID} — update it, for example to make it inactivePOST /files — upload the image file whose ID imageFileID takes| includes | string Example: includes=file Related records to add to the response, as one comma-separated string. Available value, |
| name required | string [ 1 .. 200 ] characters ^\S(.*\S)?$ Display name of the material, in Windows-1252 characters (Latin-1, so accented letters such as |
| 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 |
| description | string or null <= 4000 characters Optional description or supplier note, in Windows-1252 characters, as |
| isActive | string or integer Default: "1" Enum: "1" 1 A new material is created active: leave this out or send |
| upc | string or null^([0-9]{12})?$ Universal Product Code, exactly 12 digits. An empty string or |
| 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 |
| imageFileID | string or integer or null^[0-9]+$ The ID of an existing file to use as the material's image (an upload from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
file (object) or null The material's image file, or |
{- "name": "Smoke Detector",
- "sellPrice": "19.99"
}{- "material": {
- "materialID": "116",
- "name": "Smoke Detector",
- "description": null,
- "isActive": "1",
- "upc": null,
- "purchasePrice": null,
- "sellPrice": "19.99",
- "imageFileID": null,
- "dateTimeCreated": "2026-11-17 16:34:48",
- "dateTimeModified": "2026-11-17 16:34:48",
- "isDeleted": "0"
}
}Returns one price-book material by ID, with its image's file record when includes=file is sent.
isDeleted 1.400 with Material {materialID} not found.404, except a word that is another route's (explore, locations or quantities), which that route answers instead.file - The material's image file record, or null when it has noneGET /maintenance/materials — list materialsPOST /maintenance/materials/{materialID} — update this materialDELETE /maintenance/materials/{materialID} — delete this material| materialID required | integer Example: 236 The material ID, from |
| includes | string Example: includes=file Comma-separated related records to add, with no spaces. Available value, |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
file (object) or null The material's image file, or |
{- "material": {
- "materialID": "236",
- "name": "Floor Register 4x10",
- "description": "Box of ten 4x10 floor registers",
- "isActive": "1",
- "upc": "036000291452",
- "purchasePrice": "12.50",
- "sellPrice": "19.99",
- "imageFileID": "266",
- "dateTimeCreated": "2026-11-16 19:29:02",
- "dateTimeModified": "2026-11-16 19:29:02",
- "isDeleted": "0"
}, - "file": {
- "fileID": "266",
- "fileSourceID": "5",
- "isAttachable": "0",
- "title": "Floor register",
- "fileName": "6afb597e63a4c.jpg",
- "fileType": "jpg",
- "fileSize": "10312078",
- "userID": "2",
- "isImage": "1",
- "isPublic": "0",
- "previewFileName": null,
- "dateTimeCreated": "2026-11-16 19:29:02"
}
}Updates an existing maintenance material. Only send the fields you want to change — omitted fields are left unchanged. On success, returns the full updated material detail.
400 with "Material {id} not found" if the material does not existname must remain unique among non-deleted materials if changedpurchasePrice and sellPrice must be valid decimal amounts when suppliedGET /maintenance/materials/{materialID} — retrieve current material stateGET /maintenance/materials — list all materialsDELETE /maintenance/materials/{materialID} — delete this material| materialID required | integer Example: 13 The unique material ID |
| name | string <= 200 characters Display name of the material |
| description | string or null <= 4000 characters Optional description or supplier note |
| isActive | string or integer Enum: "0" "1" 0 1 Active status. |
| upc | string or null Universal Product Code |
| purchasePrice | string or number or null <decimal> Cost to purchase the material (decimal as string) |
| sellPrice | string or number <decimal> Price charged when the material is used on a work order |
| imageFileID | string or integer or null^-?[0-9]+$ File ID of an associated image |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 ( |
{- "sellPrice": "10.00"
}{- "material": {
- "materialID": "13",
- "name": "New Item Name",
- "description": null,
- "isActive": "1",
- "upc": null,
- "purchasePrice": null,
- "sellPrice": "10.00",
- "imageFileID": null,
- "dateTimeCreated": "2026-04-24 22:41:08",
- "dateTimeModified": "2026-04-24 22:43:00",
- "isDeleted": "0"
}
}Deletes a maintenance material by setting isDeleted = 1. The record is retained in the
database and the response includes the final state of the material.
400 with "Material {id} not found" if the material does not exist\GET /maintenance/materials list resultsGET /maintenance/materials — list active materialsPOST /maintenance/materials — create a replacement material| materialID required | integer Example: 13 The unique material ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| materialID required | string^-?[0-9]+$ Unique identifier for the material |
| name required | string Display name of the material |
| isDeleted required | integer Value: 1 Soft-delete flag. Always |
| dateTimeCreated required | string Timestamp when the material was created. UTC, formatted |
| dateTimeModified required | string Timestamp of the delete operation. UTC, formatted |
| description | string or null Optional description or supplier note |
| isActive | string Enum: "0" "1" Active status |
| upc | string or null Universal Product Code |
| purchasePrice | string or null <decimal> Cost to purchase the material |
| sellPrice | string <decimal> Price charged when the material is used on a work order |
| imageFileID | string or null^-?[0-9]+$ File ID of the associated image |
{- "materialID": "13",
- "name": "New Item Name",
- "description": null,
- "isActive": "1",
- "upc": null,
- "purchasePrice": null,
- "sellPrice": "10.00",
- "imageFileID": null,
- "dateTimeCreated": "2026-04-24 22:41:08",
- "dateTimeModified": "2026-04-24 22:46:20",
- "isDeleted": 1
}Your account's rates for maintenance labor, for use on work orders. List, create, read, update and delete labor rates.
Returns a page of the price-book labor rates. Deleted labor rates are left out unless isDeleted asks for them.
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.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 notPOST /maintenance/labor-rates — create a labor rate| 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 ( |
| 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[] | Array of integers Example: laborRateIDs[]=166&laborRateIDs[]=167 Returns only these labor rates. Send each ID as its own |
| rateMin | number Example: rateMin=40 Returns the labor rates whose |
| rateMax | number Example: rateMax=100 Returns the labor rates whose |
| isDeleted | integer Default: 0
|
| orderBy | string Default: "laborRate.name" Example: orderBy=laborRate.rate|desc Comma-separated sort keys, each |
| pagination-page-size | integer Example: "25" The requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested (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-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "laborRate": {
- "laborRateID": "166",
- "name": "Licensed Plumber",
- "description": "Licensed plumber, per visit",
- "rate": "95.00",
- "hourlyRate": "65.00",
- "isDeleted": "0",
- "dateTimeCreated": "2026-11-16 19:30:40",
- "dateTimeModified": "2026-11-16 19:30:40"
}
}
]Creates a new maintenance labor rate. On success, returns the created labor rate as a flat object.
name, rate, and hourlyRate are required; description is optionalname must be unique among non-deleted labor ratesrate and hourlyRate must be non-negative decimal amounts; zero is allowedGET /maintenance/labor-rates — list all labor ratesGET /maintenance/labor-rates/{laborRateID} — retrieve the created labor ratePOST /maintenance/labor-rates/{laborRateID} — update an existing labor rate| name required | string Display name of the labor rate |
| rate required | string or number <decimal> Rate charged to Owner for this labor type (decimal as string). Zero is allowed. |
| hourlyRate required | string or number or null <decimal> The Technician's hourly rate (decimal as string). Zero is allowed. Null when not applicable. |
| description | string or null Optional description of the labor rate |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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). |
| 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. |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
{- "name": "New Labor Item",
- "rate": "5.00"
}{- "laborRateID": "8",
- "name": "New Labor Item",
- "description": null,
- "rate": "5.00",
- "hourlyRate": "10.00",
- "isDeleted": "0",
- "dateTimeCreated": "2026-04-24 23:04:24",
- "dateTimeModified": "2026-04-24 23:04:24"
}Returns one labor rate by ID, as a flat object with no wrapper key.
isDeleted 1.400 with Labor Rate {laborRateID} not found.404, except a word that is another route's (explore), which that route answers instead.GET /maintenance/labor-rates — list labor ratesPOST /maintenance/labor-rates/{laborRateID} — update this labor rateDELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate| laborRateID required | integer Example: 219 The labor rate ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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). |
| 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. |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
{- "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"
}Updates an existing maintenance labor rate. Only send the fields you want to change — omitted fields are left unchanged. Returns the updated labor rate as a flat object.
400 with "Labor Rate {id} not found" if the labor rate does not existname must remain unique among non-deleted labor rates if changedrate and hourlyRate must be non-negative decimal amounts when supplied; zero is allowedlaborRateID, dateTimeCreated, and dateTimeModified in the request body are accepted but ignoredGET /maintenance/labor-rates/{laborRateID} — retrieve current labor rate stateGET /maintenance/labor-rates — list all labor ratesDELETE /maintenance/labor-rates/{laborRateID} — delete this labor rate| laborRateID required | integer Example: 7 The unique labor rate ID |
| name | string <= 200 characters Display name of the labor rate |
| description | string or null <= 4000 characters Optional description |
| rate | string or number <decimal> Flat rate charged (decimal as string). Zero is allowed. |
| hourlyRate | string or number or null <decimal> Hourly cost rate (decimal as string). Zero is allowed. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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). |
| 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. |
| dateTimeCreated required | string Timestamp when the labor rate was created. UTC, formatted |
| dateTimeModified required | string Timestamp when the labor rate was last modified. UTC, formatted |
{- "rate": "0.00"
}{- "laborRateID": "7",
- "name": "Jake Internal Maintenance Tech",
- "description": "Test",
- "rate": "0.00",
- "hourlyRate": "20.00",
- "isDeleted": "0",
- "dateTimeCreated": "2026-02-27 16:18:41",
- "dateTimeModified": "2026-02-27 16:18:41"
}Deletes a labor rate from the catalog. The record is removed from the database. Returns a success confirmation.
400 with "Labor Rate {id} not found" if the labor rate does not existGET /maintenance/labor-rates by defaultGET /maintenance/labor-rates — list active labor ratesPOST /maintenance/labor-rates — create a replacement labor rate| laborRateID required | integer Example: 7 The unique labor rate ID to delete |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| success required | boolean Always |
| message required | string or null Confirmation message |
{- "success": true,
- "message": "Labor rate deleted successfully"
}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.
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.
isActive says otherwisesearch matches the portfolio's name or code, not its owners' namestoken is the current Unix time (in seconds) as a string, the same on every item of a responseGET /portfolios/search - Filtered, sortable search with owner names, property counts and the latest statementGET /portfolios/{portfolioID} - One portfolio, with optional includes| 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
|
| sendStatements | string Example: sendStatements=1
|
| excludePortfolioID | integer Example: excludePortfolioID=150 Leave this portfolio out of the results. |
| pagination-page-size | integer Example: "25" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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. |
[- {
- "portfolio": {
- "portfolioID": "379",
- "code": "PF7883",
- "name": "Contract Filled 6afb5aec86e85",
- "contacts": [
- {
- "contactID": "174",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "name": "Jordan Example"
}, - {
- "contactID": "175",
- "percentOwned": "40.0000",
- "percentDistributed": "50.0000",
- "name": "Casey Example"
}
], - "postingSettingID": "384",
- "assignedToUserID": "237",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "611",
- "sendStatements": "1",
- "holdDistributions": "1",
- "holdDistributionsDescription": "Awaiting owner tax form",
- "isActive": "1",
- "isLiveLedgerEnabled": "1",
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-16 19:35:08",
- "dateTimeModified": "2026-11-16 19:35:08",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": "Pay by the 10th"
}, - "token": "1794857708"
}
]Creates a new portfolio with the provided name, financial settings, owner assignments, and optional group
memberships. On success the newly created portfolio is returned in the same shape as GET /portfolios/{portfolioID}.
attachments file IDsUpdatePortfolio permissionowners must be supplied as an array; each entry requires contactID, percentOwned, and percentDistributedisLiveLedgerEnabled accepts -1 to reset the value to null (account default); any other value is stored as-isportfolioGroupIDs assigns the new portfolio to one or more portfolio groupsattachments is an array of existing file IDs to attach to the portfolio on creationGET /portfolios/{portfolioID} - Retrieve the created portfolioPOST /portfolios/{portfolioID} - Update portfolio settingsPOST /portfolios/{portfolioID}/owners - Sync owner list after creation| name required | string Display name of the portfolio. |
| code | string or null Optional short reference code for the portfolio. |
| postingSettingID | string or integer or null^-?[0-9]+$ ID of the posting setting template to assign. |
| statementSettingID | string or integer or null^-?[0-9]+$ ID of the statement setting template to assign. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether to send owner statements. |
| payoutAmount | string or null Fixed payout amount (decimal string), if applicable. |
| fiscalYearEndMonth | string or integer^-?[0-9]+$ Month number (1–12) when the fiscal year ends. |
| minimumDistributionAmount | string or number <decimal> Minimum distribution amount (decimal string). |
| maximumDistributionAmount | string or number <decimal> Maximum distribution amount per cycle (decimal string). |
| overdraftOverrideAmount | string or number <decimal> Amount the balance can go negative before blocking transactions (decimal string). |
| additionalReserveAmount | string or number <decimal> Additional reserve on top of the base reserve (decimal string). |
| additionalReserveDescription | string or null Explanation of the additional reserve amount. |
| holdDistributions | string or integer Enum: "0" "1" 0 1 Whether to hold distributions. |
| isLiveLedgerEnabled | string or integer or null Enum: "0" "1" 0 1 null Real-time ledger updates. Pass |
| isBalanceNoticeDisabled | string or integer Enum: "0" "1" 0 1 Whether to suppress balance notice emails. |
Array of objects Initial owner assignments for the portfolio. | |
| portfolioGroupIDs | Array of integers IDs of portfolio groups to add this portfolio to. |
| attachments | Array of integers File IDs to attach to the new portfolio. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (portfolio) Represents a portfolio — the ownership and financial management unit for one or more rental properties. Each portfolio tracks owner contacts, distribution rules, reserve requirements, and statement settings. |
{- "name": "456 Oak Ave - Johnson",
- "postingSettingID": 3,
- "statementSettingID": 1,
- "sendStatements": 1,
- "fiscalYearEndMonth": 12,
- "minimumDistributionAmount": "0.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "overdraftOverrideAmount": "100.00",
- "additionalReserveAmount": "0.00",
- "holdDistributions": 0,
- "isBalanceNoticeDisabled": 0,
- "owners": [
- {
- "contactID": 4679,
- "percentOwned": "100.00",
- "percentDistributed": "100.00"
}
]
}{- "portfolio": {
- "portfolioID": "312",
- "code": "OAK-456",
- "name": "456 Oak Ave - Johnson",
- "contacts": [
- {
- "contactID": "4679",
- "percentOwned": "100.0000",
- "percentDistributed": "100.0000",
- "name": "Robert Johnson"
}
], - "postingSettingID": "3",
- "assignedToUserID": null,
- "minimumDistributionAmount": "0.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "0.00",
- "additionalReserveDescription": null,
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1",
- "sendStatements": "1",
- "holdDistributions": "0",
- "holdDistributionsDescription": null,
- "isActive": "1",
- "isLiveLedgerEnabled": null,
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-04-23 10:15:00",
- "dateTimeModified": "2026-04-23 10:15:00",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": null
}
}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.
isActive filters themorderBy is absent, then by portfolioIDGET /portfolios - Paginated list of full portfolio rowsGET /portfolios/{portfolioID} - One portfolio, with optional includes| 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
|
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=150 Only these portfolios. Send each ID as a separate |
| postingSettingIDs[] | Array of integers Example: postingSettingIDs[]=3 Only portfolios on these posting settings ( |
| statementSettingIDs[] | Array of integers Example: statementSettingIDs[]=12 Only portfolios on these statement settings ( |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=5 Only portfolios in any of these portfolio groups ( |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=8 Only portfolios with at least one property in any of these property groups ( |
| tagIDs[] | Array of integers Example: tagIDs[]=22 Only portfolios tagged with any of these tags ( |
| reserveAmountMin | number Example: reserveAmountMin=500 Only portfolios whose |
| reserveAmountMax | number Example: reserveAmountMax=5000 Only portfolios whose |
| holdDistributions | string Example: holdDistributions=0
|
| hasAdditionalReserve | string Example: hasAdditionalReserve=1
|
| sendStatements | string Example: sendStatements=1
|
| 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 |
| 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 |
| dateClosedMin | string Example: dateClosedMin=2024-01-01 Only portfolios closed on or after this date ( |
| dateClosedMax | string Example: dateClosedMax=2024-12-31 Only portfolios closed on or before this date ( |
| portfolioAssignedToUserIDs[] | Array of integers Example: portfolioAssignedToUserIDs[]=42 Only portfolios assigned to any of these users ( |
| propertyAssignedToUserIDs[] | Array of integers Example: propertyAssignedToUserIDs[]=42 Only portfolios with at least one property assigned to any of these users ( |
| payoutBatchID | integer Example: payoutBatchID=300 Only portfolios with a payout in this payout batch ( |
| orderBy | string Example: orderBy=portfolio.reserveAmount|desc,portfolio.name Sort order: a comma-separated list of |
| pagination-page-size | integer Example: "25" Page size used on a page that holds items -- the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "portfolio": {
- "isActive": "1",
- "portfolioID": "391",
- "code": "PF2369",
- "name": "Contract Search Filled 6afb5aeee69d0",
- "contacts": "[{\"contactID\":\"177\",\"percentOwned\":\"60.0000\",\"percentDistributed\":\"50.0000\",\"name\":\"Jane Doe\"},{\"contactID\":\"178\",\"percentOwned\":\"40.0000\",\"percentDistributed\":\"50.0000\",\"name\":\"John Roe\"}]",
- "postingSettingID": "396",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "623",
- "sendStatements": "1",
- "holdDistributions": "1",
- "dateTimeCreated": "2026-11-16 19:35:10",
- "dateTimeModified": "2026-11-16 19:35:10",
- "dateTimeDeactivated": null,
- "dateClosed": null,
- "assignedToUserID": "245",
- "propertyCount": "1",
- "contactNames": "Jane Doe, John Roe"
}, - "statementSetting": {
- "statementSettingID": "623",
- "name": "voluptas quod numquam"
}, - "lastStatement": {
- "name": "04/01/2026 to 04/30/2026",
- "startDate": "2026-04-01",
- "endDate": "2026-04-30"
}
}
]Returns one portfolio under portfolio, the full row. Related records are added on request through includes.
0isLiveLedgerEnabled of null means the account-level default appliesincludes is a comma-separated list; unknown names are ignored, and each include adds one key to the responseowners - The portfolio's owners, each with its contact recordledger - The portfolio's ledger, or null when it has noneposting - The portfolio's posting settingbalances - 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 0statistics - Counts of active properties, units, occupied units and active leases, and the unpaid bills' count and totalstatementSetting - The portfolio's statement setting templateGET /portfolios - Paginated portfolio listGET /portfolios/{portfolioID}/owners - The portfolio's ownersGET /portfolios/{portfolioID}/statements - The portfolio's statements| portfolioID required | integer Example: 150 The ID of the portfolio to retrieve. |
| includes | string Example: includes=owners,balances,statementSetting Comma-separated list of related data to add to the response:
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
included_ledger (object) or null The portfolio's ledger, or | |
object The portfolio's posting setting. Requires the | |
Ledger with entries (object) or Ledger with no entries (object) or null The portfolio ledger's balances as of now, or | |
object Rollup counts for the portfolio. Requires the | |
object (statement_setting) A statement setting template that controls how owner statements are generated and which modules are included. |
{- "portfolio": {
- "portfolioID": "418",
- "code": "PF6426",
- "name": "Contract View All 6afb5af3e83e2",
- "contacts": [
- {
- "contactID": "182",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "name": "Jane Doe"
}
], - "postingSettingID": "423",
- "assignedToUserID": "258",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "652",
- "sendStatements": "1",
- "holdDistributions": "1",
- "holdDistributionsDescription": "Awaiting owner tax form",
- "isActive": "1",
- "isLiveLedgerEnabled": "1",
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-16 19:35:15",
- "dateTimeModified": "2026-11-16 19:35:16",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": "Example note."
}, - "owners": [
- {
- "owner": {
- "portfolioOwnerID": "179",
- "portfolioID": "418",
- "contactID": "182",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "overrideContactPayoutSettings": "1",
- "payeeName": "Jane Doe",
- "payoutTypeID": "2",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0"
}, - "contact": {
- "contactID": "182",
- "contactTypeID": "1",
- "vendorTypeID": null,
- "code": null,
- "name": "Jane Doe",
- "firstName": "Jane",
- "middleName": "Q",
- "lastName": "Doe",
- "suffix": "II",
- "email": "jane.doe@example.com",
- "phone": "555-0100",
- "countryID": "US",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "CA",
- "postalCode": "12345",
- "birthDate": null,
- "defaultBillChargeAccountID": null,
- "payeeName": null,
- "taxPayerName": null,
- "taxFormTypeID": null,
- "identificationTypeID": null,
- "identificationNumber": null,
- "identificationCountryID": null,
- "identificationIssuingLocation": null,
- "identificationExpirationDate": null,
- "payoutTypeID": "2",
- "otherPayoutTypeID": null,
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0",
- "holdPayments": "0",
- "liabilityInsuranceName": null,
- "liabilityInsurancePolicyNumber": null,
- "liabilityInsuranceExpiresDate": null,
- "workersCompInsuranceName": null,
- "workersCompInsurancePolicyNumber": null,
- "workersCompInsuranceExpiresDate": null,
- "discountPercent": null,
- "discountAmount": null,
- "discountAmountMin": null,
- "discountAmountMax": null,
- "discountGraceDays": null,
- "isActive": "1",
- "isInsuranceRequiredForPayment": null,
- "maxLineItemsOnPayment": null,
- "preventConsolidatedPayments": "0",
- "isFromImport": "0",
- "importSourceKey": null,
- "websiteUrl": null,
- "applicantID": null,
- "ownerPortalNameOverride": null,
- "isBillApprovalExempt": "0",
- "isBillingSalesTaxEnabled": "0",
- "isQuickbooksExportEnabled": "0",
- "quickbooksCustomerName": null,
- "invoiceAutofillTemplateID": null,
- "dateTimeCreated": "2026-11-16 19:35:15",
- "dateTimeModified": "2026-11-16 19:35:15",
- "dateTimeDeactivated": null,
- "contactType": "Owner"
}
}
], - "ledger": {
- "ledgerID": "425",
- "ledgerTypeID": "2",
- "objectID": "418",
- "name": "PF6426 - Contract View All 6afb5af3e83e2",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:35:15",
- "dateTimeModified": "2026-11-16 19:35:16"
}, - "posting": {
- "postingSettingID": "423",
- "name": "assumenda autem minus",
- "operatingAccountID": "31",
- "escrowAccountID": "32",
- "leaseRefundAccountID": "32",
- "isActive": "1"
}, - "balances": {
- "ledgerID": "425",
- "name": "PF6426 - Contract View All 6afb5af3e83e2",
- "ledgerTypeID": "2",
- "objectID": "418",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "overdraftOverrideAmount": "100.00",
- "cashBalance": "0.00",
- "escrowBalance": "0.00",
- "prepaymentBalance": "0.00",
- "depositBalance": "0.00",
- "nonHeldDepositBalance": "0.00",
- "accountsReceivableBalance": "0.00",
- "accountsPayableBalance": "0.00",
- "creditBalance": "0.00",
- "currentCreditBalance": "0.00",
- "currentAccountsPayableBalance": "0.00",
- "liabilityBalance": "0.00",
- "nonHeldLiabilityBalance": "0.00",
- "undepositedReceiptsBalance": "0.00",
- "undepositedPrepaymentReceiptsBalance": "0.00",
- "undepositedLiabilityReceiptsBalance": "0.00",
- "undepositedDepositReceiptsBalance": "0.00",
- "undepositedManualReceiptsBalance": "0.00",
- "undepositedPrepaymentManualReceiptsBalance": "0.00",
- "undepositedLiabilityManualReceiptsBalance": "0.00",
- "undepositedDepositManualReceiptsBalance": "0.00",
- "undepositedEscrowReceiptsBalance": "0.00",
- "workOrderEstimateBalance": "0.00",
- "operatingBalance": "0.00",
- "availableFunds": "0.00"
}, - "statistics": {
- "propertyCount": "0",
- "activeLeaseCount": "0",
- "unitCount": "0",
- "occupiedUnitCount": "0",
- "unpaidBillCount": "0",
- "unpaidBillsAmount": "0.00"
}, - "statementSetting": {
- "statementSettingID": "652",
- "name": "voluptates id dolor",
- "isActive": "1",
- "settings": {
- "statement": {
- "includeBills": true,
- "includeBillAttachments": 0,
- "includeBillAttachmentsWithMarkup": 0,
- "includeBillAttachmentsWithDiscount": 0,
- "includeWorkOrders": false,
- "includeWorkOrderAttachments": 0,
- "includeBalanceMessage": 1,
- "combineDiscount": 1,
- "combineMarkup": 1,
- "includePrepayments": 0
}, - "modules": {
- "summary": {
- "isActive": 0,
- "pageBreak": 0
}, - "taxSummary": {
- "isActive": 0,
- "pageBreak": 0,
- "includePrepayments": 0
}, - "transactionSummary": {
- "isActive": 0,
- "includeYearToDate": 1,
- "excludeZeroBalanceAccounts": 0,
- "pageBreak": 0
}, - "transactionDetails": {
- "isActive": 0,
- "pageBreak": 0,
- "isMultiUnitConsolidated": 1,
- "isTransactionConsolidated": 0,
- "isIncomeConsolidated": 1,
- "isManagementFeeConsolidated": 1,
- "propertyTransactionsOrderField": 1,
- "includeTransactionRunningBalance": 0,
- "includePayeePayer": 0,
- "includePropertyReserveAmount": 1,
- "includeNetValues": 1,
- "propertyOrderType": 1
}, - "ledger": {
- "isActive": 0,
- "pageBreak": 0,
- "includePayeePayer": 0
}, - "openWorkOrders": {
- "isActive": 0,
- "pageBreak": 0
}, - "closedWorkOrders": {
- "isActive": 0,
- "pageBreak": 0,
- "includeClosingComments": 0
}, - "unpaidBills": {
- "isActive": 0,
- "pageBreak": 0
}, - "notes": {
- "isActive": 0,
- "pageBreak": 0
}, - "units": {
- "isActive": 0,
- "pageBreak": 0,
- "showBalance": 1,
- "showTenants": 1,
- "showMoveInDate": 1
}
}
}
}
}Updates the settings for an existing portfolio. Only the fields present in the request body are written;
omitted fields retain their current values. On success the updated portfolio is returned in the same shape
as GET /portfolios/{portfolioID}.
assignedToUserID)dateClosedUpdatePortfolio permissionisLiveLedgerEnabled accepts -1 to reset the value to null (account default)dateClosed accepts an ISO date string (YYYY-MM-DD); set to null to reopenGET /portfolios/{portfolioID} - Retrieve current portfolio statePOST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolioPOST /portfolios/{portfolioID}/deactivate - Deactivate a portfolioPOST /portfolios/{portfolioID}/owners - Sync the owner list independently| portfolioID required | integer Example: 279 The ID of the portfolio to update. |
| name | string Display name of the portfolio. |
| code | string or null Optional short reference code. |
| postingSettingID | string or integer or null^-?[0-9]+$ ID of the posting setting template to assign. |
| statementSettingID | string or integer or null^-?[0-9]+$ ID of the statement setting template to assign. |
| sendStatements | string or integer Enum: "0" "1" 0 1 Whether to send owner statements. |
| fiscalYearEndMonth | string or integer^-?[0-9]+$ Month number (1–12) when the fiscal year ends. |
| minimumDistributionAmount | string or number <decimal> Minimum distribution amount (decimal string). |
| maximumDistributionAmount | string or number <decimal> Maximum distribution amount per cycle (decimal string). |
| overdraftOverrideAmount | string or number <decimal> Amount the balance can go negative before blocking transactions (decimal string). |
| additionalReserveAmount | string or number <decimal> Additional reserve on top of the base reserve (decimal string). |
| additionalReserveDescription | string or null Explanation of the additional reserve amount. |
| holdDistributions | string or integer Enum: "0" "1" 0 1 Whether to hold distributions. |
| holdDistributionsDescription | string or null Reason distributions are being held. |
| isLiveLedgerEnabled | string or integer or null Enum: "0" "1" 0 1 null Real-time ledger updates. Pass |
| isBalanceNoticeDisabled | string or integer Enum: "0" "1" 0 1 Whether to suppress balance notice emails. |
| dateClosed | string or null <date> Date the portfolio was closed (YYYY-MM-DD). Set to |
| assignedToUserID | string or integer or null^-?[0-9]+$ ID of the user assigned to manage this portfolio. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (portfolio) Represents a portfolio — the ownership and financial management unit for one or more rental properties. Each portfolio tracks owner contacts, distribution rules, reserve requirements, and statement settings. |
{- "name": "456 Oak Ave - Johnson (Updated)",
- "reserveAmount": "750.00",
- "maximumDistributionAmount": "6000.00",
- "assignedToUserID": 491061,
- "holdDistributions": 0
}{- "portfolio": {
- "portfolioID": "279",
- "code": null,
- "name": "456 Oak Ave - Johnson (Updated)",
- "contacts": [
- {
- "contactID": "4679",
- "percentOwned": "100.0000",
- "percentDistributed": "85.0000",
- "name": "Test holder"
}
], - "postingSettingID": "13",
- "assignedToUserID": "491061",
- "minimumDistributionAmount": "0.00",
- "maximumDistributionAmount": "6000.00",
- "reserveAmount": "750.00",
- "additionalReserveAmount": "0.00",
- "additionalReserveDescription": null,
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1",
- "sendStatements": "1",
- "holdDistributions": "0",
- "holdDistributionsDescription": null,
- "isActive": "1",
- "isLiveLedgerEnabled": null,
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2025-03-20 19:51:20",
- "dateTimeModified": "2026-04-23 11:30:00",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": null
}
}Reactivates a previously deactivated portfolio. On success the updated portfolio is returned in the
same shape as GET /portfolios/{portfolioID}.
UpdatePortfolio permissionisActive to "1" and clears dateTimeDeactivatedPOST /portfolios/{portfolioID}/deactivate - Deactivate a portfolioGET /portfolios/{portfolioID} - Retrieve current portfolio state| portfolioID required | integer Example: 279 The ID of the portfolio to activate. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (portfolio) Represents a portfolio — the ownership and financial management unit for one or more rental properties. Each portfolio tracks owner contacts, distribution rules, reserve requirements, and statement settings. |
{- "portfolio": {
- "portfolioID": "279",
- "code": null,
- "name": "123 Main St - Amber Negron",
- "contacts": [
- {
- "contactID": "4679",
- "percentOwned": "100.0000",
- "percentDistributed": "85.0000",
- "name": "Test holder"
}
], - "postingSettingID": "13",
- "assignedToUserID": "491061",
- "minimumDistributionAmount": "0.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "0.00",
- "additionalReserveDescription": null,
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1",
- "sendStatements": "1",
- "holdDistributions": "0",
- "holdDistributionsDescription": null,
- "isActive": "1",
- "isLiveLedgerEnabled": null,
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2025-03-20 19:51:20",
- "dateTimeModified": "2026-04-23 12:00:00",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": null
}
}Deactivates an active portfolio, optionally recording a closure date. On success the updated portfolio
is returned in the same shape as GET /portfolios/{portfolioID}.
UpdatePortfolio permissiondateClosed is optional; when supplied it must be a valid date string (YYYY-MM-DD)isActive to "0" and records dateTimeDeactivatedPOST /portfolios/{portfolioID}/activate - Reactivate a deactivated portfolioGET /portfolios/{portfolioID} - Retrieve current portfolio state| portfolioID required | integer Example: 279 The ID of the portfolio to deactivate. |
| dateClosed | string or null <date> Date the portfolio was officially closed (YYYY-MM-DD). |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (portfolio) Represents a portfolio — the ownership and financial management unit for one or more rental properties. Each portfolio tracks owner contacts, distribution rules, reserve requirements, and statement settings. |
{- "dateClosed": "2026-04-30"
}{- "portfolio": {
- "portfolioID": "279",
- "code": null,
- "name": "123 Main St - Amber Negron",
- "contacts": [
- {
- "contactID": "4679",
- "percentOwned": "100.0000",
- "percentDistributed": "85.0000",
- "name": "Test holder"
}
], - "postingSettingID": "13",
- "assignedToUserID": "491061",
- "minimumDistributionAmount": "0.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "0.00",
- "additionalReserveDescription": null,
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1",
- "sendStatements": "1",
- "holdDistributions": "0",
- "holdDistributionsDescription": null,
- "isActive": "0",
- "isLiveLedgerEnabled": null,
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2025-03-20 19:51:20",
- "dateTimeModified": "2026-04-23 14:00:00",
- "dateTimeDeactivated": "2026-04-23 14:00:00",
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": "2026-04-30",
- "payOwnersNotes": null
}
}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.
search matches the owner contact's name; send it with the contact include0 answers 400token, sent only when no include is requested, is the current Unix time (in seconds) as a string, the same on every itemcontact - The owner's contact record, every columnportfolio - The portfolio, every column (the same on every item)GET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - One ownerGET /portfolios/{portfolioID} - The portfolio, whose owners include returns the same owners with their contacts| portfolioID required | integer Example: 279 The ID of the portfolio whose owners to list. |
| search | string Example: search=Smith Text to find in the owner contact's name. Send it with the |
| includes | string Example: includes=contact Comma-separated list of related data to add to each item: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object (portfolio) The portfolio. Requires the | |
| token | string^[0-9]+$ The current Unix time in seconds, the same on every item. Sent only when no include is requested. |
[- {
- "owner": {
- "portfolioOwnerID": "258",
- "portfolioID": "586",
- "contactID": "263",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "overrideContactPayoutSettings": "1",
- "payeeName": "Jane Doe",
- "payoutTypeID": "2",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0"
}, - "token": "1794858130"
}
]Replaces the full owner list for a portfolio in a single operation. All existing owners are removed
and the supplied owners array is set as the new authoritative list. On success the updated owner
list is returned in the same paginated shape as GET /portfolios/{portfolioID}/owners.
UpdatePortfolio permissionowners is required and must be a non-empty array; each entry requires contactID,
percentOwned, and percentDistributedGET /portfolios/{portfolioID}/owners - List current ownersGET /portfolios/{portfolioID}/owners/{portfolioOwnerID} - Single owner detailPOST /portfolios/{portfolioID} - Update portfolio settings (owners can also be set on create)| portfolioID required | integer Example: 279 The ID of the portfolio whose owners to replace. |
required | Array of objects Full replacement owner list. Each entry must include contactID, percentOwned, and percentDistributed. |
| pagination-page-size | integer Example: "25" Number of items per page |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer or null Next page number, or null if on the last page |
| pagination-before-page | integer or null Previous page number, or null if on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (portfolio_owner) Represents an owner's stake in a portfolio, including ownership percentage, distribution settings, and payout configuration. |
| token required | string Cache token for the owner record. |
{- "owners": [
- {
- "contactID": 4679,
- "percentOwned": "100.00",
- "percentDistributed": "100.00"
}
]
}[- {
- "owner": {
- "portfolioOwnerID": "601",
- "portfolioID": "279",
- "contactID": "4679",
- "percentOwned": "60.0000",
- "percentDistributed": "60.0000",
- "overrideContactPayoutSettings": "0",
- "payeeName": "Robert Johnson",
- "payoutTypeID": "2",
- "achDetailsCiphertextID": null,
- "achAccountNumberTruncated": null,
- "achAccountTypeID": null,
- "achIsCorporateAccount": "0"
}, - "token": "1776991900"
}, - {
- "owner": {
- "portfolioOwnerID": "602",
- "portfolioID": "279",
- "contactID": "3444",
- "percentOwned": "40.0000",
- "percentDistributed": "40.0000",
- "overrideContactPayoutSettings": "0",
- "payeeName": "Sandra Villanueva",
- "payoutTypeID": "3",
- "achDetailsCiphertextID": "1021",
- "achAccountNumberTruncated": "8842",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "0"
}, - "token": "1776991900"
}
]Returns 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.
0portfolio - The portfolio, every columncontact - The owner's contact record, every columnGET /portfolios/{portfolioID}/owners - Every owner of the portfolio| portfolioID required | integer Example: 279 The ID of the portfolio. |
| portfolioOwnerID required | integer Example: 536 The ID of the portfolio owner record ( |
| includes | string Example: includes=contact Comma-separated list of related data to add to the response: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
object (included_contact) The owner's contact. Requires the |
{- "portfolioOwner": {
- "portfolioOwnerID": "263",
- "portfolioID": "589",
- "contactID": "268",
- "percentOwned": "100.0000",
- "percentDistributed": "100.0000",
- "overrideContactPayoutSettings": "1",
- "payeeName": "Jane Doe",
- "payoutTypeID": "4",
- "achDetailsCiphertextID": "7",
- "achAccountNumberTruncated": "6789",
- "achAccountTypeID": "2",
- "achIsCorporateAccount": "1"
}
}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.
statementBatchID)statementStatusID or date that can't be read is ignored: the results aren't filtered by it. portfolioIDs
takes integer IDs onlystartDate, 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 orderGET /portfolios/{portfolioID}/statements - One portfolio's statements, full rowsGET /portfolios/statements/{statementID} - One statement, with its filesGET /portfolios/statements/batches/search - Statement batches| 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 ( |
| statementStatusID | integer Enum: 1 2 3 4 5 Example: statementStatusID=4 Only statements in this status.
|
| startDate | string Example: startDate=2026-01-01 Only statements whose period starts on or after this date ( |
| endDate | string Example: endDate=2026-03-31 Only statements whose period ends on or before this date ( |
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=150 Only the statements of these portfolios. Send each ID as a separate |
| pagination-page-size | integer Example: "25" Page size used on a page that holds items -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested (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-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object A summary of the statement row, with two counts. |
required | object The statement's portfolio. |
required | object The statement's statement setting. |
[- {
- "statement": {
- "statementID": "368",
- "portfolioID": "601",
- "statementBatchID": "303",
- "startDate": "2026-04-01",
- "endDate": "2026-04-30",
- "statementPeriodTypeID": "1",
- "statementStatusID": "2",
- "name": "04/01/2026 to 04/30/2026",
- "beginningBalance": "1200.50",
- "endingBalance": "1830.25",
- "totalDistributionAmount": "900.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "unpaidBillAmount": "75.10",
- "workOrderEstimateAmount": "40.00",
- "statementFileCount": "1",
- "statementAttachmentCount": "0"
}, - "portfolio": {
- "portfolioID": "601",
- "name": "Contract Statement Search 6afb5c980c76a",
- "contacts": "[{\"contactID\":\"274\",\"percentOwned\":\"60.0000\",\"percentDistributed\":\"50.0000\",\"name\":\"Jane Doe\"},{\"contactID\":\"275\",\"percentOwned\":\"40.0000\",\"percentDistributed\":\"50.0000\",\"name\":\"John Roe\"}]"
}, - "statementSetting": {
- "statementSettingID": "939",
- "name": "quos sunt laboriosam"
}
}
]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.
search is accepted but ignoredendDate, 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 orderportfolio - The portfolio, every columnGET /portfolios/statements/search - Statements across portfolios, with filtersGET /portfolios/statements/{statementID} - One statement, with its filesGET /portfolios/statements/{statementID}/download - A statement's files as a ZIP archive| portfolioID required | integer >= 1 Example: 279 The ID of the portfolio whose statements to list. |
| 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: |
| search | string Accepted but ignored; the list isn't filtered by it. |
| pagination-page-size | integer Example: "25" Page size used -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 |
[- {
- "statement": {
- "statementID": "422",
- "statementBatchID": "344",
- "statementSettingID": "1003",
- "portfolioID": "625",
- "name": "04/01/2026 to 04/30/2026",
- "startDate": "2026-04-01",
- "endDate": "2026-04-30",
- "statementPeriodTypeID": "1",
- "statementStatusID": "2",
- "beginningBalance": "1200.50",
- "endingBalance": "1830.25",
- "totalDistributionAmount": "900.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "unpaidBillAmount": "75.10",
- "workOrderEstimateAmount": "40.00",
- "totalIncomeAmount": "2100.00",
- "totalExpenseAmount": "570.25",
- "totalAdjustmentAmount": "-10.00",
- "dateTimeCreated": "2026-11-16 19:42:55",
- "publicUUID": "e736eee4-6d27-4135-ae43-e4692de60649",
- "dateTimeAccessExpires": "2026-11-30 19:42:55",
- "publicVerificationCode": "595218",
- "message": "Thank you for your business."
}, - "statementSetting": {
- "statementSettingID": "1003",
- "name": "quia similique delectus",
- "isActive": "1",
- "settings": {
- "statement": {
- "includeBills": 0,
- "includeBillAttachments": 0,
- "includeBillAttachmentsWithMarkup": 0,
- "includeBillAttachmentsWithDiscount": 0,
- "includeWorkOrders": 0,
- "includeWorkOrderAttachments": 0,
- "includeBalanceMessage": 1,
- "combineDiscount": 1,
- "combineMarkup": 1,
- "includePrepayments": 0
}, - "modules": {
- "summary": {
- "isActive": 0,
- "pageBreak": 0
}, - "taxSummary": {
- "isActive": 0,
- "pageBreak": 0,
- "includePrepayments": 0
}, - "transactionSummary": {
- "isActive": 0,
- "includeYearToDate": 1,
- "excludeZeroBalanceAccounts": 0,
- "pageBreak": 0
}, - "transactionDetails": {
- "isActive": 0,
- "pageBreak": 0,
- "isMultiUnitConsolidated": 1,
- "isTransactionConsolidated": 0,
- "isIncomeConsolidated": 1,
- "isManagementFeeConsolidated": 1,
- "propertyTransactionsOrderField": 1,
- "includeTransactionRunningBalance": 0,
- "includePayeePayer": 0,
- "includePropertyReserveAmount": 1,
- "includeNetValues": 1,
- "propertyOrderType": 1
}, - "ledger": {
- "isActive": 0,
- "pageBreak": 0,
- "includePayeePayer": 0
}, - "openWorkOrders": {
- "isActive": 0,
- "pageBreak": 0
}, - "closedWorkOrders": {
- "isActive": 0,
- "pageBreak": 0,
- "includeClosingComments": 0
}, - "unpaidBills": {
- "isActive": 0,
- "pageBreak": 0
}, - "notes": {
- "isActive": 0,
- "pageBreak": 0
}, - "units": {
- "isActive": 0,
- "pageBreak": 0,
- "showBalance": 1,
- "showTenants": 1,
- "showMoveInDate": 1
}
}
}
}, - "portfolio": {
- "portfolioID": "625",
- "code": "PF9728",
- "name": "Contract Statements All 6afb5cbfacf06",
- "contacts": [
- {
- "contactID": "289",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "name": "Jane Doe"
}
], - "postingSettingID": "630",
- "assignedToUserID": "423",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1003",
- "sendStatements": "1",
- "holdDistributions": "1",
- "holdDistributionsDescription": "Awaiting owner tax form",
- "isActive": "1",
- "isLiveLedgerEnabled": "1",
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-16 19:42:55",
- "dateTimeModified": "2026-11-16 19:42:55",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": "Example note."
}
}
]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.
publicUUID) and the code it asks forpublicUUID and publicVerificationCode open the statement's public page without signing in; treat them as secretsportfolio - The statement's portfolio, every columnstatementFiles - The statement's generated files (the statement PDF, and its report, work-order and bill files); empty when there are nonefileAttachments - The files attached to the statement by hand, each with its file record (fileAttachment.objectTypeID is always 15, a statement); empty when there are noneGET /portfolios/statements/{statementID}/download - The statement's files as a ZIP archiveGET /portfolios/statements/{statementID}/download-pdf (undocumented) - The statement's files merged into one PDFGET /portfolios/statements/files/{statementFileID}/download (undocumented) - One generated file, by its statementFileIDGET /portfolios/{portfolioID}/statements - The portfolio's statementsGET /portfolios/statements/search - Statements across portfolios| statementID required | integer Example: 5012 The ID of the statement to retrieve. |
| includes | string Example: includes=statementFiles,fileAttachments Comma-separated list of related data to add to the response: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
Array of objects The statement's generated files. Requires the | |
Array of objects The files attached to the statement by hand. Requires the |
{- "statement": {
- "statementID": "423",
- "statementBatchID": "345",
- "statementSettingID": "1005",
- "portfolioID": "626",
- "name": "04/01/2026 to 04/30/2026",
- "startDate": "2026-04-01",
- "endDate": "2026-04-30",
- "statementPeriodTypeID": "1",
- "statementStatusID": "2",
- "beginningBalance": "1200.50",
- "endingBalance": "1830.25",
- "totalDistributionAmount": "900.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "unpaidBillAmount": "75.10",
- "workOrderEstimateAmount": "40.00",
- "totalIncomeAmount": "2100.00",
- "totalExpenseAmount": "570.25",
- "totalAdjustmentAmount": "-10.00",
- "dateTimeCreated": "2026-11-16 19:42:56",
- "publicUUID": "6a0a1332-fdea-44ef-96de-8696db10b8ff",
- "dateTimeAccessExpires": "2026-11-30 19:42:56",
- "publicVerificationCode": "591652",
- "message": "Thank you for your business."
}, - "portfolio": {
- "portfolioID": "626",
- "code": "PF7303",
- "name": "Contract Statement View 6afb5cc00821b",
- "contacts": [
- {
- "contactID": "291",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "name": "Jane Doe"
}
], - "postingSettingID": "631",
- "assignedToUserID": "424",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1005",
- "sendStatements": "1",
- "holdDistributions": "1",
- "holdDistributionsDescription": "Awaiting owner tax form",
- "isActive": "1",
- "isLiveLedgerEnabled": "1",
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-16 19:42:56",
- "dateTimeModified": "2026-11-16 19:42:56",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": "Example note."
}, - "statementFiles": [
- {
- "statementFileID": "40",
- "statementID": "423",
- "portfolioID": "626",
- "statementFileTypeID": "1",
- "title": "Statement",
- "fileName": "statement_6afb5cc01c730.pdf",
- "fileType": "pdf",
- "fileSize": "3538468",
- "relatedObjectID": "626",
- "dateTimeCreated": "2026-11-16 19:42:56"
}
], - "fileAttachments": [
- {
- "fileAttachment": {
- "fileAttachmentID": "60",
- "fileID": "95",
- "objectTypeID": "15",
- "objectID": "423",
- "isSharedWithOwner": "0",
- "isSharedWithTenant": "0",
- "isSharedWithVendor": "0",
- "isSharedWithApplicant": "0",
- "pathID": "1",
- "portalTypeID": "1",
- "contactID": null,
- "subObjectTypeID": null,
- "relatedObjectTypeID": null,
- "relatedObjectID": null
}, - "file": {
- "fileID": "95",
- "fileSourceID": "5",
- "isAttachable": "0",
- "title": "Statement Batch - 11/16/2026",
- "fileName": "fe65dd50-68db-333c-ad50-db6a57d27e5c.pdf",
- "fileType": "pdf",
- "fileSize": "12616660",
- "userID": "2",
- "isImage": "0",
- "isPublic": "0",
- "previewFileName": null,
- "dateTimeCreated": "2026-11-16 19:42:56"
}
}
]
}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.
Could not add "{title}" to the zip. The file is missing.
and no archiveGET /portfolios/statements/{statementID} - The statement, with its statementFiles and fileAttachmentsGET /portfolios/{portfolioID}/statements - The portfolio's statements| statementID required | integer Example: 5012 The ID of the statement to download. |
| Content-Disposition | string Example: "attachment; filename=\"Owner Packet 04-01-2026-04-30-2026.zip\""
|
| Rentvine-Filename | string Example: "Owner Packet 04-01-2026-04-30-2026.zip" The archive's file name, as in |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "error": "Statement 999999999 not found"
}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.
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 ownerstatementCount still counts every statement in the batchstatementStatusIDs takes
the listed integers onlydateTimeCreated, 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 orderGET /portfolios/statements/batches/{statementBatchID} - One batch, with its statementsGET /portfolios/statements/search - Statements, filterable by batch| 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
|
| dateTimeCreatedMin | string Example: dateTimeCreatedMin=2026-04-01 Only batches created on or after this date ( |
| dateTimeCreatedMax | string Example: dateTimeCreatedMax=2026-04-30 Only batches created before a cut-off this date sets ( |
| pagination-page-size | integer Example: "25" Page size used on a page that holds items -- the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested (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-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object A summary of the batch row, with its statement count. |
required | object The batch's statement setting; both fields are |
[- {
- "statementBatch": {
- "statementBatchID": "318",
- "statementStatusID": "1",
- "statementPeriodTypeID": "1",
- "isAutoPublished": "1",
- "startFromLastStatement": "0",
- "startDate": "2026-10-01",
- "endDate": "2026-10-31",
- "message": "Statements for April",
- "dateTimeCreated": "2026-11-16 19:42:19",
- "name": "Contract Batch 6afb5c9b6ac1d",
- "statementCount": "1"
}, - "statementSetting": {
- "statementSettingID": "966",
- "name": "voluptates nemo eligendi"
}
}
]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.
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
statementBatchIDincludes is a comma-separated list; unknown names are ignoredstatements - 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 nonerestrictions - access: full when the user can reach every portfolio in the batch (always for an unrestricted user), partial otherwiseGET /portfolios/statements/batches/search - Statement batches, with filtersGET /portfolios/statements/search - Statements, filterable by statementBatchIDGET /portfolios/statements/{statementID} - One statement| statementBatchID required | integer Example: 812 The ID of the statement batch to retrieve. |
| includes | string Example: includes=statements,restrictions Comma-separated list of related data to add to the response: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
Array of objects Every statement in the batch. Requires the |
{- "statementBatch": {
- "statementBatchID": "346",
- "statementSettingID": "1007",
- "statementStatusID": "1",
- "statementPeriodTypeID": "1",
- "name": "eos cupiditate reprehenderit Batch",
- "startFromLastStatement": "0",
- "startDate": "2026-10-01",
- "endDate": "2026-10-31",
- "isAutoPublished": "0",
- "sendNotifications": "1",
- "message": null,
- "statementBatchFileStatusID": "2",
- "fileID": null,
- "dateTimeCreated": "2026-11-16 19:42:56"
}, - "restrictions": {
- "access": "full"
}, - "statements": [
- {
- "statement": {
- "statementID": "424",
- "statementBatchID": "346",
- "statementSettingID": "1008",
- "portfolioID": "627",
- "name": "04/01/2026 to 04/30/2026",
- "startDate": "2026-04-01",
- "endDate": "2026-04-30",
- "statementPeriodTypeID": "1",
- "statementStatusID": "2",
- "beginningBalance": "1200.50",
- "endingBalance": "1830.25",
- "totalDistributionAmount": "900.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "unpaidBillAmount": "75.10",
- "workOrderEstimateAmount": "40.00",
- "totalIncomeAmount": "2100.00",
- "totalExpenseAmount": "570.25",
- "totalAdjustmentAmount": "-10.00",
- "dateTimeCreated": "2026-11-16 19:42:56",
- "publicUUID": "9f80f9d3-3a4e-47aa-8506-dbc90f102078",
- "dateTimeAccessExpires": "2026-11-30 19:42:56",
- "publicVerificationCode": "285257",
- "message": "Thank you for your business."
}, - "statementSetting": {
- "statementSettingID": "1008",
- "name": "officiis ut unde",
- "isActive": "1",
- "settings": {
- "statement": {
- "includeBills": 0,
- "includeBillAttachments": 0,
- "includeBillAttachmentsWithMarkup": 0,
- "includeBillAttachmentsWithDiscount": 0,
- "includeWorkOrders": 0,
- "includeWorkOrderAttachments": 0,
- "includeBalanceMessage": 1,
- "combineDiscount": 1,
- "combineMarkup": 1,
- "includePrepayments": 0
}, - "modules": {
- "summary": {
- "isActive": 0,
- "pageBreak": 0
}, - "taxSummary": {
- "isActive": 0,
- "pageBreak": 0,
- "includePrepayments": 0
}, - "transactionSummary": {
- "isActive": 0,
- "includeYearToDate": 1,
- "excludeZeroBalanceAccounts": 0,
- "pageBreak": 0
}, - "transactionDetails": {
- "isActive": 0,
- "pageBreak": 0,
- "isMultiUnitConsolidated": 1,
- "isTransactionConsolidated": 0,
- "isIncomeConsolidated": 1,
- "isManagementFeeConsolidated": 1,
- "propertyTransactionsOrderField": 1,
- "includeTransactionRunningBalance": 0,
- "includePayeePayer": 0,
- "includePropertyReserveAmount": 1,
- "includeNetValues": 1,
- "propertyOrderType": 1
}, - "ledger": {
- "isActive": 0,
- "pageBreak": 0,
- "includePayeePayer": 0
}, - "openWorkOrders": {
- "isActive": 0,
- "pageBreak": 0
}, - "closedWorkOrders": {
- "isActive": 0,
- "pageBreak": 0,
- "includeClosingComments": 0
}, - "unpaidBills": {
- "isActive": 0,
- "pageBreak": 0
}, - "notes": {
- "isActive": 0,
- "pageBreak": 0
}, - "units": {
- "isActive": 0,
- "pageBreak": 0,
- "showBalance": 1,
- "showTenants": 1,
- "showMoveInDate": 1
}
}
}
}, - "portfolio": {
- "portfolioID": "627",
- "code": "PF9301",
- "name": "Contract Batch View 6afb5cc071964",
- "contacts": [
- {
- "contactID": "293",
- "percentOwned": "60.0000",
- "percentDistributed": "50.0000",
- "name": "Jane Doe"
}
], - "postingSettingID": "632",
- "assignedToUserID": "425",
- "minimumDistributionAmount": "25.00",
- "maximumDistributionAmount": "5000.00",
- "reserveAmount": "500.00",
- "additionalReserveAmount": "250.00",
- "additionalReserveDescription": "Roof replacement fund",
- "overdraftOverrideAmount": "100.00",
- "fiscalYearEndMonth": "12",
- "statementSettingID": "1008",
- "sendStatements": "1",
- "holdDistributions": "1",
- "holdDistributionsDescription": "Awaiting owner tax form",
- "isActive": "1",
- "isLiveLedgerEnabled": "1",
- "isBalanceNoticeDisabled": "0",
- "dateTimeCreated": "2026-11-16 19:42:56",
- "dateTimeModified": "2026-11-16 19:42:56",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "isPublicStatementEnabled": "1",
- "dateClosed": null,
- "payOwnersNotes": "Example note."
}, - "restricted": 0
}
]
}A property is a building or lot the account manages, owned by one portfolio at a time. A single-family property has exactly one unit, which carries the property's name and address; a multi-unit property has any number of units. List, search, create, read, update, activate, deactivate and delete properties here; one create makes the property and its units together, and returns the property alone: read the units back with GET /properties/{propertyID}?includes=unit (single-family) or GET /properties/{propertyID}/units.
Returns a page of properties, sorted by name. Each item is keyed by entity: property, plus image and portfolio when included. Use GET /properties/search for more filters and a denormalized row with portfolio, lease and group data.
isActive defaults to 1: only active properties. 0 returns only inactive ones; any other value (all, both) returns both.search is a substring match on name, address, address2, city, stateID and postalCode.pageSize of at least 1.pagination-current-page is at or past pagination-last-page.name, then propertyID.image - the property's primary image recordportfolio - the portfolio record that owns the propertyGET /properties/search - filtered search with portfolio, lease and group data per rowGET /properties/{propertyID} - one property, with more includesPOST /properties - create a property| page | integer Default: 1 The page number for pagination |
| pageSize | integer >= 1 Default: 15 Example: pageSize=50 Items per page, at least 1 (default 15). Values above 5000 are served at 5000. |
| search | string Example: search=Example Street Substring match on |
| isActive | string Default: "1" Example: isActive=0
|
| managementFeeSettingID | integer Example: managementFeeSettingID=2 Only properties that use this management fee setting, from |
| includes | string Example: includes=image,portfolio Comma-separated related records to add to each item: |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
| token | string^[0-9]+$ The current Unix time. Sent only when neither |
object (property_image) The property's primary image. Requires the | |
object (included_portfolio) The portfolio that owns the property. Requires the |
[- {
- "property": {
- "propertyID": "3",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "3",
- "managementFeeSettingID": "3",
- "name": "APITEST-6af0273e72edd A",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2028-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Insurance Co",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:42",
- "dateTimeModified": "2026-11-08 07:39:42",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}, - "token": "1794123582"
}
]Creates a property and its units in one request, and returns the property in the GET /properties/{propertyID} shape (without includes). A single-family property (isMultiUnit 0 or omitted) takes one unit; a multi-unit property takes a units array and an attachments array ([] when there are none).
Properties › CreateProperty).invalid input. when it is empty or {}.property and unit schemas below are read; any other key is ignored.isMultiUnit is 1), the portfolio exists and is inside the API user's portfolio groups, then the property's validators (keyed property.<field>), then each unit's validators (keyed unitContract.unit.<field>).yearBuilt, money fields) and the must-exist checks of every ID field (countryID, the stateID-countryID pair, managementFeeSettingID, salesTaxSettingID, withholdingTaxAgencyID, applicationTemplateID, propertyShowingProviderID, assignedToUserID, defaultMonthToMonthPremiumSettingID, defaultResidentPackageID) are reported together, an unknown managementFeeSettingID as {"property.managementFeeSettingID": ["Management Fee does not exist."]}; the pair's error is keyed property.stateID, countryID, with a space (State does not exist., for a missing stateID as well as an unknown one; runtimes on Phalcon older than 5.21 send the key without the space, so match property.stateID,countryID with or without it). Only once those must-exist checks pass are missing required fields (property.address, property.city and the other … is required messages) reported, so fixing a body can take two round trips.unitContract.unit.<field>, and checking stops at the first unit that fails, so the later units' errors aren't reported.1) and Mobile Home (8) allows isMultiUnit 1: Apartment, Condo, Townhouse, Duplex, Multiplex, Loft, Commercial, Garage and Lot (2-7, 9-11).unit with at least rent: without it the request is refused with {"unitContract.unit.rent": ["Rent is required"]}.name, address, address2, city, stateID and postalCode, whatever the unit sends. The unit's limits then apply to those values: a city longer than 50 characters is refused with {"unitContract.unit.city": ["Cannot exceed 50 characters"]}, although the property alone would take 100.rent, deposit, reserveAmount, maintenanceLimitAmount, the markup amounts, leaseReturnChargeAmount, requiredRentersInsuranceLiabilityAmount) take at most two decimal places.latitude and longitude are geocoded from the address; when geocoding finds nothing they are stored as 0.00000000.reserveAmount defaults to 0.00; requiredRentersInsuranceLiabilityAmount to the account's insurance setting, or 100000.00.addressValidationStatusID starts at 1 (Not Validated).property.<field> or unitContract.unit.<field> error has still sent that address to the geocoding service.assignedToUserID set, sends that user the Property Assigned To User notification.property::property::created webhook event, and unit::unit::created for each unit; a request with the Suppress-Webhooks: 1 header fires none.GET /properties/{propertyID} - read the property back with includesPOST /properties/{propertyID}/units - add units laterGET /portfolios - portfolio IDs for portfolioIDGET /properties - every row's property carries the portfolioID, managementFeeSettingID, countryID and stateID an existing property usesGET /properties/{propertyID}?includes=portfolio,managementFeeSetting - until GET /settings/management-fees (undocumented), GET /countries (undocumented) and GET /states (undocumented) are documented, the valid portfolioID, managementFeeSettingID, countryID and stateID of an existing propertyrequired | object The |
| attachments required | Array of strings or integers[ items^-?[0-9]+$ ] IDs of already uploaded files to link to the new property (multi-unit) or its unit (single-family); an ID with no file is refused with 400. Send it with a multi-unit property, as |
object (unit_for_property_create) The one unit of a single-family property, needed with at least | |
Array of objects The units of a multi-unit property, each with at least |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
{- "property": {
- "propertyTypeID": 1,
- "portfolioID": 32,
- "managementFeeSettingID": 30,
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "county": "Example County",
- "yearBuilt": 2001,
- "maintenanceLimitAmount": "375.00",
- "reserveAmount": "500.00",
- "dateContractBegins": "01/01/2026",
- "leaseReturnChargeAmount": "15.00"
}, - "unit": {
- "rent": "1500.00",
- "deposit": "800.00",
- "beds": 3,
- "fullBaths": 2,
- "halfBaths": 1,
- "size": 1200
}
}{- "property": {
- "propertyID": "30",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "32",
- "managementFeeSettingID": "30",
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": null,
- "legalDescription": null,
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": null,
- "dateWarrantyExpires": null,
- "maintenanceNotes": null,
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": null,
- "markupAmount": null,
- "markupAmountMin": null,
- "markupAmountMax": null,
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": null,
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": null,
- "insuranceAgent": null,
- "insurancePolicyNumber": null,
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": null,
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:47",
- "dateTimeModified": "2026-11-08 07:39:47",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}
}Returns a filtered page of properties, each row denormalized: the property (with unit counts and vacancy), its portfolio, the current lease of a single-family property's unit, its propertyGroup names and its primaryImage.
isActive, active and inactive properties are both returned.1/0/true/false/yes/no, a date it can't parse).propertyIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.pagination-page-size reports the page size or the number of matching items, whichever is smaller. A pageSize of 0 or below is read as 15.pagination-current-page is at or past pagination-last-page.orderBy (default property.property: street name, street number, address 2, city, state), then propertyID. orderBy takes only the columns listed under it.dateTimeModifiedMin and dateTimeModifiedMax are compared in UTC: send them in UTC.lease is set only for a single-family property whose unit has a current lease; it is {leaseID: null, tenants: null} otherwise, and always for a multi-unit property.property.isVacant is 1 when a single-family property's unit has no current lease, 0 when it has one, and null for a multi-unit property.GET /properties - the plain property listGET /properties/{propertyID} - one property, with includesGET /portfolios - portfolio IDs for portfolioIDs[]| page | integer Default: 1 The page number for pagination |
| pageSize | integer <= 5000 Default: 25 Example: pageSize=100 Items per page, at most 5000 (default 25). |
| orderBy | string Example: orderBy=property.name|desc Sort column, optionally followed by |
| search | string Example: search=Example Substring match on the property's name, address, address 2, city and postal code, the portfolio's name, the current lease's tenant names and the portfolio owners' names. Also matches the state code, sent whole ( |
| isActive | string Example: isActive=1
|
| isMultiUnit | string Example: isMultiUnit=0
|
| isVacant | string Example: isVacant=1
|
| isNonRevenue | string Example: isNonRevenue=0
|
| propertyIDs[] | Array of integers Example: propertyIDs[]=101&propertyIDs[]=102 Only these properties. One |
| propertyTypeIDs[] | Array of integers Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Example: propertyTypeIDs[]=1 Only these property types. One
|
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=12 Only properties owned by these portfolios (from |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=3 Only properties whose portfolio belongs to one of these portfolio groups. One |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=1 Only properties in one of these property groups. One |
| assignedToUserIDs[] | Array of integers Example: assignedToUserIDs[]=2 Only properties assigned to one of these users. One |
| propertyManagerIDs[] | Array of integers Deprecated Example: propertyManagerIDs[]=1 Deprecated: only single-family properties whose unit has one of these property manager records. Use |
| tagIDs[] | Array of integers Example: tagIDs[]=4 Only properties tagged with one of these tags. One |
| city | string Example: city=Fort Myers Substring match on the city. |
| stateID | string Example: stateID=FL State code, matched exactly. |
| postalCode | string Example: postalCode=339 Substring match on the postal code. |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-01-01 00:00:00 Only properties modified at or after this time, in UTC. Accepts |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-12-31 23:59:59 Only properties modified at or before this time. Same forms as |
| pagination-page-size | integer Example: "1" On a page that holds items, the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
required | object |
required | object |
required | object |
required | object |
[- {
- "property": {
- "isActive": "1",
- "propertyID": "15",
- "name": "APITEST-6af027409609e",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "portfolioID": "15",
- "propertyTypeID": "1",
- "assignedToUserID": "2",
- "isMultiUnit": "0",
- "dateTimeCreated": "2026-11-08 07:39:44",
- "dateTimeModified": "2026-11-08 07:39:44",
- "dateTimeDeactivated": null,
- "unitCount": "1",
- "activeUnitCount": "1",
- "isVacant": "0"
}, - "portfolio": {
- "portfolioID": "15",
- "name": "Nolan-Erdman Portfolio",
- "contacts": null
}, - "lease": {
- "leaseID": "1",
- "tenants": [
- "Pat Tenant"
]
}, - "propertyGroup": {
- "propertyGroupNames": "APITEST Group"
}, - "primaryImage": {
- "propertyImageID": "1",
- "filePath": "noimage",
- "fileType": "jpg"
}
}
]Returns one property under property, plus one top-level key per requested include.
Access Denied for a property outside those groups' portfolios.Property {propertyID} not found; a value that isn't a number answers the stock 404.units, and property-level workOrders and ledger;unit and everything that hangs off it (lease, leaseBalances, pastLeases, futureLeases, listing, appliances, filters, filterDeliveryConfiguration, filterDeliveryAddress, filterDeliverySchedule, propertyManager), and unit-level workOrders and ledger.unit as well; without it, none is sent. With unit, a property that has no unit row answers 400 Unit not found.leaseBalances needs lease (and so unit) and is sent only when the unit has a current lease; portfolioBalances needs portfolio.lease adds two keys, lease and leaseStatus; listing adds listing and listingFiles.portfolios include also reads the search, isCurrent, portfolioID and orderBy query parameters (below) to filter and sort the ownership history; they do nothing without it.includes list is split on commas without trimming: image, portfolio reads portfolio (with the space) and silently drops it.image - the property's primary imageunits - the units of a multi-unit propertyworkOrders - work orders with their vendor contact: the property's own (no unit) on a multi-unit property, the unit's on a single-family oneledger - the property's ledger (multi-unit) or the unit's ledger (single-family), or nullunit - the unit of a single-family propertylease - the unit's current lease (or null) and its status as leaseStatusleaseBalances - balances of the current leasepastLeases - the unit's closed leases, newest firstfutureLeases - the unit's pending leaseslisting - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFilesappliances - the unit's appliancesfilters - the unit's air filtersfilterDeliveryConfiguration - whether the unit's air-filter delivery is set upfilterDeliveryAddress - the unit's custom filter delivery address, or falsefilterDeliverySchedule - the unit's filter delivery schedule, or falsepropertyManager - the unit's property manager record, or falseportfolio - the owning portfolioportfolioBalances - balances of the owning portfolio's ledgerportfolios - the property's ownership historyowners - the owning portfolio's owners, with their contactsmanagementFeeSetting - the property's management fee settinginspections - the property's inspectionsassociations - the property's homeowners' associations, with their contactsapplicationTemplate - the property's application template, or nullpropertyShowingProvider - the property's showing provider, or nullGET /properties - list propertiesGET /properties/search - search propertiesPOST /properties/{propertyID} - update the propertyDELETE /properties/{propertyID} - delete the propertyGET /properties/{propertyID}/units/{unitID} - a unit, with its own includes| propertyID required | integer Example: 732 The property's ID. |
| includes | string Example: includes=unit,lease,portfolio,owners Comma-separated related records to add: |
| search | string Example: search=Example With |
| isCurrent | integer Enum: 0 1 Example: isCurrent=1 With |
| portfolioID | integer Example: portfolioID=6 With |
| orderBy | string Example: orderBy=propertyPortfolio.isCurrent|desc With |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
object (property_image) Requires the | |
Array of objects Multi-unit property only; requires the | |
Array of objects (work_order_row) Requires the | |
included_ledger (object) or null Requires the | |
object (unit) Single-family property only; requires the | |
included_lease (object) or null The unit's current lease, or null. Requires the | |
object or null The current lease's status, or null. Sent with | |
object (lease_balances) Requires the | |
Array of objects (included_lease) Closed leases, newest first. Requires the | |
Array of objects (included_lease) Pending leases. Requires the | |
object (listing) Requires the | |
Array of objects (listing_file) The listing's files plus the account-wide listing files (null | |
Array of objects (appliance) Requires the | |
Array of objects (filter) Requires the | |
object (filter_delivery_configuration) Requires the | |
filter_delivery_address (object) or false (any) The unit's custom delivery address, or | |
filter_delivery_schedule (object) or false (any) The unit's delivery schedule, or | |
property_manager (object) or false (any) The unit's property manager record, or | |
object (included_portfolio) Requires the | |
object (portfolio_balances) Requires the | |
Array of objects (property_portfolio_row) Ownership history. Requires the | |
Array of objects (owner_row) Requires the | |
object (included_management_fee_setting) Requires the | |
Array of objects (inspection_row) Requires the | |
Array of objects (association_row) Requires the | |
included_template (object) or null Null when the property has no application template. Requires the | |
showing_provider (object) or null Null when the property has no showing provider. Requires the |
{- "property": {
- "propertyID": "24",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "24",
- "managementFeeSettingID": "24",
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2028-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Insurance Co",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:46",
- "dateTimeModified": "2026-11-08 07:39:46",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}
}Updates the fields sent and returns the property in the GET /properties/{propertyID} shape (without includes). Updates take POST only: PUT on this route answers the stock 404.
Properties › UpdateProperty).Access Denied for a property outside those groups' portfolios.invalid input. when it is empty or {}; then a well-formed ID with no property answers 400 Property {propertyID} not found.portfolioID, isActive and isMultiUnit can't be changed here.{"name": ["Name cannot exceed 100 characters"]}).unit.<field>: a city longer than 50 characters is refused with {"unit.city": ["Cannot exceed 50 characters"]}.DELETE /properties/{propertyID}/units/{unitID} allows it) can't be updated: every update answers 400 {"unit": ["No unit found for single family property: "]}.1 and Mobile Home 8).markupPercent and markupAmount can't both be set.deactivationReasonID and deactivationNotes are kept only while the property is inactive: on an active property they are cleared, whatever is sent.name, address, address2, city, stateID and postalCode are overwritten from the property.address, address2, city, stateID, postalCode) is geocoded again, resets addressValidationStatusID to 1 (Not Validated), clears addressValidationData and queues a new validation.reserveAmount recalculates the owning portfolio's reserve amount.propertyTypeID to Commercial (9) clears the unit's beds, fullBaths and halfBaths; switching away from Commercial clears its commercialSpaceTypeID.assignedToUserID sends the new user the Property Assigned To User notification and records a User Assigned activity.property::property::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID} - read the property with includesPOST /properties/{propertyID}/activate and POST /properties/{propertyID}/deactivate - change its status| propertyID required | integer Example: 728 The property's ID. |
| propertyTypeID | string or integer (property_types_request) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" 1 2 3 4 5 6 7 8 9 10 11 The property type, from the fixed list below (no lookup route): the values are the enum. A multi-unit property can't be switched to a type that doesn't allow multiple units.
|
| managementFeeSettingID | string or integer^-?[0-9]+$ The management fee setting, from |
| name | string or null <= 100 characters Display name. |
| countryID | string <= 2 characters Two-letter country code, from |
| address | string [ 1 .. 100 ] characters Street address. A changed address (or |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code of |
| city | string [ 1 .. 100 ] characters City. At most 50 characters on a single-family property, whose unit takes a copy capped at 50. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| county | string or null <= 100 characters County. |
| legalDescription | string or null <= 100 characters Legal description of the lot. |
| maintenanceLimitAmount | string or number or null <decimal> >= 0 Not negative. |
| yearBuilt | string or integer or null^-?[0-9]+$ A positive whole number; empty is stored as null. |
| dateInsuranceExpires | string or null
|
| dateWarrantyExpires | string or null
|
| maintenanceNotes | string or null <= 65535 characters Internal maintenance notes. |
| applicationTemplateID | string or integer or null^-?[0-9]+$ An application template ID; must exist. |
| reserveAmount | string or number or null <decimal> >= 0 Default: "0.00" Not negative; empty is stored as |
| markupPercent | string or number or null <decimal> Maintenance markup percent, 0.1 to 99. Can't be sent together with a non-empty |
| markupAmount | string or number or null <decimal> >= 0 Maintenance markup as a fixed amount. Can't be sent together with a non-empty |
| markupAmountMin | string or number or null <decimal> >= 0
|
| markupAmountMax | string or number or null <decimal> >= 0
|
| dateContractBegins | string or null
|
| dateContractEnds | string or null
|
| commercialClassTypeID | string or integer or null Enum: "1" "2" "3" "4" 1 2 3 4 null Stored only for a Commercial property (
|
| salesTaxSettingID | string or integer or null^-?[0-9]+$ A sales tax setting ID; must exist. |
| withholdingTaxAgencyID | string or integer or null^-?[0-9]+$ A withholding tax agency ID; must exist. |
| insuranceCompany | string or null <= 100 characters The property's insurance carrier. |
| insuranceAgent | string or null <= 100 characters The property's insurance agent. |
| insurancePolicyNumber | string or null <= 50 characters The property's insurance policy number. |
| insuranceContactDetails | string or null <= 500 characters How to reach the insurance carrier or agent. |
| requiredRentersInsuranceLiabilityAmount | string or number or null <decimal> >= 0 Renters insurance liability coverage required of tenants. Not negative. |
| leaseReturnChargeAmount | string or number or null <decimal> >= 0 Not negative; empty or |
| defaultMonthToMonthPremiumSettingID | string or integer or null^-?[0-9]+$ A month-to-month premium setting ID; must exist. |
| defaultResidentPackageID | string or integer or null^-?[0-9]+$ A resident package ID; must exist. |
| propertyShowingProviderID | string or integer or null^-?[0-9]+$ A configured showing provider ID; must exist. |
| deactivationReasonID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" "7" "8" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "98" "99" 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 98 99 null Kept only while the property is inactive; an active property's reason is always cleared. Labels as on the response. |
| deactivationNotes | string or null <= 65535 characters Kept only while the property is inactive. |
| assignedToUserID | string or integer or null^-?[0-9]+$ The user to assign the property to; must exist. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
{- "name": "APITEST Cedar House",
- "address": "123 Main St",
- "maintenanceLimitAmount": "400.00",
- "yearBuilt": 1998,
- "dateWarrantyExpires": "12/31/2029",
- "insuranceCompany": "Example Mutual"
}{- "property": {
- "propertyID": "33",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "36",
- "managementFeeSettingID": "33",
- "name": "APITEST Cedar House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "400.00",
- "yearBuilt": "1998",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2029-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Mutual",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:49",
- "dateTimeModified": "2026-11-08 07:39:49",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}
}Permanently deletes a property with its units and everything attached to them, and returns the deleted property as it was (a bare property object, not wrapped in property). Refused while any accounting, inspection, lease or application history references the property or one of its units; deactivate it instead.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.Property {propertyID} not found.transactions), transaction entries (transactionEntries), archived transaction entries (transactionEntryArchives), bills (bills), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases). Voided transactions still count.DELETE /properties/{propertyID}/units/{unitID} deletes it, and its blockers answer the same 400 with a unit. prefix: unit.transactions, unit.transactionEntries, unit.inspections, unit.inspectionAreas, unit.leases, unit.applications, unit.applicants. A unit with no ledger answers {"unit.ledger": ["Unit ledger not found"]}.DELETE /properties/{propertyID}/units/{unitID} removes (its ledger, work orders, recurring work orders, appliances, access points, features, images, listings and leads).property::property::deleted webhook event, and unit::unit::deleted for each unit; a request with the Suppress-Webhooks: 1 header fires none.POST /properties/{propertyID}/deactivate - deactivate the property insteadDELETE /properties/{propertyID}/units/{unitID} - delete one unit| propertyID required | integer Example: 728 The property's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| propertyID required | string^-?[0-9]+$ Unique identifier. |
| propertyImageID required | string^-?[0-9]+$ The property's primary image ( |
| propertyTypeID required | string (property_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11"
|
| isMultiUnit required | string Enum: "0" "1"
|
| isActive required | string Enum: "0" "1"
|
| portfolioID required | string^-?[0-9]+$ The portfolio that currently owns the property. |
| managementFeeSettingID required | string^-?[0-9]+$ The management fee setting the property uses. |
| name required | string or null <= 100 characters |
| countryID required | string <= 2 characters Two-letter country code. |
| address required | string <= 100 characters Full formatted street address. |
| streetNumber required | string or null^-?[0-9]+$ Leading street number parsed from |
| streetName required | string or null <= 100 characters
|
| address2 required | string or null <= 100 characters |
| stateID required | string <= 3 characters Two-letter state or province code. |
| city required | string <= 100 characters |
| postalCode required | string or null <= 20 characters |
| latitude required | string <decimal> Geocoded on create and when the address changes; |
| longitude required | string <decimal> Geocoded on create and when the address changes; |
| addressValidationStatusID required | string (address_validation_statuses) Enum: "1" "2" "3" "4" Result of the last address validation. Reset to
|
required | address_validation_data (object) or null The last address-validation verdict, or null before the first run and after a reset. |
| county required | string or null <= 100 characters |
| assignedToUserID required | string or null^-?[0-9]+$ The user the property is assigned to (its property manager), or null. |
| legalDescription required | string or null <= 200 characters Legal description of the lot. The column holds 200 characters, but create and update take at most 100. |
| maintenanceLimitAmount required | string or null <decimal> Spend limit before maintenance needs approval. |
| yearBuilt required | string or null^-?[0-9]+$ |
| dateInsuranceExpires required | string or null <date> |
| dateWarrantyExpires required | string or null <date> |
| maintenanceNotes required | string or null |
| applicationTemplateID required | string or null^-?[0-9]+$ ID of the template this record points to. |
| reserveAmount required | string <decimal> Owner reserve held for the property. |
| markupPercent required | string or null <decimal> Maintenance markup as a percent. Never set together with |
| markupAmount required | string or null <decimal> Maintenance markup as a fixed amount. Never set together with |
| markupAmountMin required | string or null <decimal> |
| markupAmountMax required | string or null <decimal> |
| dateContractBegins required | string or null <date> |
| dateContractEnds required | string or null <date> |
required | commercial_class_types (string) or null Commercial building class; always null unless the property type is Commercial ( |
| salesTaxSettingID required | string or null^-?[0-9]+$ ID of the sales tax setting this record points to. |
| withholdingTaxAgencyID required | string or null^-?[0-9]+$ ID of the withholding tax agency this record points to. |
| insuranceCompany required | string or null <= 100 characters |
| insuranceAgent required | string or null <= 100 characters |
| insurancePolicyNumber required | string or null <= 50 characters |
| requiredRentersInsuranceLiabilityAmount required | string <decimal> Renters insurance liability coverage required of tenants. Defaults on create to the account's insurance setting, or 100000.00. |
| insuranceContactDetails required | string or null <= 500 characters |
| leaseReturnChargeAmount required | string or null <decimal> Default NSF/returned-payment charge for the property's leases. |
| defaultMonthToMonthPremiumSettingID required | string or null^-?[0-9]+$ ID of the month to month premium setting this record points to. |
| defaultResidentPackageID required | string or null^-?[0-9]+$ ID of the package this record points to. |
| propertyShowingProviderID required | string or null^-?[0-9]+$ The showing provider configured for the property, or null for the account default. |
| dateTimeCreated required | string UTC, formatted |
| dateTimeModified required | string UTC, formatted |
| dateTimeDeactivated required | string or null UTC, formatted |
required | deactivation_reasons (string) or null Why the property was deactivated. Null while active. |
| deactivationNotes required | string or null |
| isFromImport required | string Enum: "0" "1"
|
| importSourceKey required | string or null <= 100 characters The import's key for the row, or null. |
{- "propertyID": "75",
- "propertyImageID": "1",
- "propertyTypeID": "1",
- "isMultiUnit": "0",
- "isActive": "1",
- "portfolioID": "86",
- "managementFeeSettingID": "75",
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2028-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Insurance Co",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:40:47",
- "dateTimeModified": "2026-11-08 07:40:47",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}Sets the property inactive, with a reason, and returns it in the GET /properties/{propertyID} shape (without includes). Its units are deactivated with it.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.{} is refused with invalid input., even though both fields are optional. Then a well-formed ID with no property answers 400 Property {propertyID} not found.deactivationReasonID, the reason is stored as 99 (Unknown).{"unit": ["No unit found for single family property: "]}.{"unit.leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}. Close the lease first.dateTimeDeactivated and recalculates the owning portfolio's reserve amount.property::property::updated webhook event, and unit::unit::updated for each unit whose status changes; a request with the Suppress-Webhooks: 1 header fires none.POST /properties/{propertyID}/activate - reactivate the propertyDELETE /properties/{propertyID} - delete a property that has no history| propertyID required | integer Example: 707 The property's ID. |
| deactivationReasonID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" "7" "8" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "98" "99" 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 98 99 null Why the property is deactivated; defaults to
|
| deactivationNotes | string or null <= 65535 characters Free-text notes about the deactivation. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
{- "deactivationReasonID": 1,
- "deactivationNotes": "Example note."
}{- "property": {
- "propertyID": "47",
- "propertyImageID": "1",
- "propertyTypeID": "2",
- "isMultiUnit": "1",
- "isActive": "0",
- "portfolioID": "52",
- "managementFeeSettingID": "47",
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2028-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Insurance Co",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:54",
- "dateTimeModified": "2026-11-08 07:39:54",
- "dateTimeDeactivated": "2026-11-08 07:39:54",
- "deactivationReasonID": "1",
- "deactivationNotes": "Example note.",
- "isFromImport": "0",
- "importSourceKey": null
}
}Sets the property active and returns it in the GET /properties/{propertyID} shape (without includes). Takes no body.
Properties › ChangeStatusProperty).Access Denied for a property outside those groups' portfolios.Property {propertyID} not found.{"unit": ["No unit found for single family property: "]}.activateUnit=1 every unit is activated too, but only when the property was inactive; on an already active property the units keep their status. Without it the units keep their status.activateUnit says, but only when the property was inactive.dateTimeDeactivated, deactivationReasonID and deactivationNotes.property::property::updated webhook event, and unit::unit::updated for each unit whose status changes; a request with the Suppress-Webhooks: 1 header fires none.POST /properties/{propertyID}/deactivate - deactivate the propertyPOST /properties/units/{unitID}/activate - activate one unit| propertyID required | integer Example: 707 The property's ID. |
| activateUnit | integer Default: 0 Enum: 0 1 Example: activateUnit=1
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (property) A property: a building or lot the account manages. A single-family property has exactly one unit, kept in sync with the property's name and address; a multi-unit property has any number of units. Every column of the row is sent, |
{- "property": {
- "propertyID": "42",
- "propertyImageID": "1",
- "propertyTypeID": "2",
- "isMultiUnit": "1",
- "isActive": "1",
- "portfolioID": "47",
- "managementFeeSettingID": "42",
- "name": "APITEST Maple House",
- "countryID": "US",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "county": "Example County",
- "assignedToUserID": "2",
- "legalDescription": "Lot 4, Block 2, Example Subdivision",
- "maintenanceLimitAmount": "375.00",
- "yearBuilt": "2001",
- "dateInsuranceExpires": "2027-06-30",
- "dateWarrantyExpires": "2028-12-31",
- "maintenanceNotes": "Example note.",
- "applicationTemplateID": null,
- "reserveAmount": "500.00",
- "markupPercent": "5.0000",
- "markupAmount": null,
- "markupAmountMin": "25.00",
- "markupAmountMax": "150.00",
- "dateContractBegins": "2026-01-01",
- "dateContractEnds": "2027-12-31",
- "commercialClassTypeID": null,
- "salesTaxSettingID": null,
- "withholdingTaxAgencyID": null,
- "insuranceCompany": "Example Insurance Co",
- "insuranceAgent": "Pat Example",
- "insurancePolicyNumber": "POL-0001",
- "requiredRentersInsuranceLiabilityAmount": "100000.00",
- "insuranceContactDetails": "555-0100",
- "leaseReturnChargeAmount": "15.00",
- "defaultMonthToMonthPremiumSettingID": null,
- "defaultResidentPackageID": null,
- "propertyShowingProviderID": null,
- "dateTimeCreated": "2026-11-08 07:39:53",
- "dateTimeModified": "2026-11-08 07:39:53",
- "dateTimeDeactivated": null,
- "deactivationReasonID": null,
- "deactivationNotes": null,
- "isFromImport": "0",
- "importSourceKey": null
}
}A unit is one rentable space of a property, with its market rent, deposit and layout, and the lease currently on it. List, create, read, update, activate, deactivate and delete a property's units here.
Returns a page of the property's units. Each item is keyed by entity: unit, plus property, image, propertyImage and propertyManager when included, or token when none of them is.
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.unitID, a stable order for paging; no other order can be asked for.pageSize and a page of at least 1.pagination-current-page is at or past pagination-last-page.propertyImage needs property as well: send them together.property, image drops image).property - the unit's propertyimage - the unit's primary imagepropertyImage - 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 includesPOST /properties/{propertyID}/units - add a unitGET /properties/{propertyID} - the property| propertyID required | integer >= 1 Example: 707 The property's ID, from |
| 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 |
| isActive | string Default: "1" Example: isActive=0
|
| includes | string Example: includes=property,image Comma-separated related records to add to each item, with no spaces: |
| pagination-page-size | integer Example: "20" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
| token | string^[0-9]+$ The current Unix time. Sent only when none of |
object (property) Requires the | |
object (property_image) The unit's primary image. Requires the | |
object (property_image) The property's primary image. Requires the | |
object The unit's property manager record; every field is null when the unit has none. Requires the |
[- {
- "unit": {
- "unitID": "64",
- "propertyID": "79",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:14",
- "dateTimeModified": "2026-11-08 07:44:14",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}, - "token": "1794123854"
}
]Adds a unit to the property and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes).
Properties › UpdateProperty).invalid input. when it is empty or {}.propertyID in the body is ignored, as is any key not in the schema below.address, city, stateID and rent are required.size is stored as null.{"propertyID": ["Unit already exists on property"]}.[] as the body.addressValidationStatusID starts at 1).unit::unit::created webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID}/units - list the property's unitsGET /properties/{propertyID}/units/{unitID} - read the unit with includesDELETE /properties/{propertyID}/units/{unitID} - delete a unit| propertyID required | integer Example: 548 The property to add the unit to. |
| address required | string <= 100 characters Street address; the leading number is split into |
| stateID required | string <= 3 characters State or province code, from |
| city required | string <= 50 characters City. |
| rent required | string or number <decimal> >= 0 Market rent. Not negative. |
| name | string or null <= 100 characters Display name. |
| streetNumber | string or integer or null^-?[0-9]+$ Overwritten from |
| streetName | string or null Overwritten from |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. |
| fullBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| halfBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| commercialSpaceTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" 1 2 3 4 5 6 7 8 9 null Kept only on a Commercial property. Labels as on the unit response. |
| isNonRevenue | string or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| attachments | Array of strings or integers[ items^-?[0-9]+$ ] IDs of already uploaded files to link to the new unit. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
{- "name": "Unit 1A",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "rent": "1500.00",
- "deposit": "800.00",
- "size": 1200,
- "beds": 3,
- "fullBaths": 2,
- "halfBaths": 1,
- "entryInstructions": "Use the side gate"
}{- "unit": {
- "unitID": "79",
- "propertyID": "94",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:18",
- "dateTimeModified": "2026-11-08 07:44:18",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": null,
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": null,
- "maintenanceNotes": null
}
}Returns one unit under unit, plus one top-level key per requested include.
Access Denied for a unit of a property outside those groups' portfolios.unitID with no unit, or a unit that belongs to another property, answers 400 Unit {unitID} not found; a value that isn't a number answers the stock 404.propertyImage, portfolio, associations, 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.property - the unit's propertypropertyImage - the property's primary imageportfolio - the property's owning portfolioportfolioBalances - balances of the portfolio's ledgerowners - the portfolio's owners, with their contactsassociations - the property's homeowners' associations, with their contactsimage - the unit's primary imagelease - the unit's current lease, or nullleaseBalances - balances of the current leasepastLeases - the unit's closed leasesfutureLeases - the unit's pending leaseslisting - the unit's listing (an unsaved, mostly empty one when none exists) and its files as listingFilesappliances - the unit's appliancesfilters - the unit's air filtersfilterDeliveryConfiguration - whether the unit's air-filter delivery is set upfilterDeliveryAddress - the unit's custom filter delivery address, or falsefilterDeliverySchedule - the unit's filter delivery schedule, or falsemanagementFeeSetting - the property's management fee setting (send it with property)workOrders - the unit's work orders, with their vendor contactinspections - the unit's inspectionspropertyManager - the unit's property manager record, or falseledger - the unit's ledger, or nullGET /properties/{propertyID}/units - list the property's unitsPOST /properties/{propertyID}/units/{unitID} - update the unitDELETE /properties/{propertyID}/units/{unitID} - delete the unitGET /properties/{propertyID} - the property| propertyID required | integer Example: 707 The unit's property, from |
| unitID required | integer Example: 585 The unit's ID, from |
| includes | string Example: includes=property,lease,listing Comma-separated related records to add, with no spaces ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
object (property) Requires the | |
property_image (object) or null The property's primary image, or null when its image row no longer exists. Requires the | |
object (included_portfolio) Requires the | |
object (portfolio_balances) Requires the | |
Array of objects (owner_row) Requires the | |
Array of objects (association_row) Requires the | |
property_image (object) or null The unit's primary image, or null when its image row no longer exists. Requires the | |
included_lease (object) or null The unit's current lease, or null. Requires the | |
object (lease_balances) Requires the | |
object (filter_delivery_configuration) Requires the | |
Array of objects (included_lease) Closed leases. Requires the | |
Array of objects (included_lease) Pending leases. Requires the | |
object (listing) Requires the | |
Array of objects (listing_file) The listing's files plus the account-wide listing files (null | |
Array of objects (appliance) Requires the | |
Array of objects (filter) Requires the | |
filter_delivery_address (object) or false (any) The unit's custom delivery address, or | |
filter_delivery_schedule (object) or false (any) The unit's delivery schedule, or | |
object (included_management_fee_setting) The property's management fee setting. Requires the | |
Array of objects (work_order_row) Requires the | |
Array of objects (inspection_row) Requires the | |
property_manager (object) or false (any) The unit's property manager record, or | |
included_ledger (object) or null The unit's ledger, or null. Requires the |
{- "unit": {
- "unitID": "73",
- "propertyID": "86",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:16",
- "dateTimeModified": "2026-11-08 07:44:16",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}
}Updates the fields sent and returns the unit in the GET /properties/{propertyID}/units/{unitID} shape (without includes). PUT on the same route does exactly the same (updateUnitPut).
Properties › UpdateProperty).invalid input. when it is empty or {}; then a well-formed unitID with no unit answers 400 Unit {unitID} not found.unitID alone: the propertyID in the path isn't checked against it.Access Denied for a unit of a property outside those groups' portfolios.propertyManagerID can't be changed: a non-empty value other than the stored one is refused with a 400, and that check runs before every other, so it comes back alone ({"propertyManagerID": ["Deprecated Field: …"]}) whatever else the body gets wrong. An empty or null value clears the stored one.nonRevenueTypeID is required when isNonRevenue is 1; nonRevenueTypeID and nonRevenueStartDate are cleared when it is 0.size ("" or 0) is stored as null.YYYY-MM-DD or MM/DD/YYYY and are returned as YYYY-MM-DD.name, address, address2, city, stateID and postalCode are written to the property too.filterDeliveryScheduleID, filterDeliveryAddressTypeID or filterDeliveryAddressID re-syncs the active lease's Filter Delivery subscriptions: a pending one may start, and a live one gets the new address or schedule.unit::unit::updated webhook event; a request with the Suppress-Webhooks: 1 header doesn't.GET /properties/{propertyID}/units/{unitID} - read the unit with includesPOST /properties/units/{unitID}/activate and POST /properties/units/{unitID}/deactivate - change its status| propertyID required | integer Example: 548 The unit's property (not checked against the unit). |
| unitID required | integer Example: 716 The unit's ID. |
| name | string or null <= 100 characters Display name. |
| address | string <= 100 characters Street address. A change resets address validation; on a single-family property the new address is also written to the property. |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code, from |
| city | string <= 50 characters City. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| rent | string or number <decimal> >= 0 Market rent. Not negative. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. |
| fullBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| halfBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| propertyManagerID | string or integer or null^-?[0-9]+$ Deprecated and read-only in practice. Sending a value different from the stored one (other than empty) is refused with a 400; use the property's |
| commercialSpaceTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" 1 2 3 4 5 6 7 8 9 null Kept only on a Commercial property. Labels as on the unit response. |
| isNonRevenue | string or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| isUtilityBillingEnabled | string or integer Enum: "0" "1" 0 1
|
| filterDeliveryScheduleID | string or integer or null^-?[0-9]+$ An air-filter delivery schedule ID; must exist. |
| filterDeliveryAddressTypeID | string or integer or null Enum: "1" "2" 1 2 null
|
| filterDeliveryAddressID | string or integer or null^-?[0-9]+$ Required when |
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
{- "name": "Unit 1B",
- "rent": "1650.00",
- "size": "",
- "isNonRevenue": 1,
- "nonRevenueTypeID": 1,
- "nonRevenueStartDate": "04/23/2026",
- "isUtilityBillingEnabled": 0
}{- "unit": {
- "unitID": "82",
- "propertyID": "101",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1B",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1650.00",
- "deposit": "800.00",
- "size": null,
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "1",
- "nonRevenueTypeID": "1",
- "nonRevenueStartDate": "2026-04-23",
- "isUtilityBillingEnabled": "0",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:20",
- "dateTimeModified": "2026-11-08 07:44:20",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}
}The same update as POST /properties/{propertyID}/units/{unitID}, sent with PUT: the same partial body, rules, side effects and responses. It is not a full replacement: keys left out keep their values.
Properties › UpdateProperty).POST /properties/{propertyID}/units/{unitID} applies.POST /properties/{propertyID}/units/{unitID} - the same update with POST| propertyID required | integer Example: 548 The unit's property (not checked against the unit). |
| unitID required | integer Example: 716 The unit's ID. |
| name | string or null <= 100 characters Display name. |
| address | string <= 100 characters Street address. A change resets address validation; on a single-family property the new address is also written to the property. |
| address2 | string or null <= 100 characters Second address line (suite, unit). |
| stateID | string <= 3 characters State or province code, from |
| city | string <= 50 characters City. |
| postalCode | string or null <= 20 characters Postal (ZIP) code. |
| rent | string or number <decimal> >= 0 Market rent. Not negative. |
| deposit | string or number or null <decimal> >= 0 Market security deposit; not negative. |
| size | string or integer or null^([0-9]+)?$ Square feet, not negative. An empty value ( |
| beds | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 (studio) to 10; defaults to 0. Ignored (stored as null) on a Commercial property. |
| fullBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| halfBaths | string or integer or null Enum: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" 0 1 2 3 4 5 6 7 8 9 10 null 0 to 10; defaults to 0. Ignored on a Commercial property. |
| propertyManagerID | string or integer or null^-?[0-9]+$ Deprecated and read-only in practice. Sending a value different from the stored one (other than empty) is refused with a 400; use the property's |
| commercialSpaceTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" 1 2 3 4 5 6 7 8 9 null Kept only on a Commercial property. Labels as on the unit response. |
| isNonRevenue | string or integer Default: 0 Enum: "0" "1" 0 1
|
| nonRevenueTypeID | string or integer or null Enum: "1" "2" "3" "4" "5" "6" 1 2 3 4 5 6 null Required when |
| nonRevenueStartDate | string or null
|
| isUtilityBillingEnabled | string or integer Enum: "0" "1" 0 1
|
| filterDeliveryScheduleID | string or integer or null^-?[0-9]+$ An air-filter delivery schedule ID; must exist. |
| filterDeliveryAddressTypeID | string or integer or null Enum: "1" "2" 1 2 null
|
| filterDeliveryAddressID | string or integer or null^-?[0-9]+$ Required when |
| leaseNotes | string or null Internal notes shown on the unit's leases. |
| entryInstructions | string or null Entry instructions for residents and staff. |
| vendorEntryInstructions | string or null Entry instructions for vendors. |
| maintenanceNotes | string or null Internal maintenance notes. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
{- "name": "Unit 1B",
- "rent": "1650.00",
- "size": "",
- "isNonRevenue": 1,
- "nonRevenueTypeID": 1,
- "nonRevenueStartDate": "04/23/2026",
- "isUtilityBillingEnabled": 0
}{- "unit": {
- "unitID": "82",
- "propertyID": "101",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1B",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1650.00",
- "deposit": "800.00",
- "size": null,
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "1",
- "nonRevenueTypeID": "1",
- "nonRevenueStartDate": "2026-04-23",
- "isUtilityBillingEnabled": "0",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:20",
- "dateTimeModified": "2026-11-08 07:44:20",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}
}Permanently deletes a unit and everything attached to it, and returns the deleted unit as it was (a bare unit object, not wrapped in unit). Refused while any accounting, lease, application or inspection history references the unit; deactivate it instead. Deleting the only unit of a single-family property is allowed, and leaves a property that can no longer be updated, activated or deactivated (400 {"unit": ["No unit found for single family property: "]}) and whose GET with includes=unit answers 400 Unit not found: delete the property instead.
Properties › ChangeStatusProperty).unitID with no unit, or a unit of another property, answers 400 Unit {unitID} not found.Access Denied for a unit of a property outside those groups' portfolios.transactions), transaction entries (transactionEntries), inspections (inspections), inspection areas (inspectionAreas), leases of any status (leases), applications (applications), applicants (applicants). Voided and closed records still count.unit::unit::deleted webhook event; a request with the Suppress-Webhooks: 1 header doesn't.POST /properties/units/{unitID}/deactivate - deactivate the unit insteadDELETE /properties/{propertyID} - delete the whole property| propertyID required | integer Example: 548 The unit's property; must match the unit. |
| unitID required | integer Example: 716 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| unitID required | string^-?[0-9]+$ Unique identifier. |
| propertyID required | string^-?[0-9]+$ The property the unit belongs to. |
| propertyImageID required | string^-?[0-9]+$ The unit's primary image ( |
| isActive required | string Enum: "0" "1"
|
| name required | string or null <= 100 characters Unit name/number. |
| address required | string <= 100 characters |
| streetNumber required | string or null^-?[0-9]+$ The first word of |
| streetName required | string or null <= 100 characters
|
| address2 required | string or null <= 100 characters |
| stateID required | string <= 3 characters Two-letter state or province code. |
| city required | string <= 100 characters |
| postalCode required | string or null <= 20 characters |
| latitude required | string <decimal> Geocoded on create (multi-unit property) or copied from the property; |
| longitude required | string <decimal> Geocoded on create (multi-unit property) or copied from the property; |
| addressValidationStatusID required | string (address_validation_statuses) Enum: "1" "2" "3" "4" Result of the last address validation. Reset to
|
required | address_validation_data (object) or null The last address-validation verdict, or null before the first run and after a reset. |
| rent required | string <decimal> Market rent. |
| deposit required | string or null <decimal> Market security deposit. |
| size required | string or null^-?[0-9]+$ Size in square feet. |
required | property_beds (string) or null Bedrooms ( |
required | property_baths (string) or null Full bathrooms. Null on a Commercial property. |
required | property_baths (string) or null Half bathrooms. Null on a Commercial property. |
| leaseID required | string or null^-?[0-9]+$ The unit's current lease, or null when vacant. |
| propertyManagerID required | string or null^-?[0-9]+$ Deprecated: the unit's property manager record; no longer editable (use the property's |
required | commercial_space_types (string) or null Commercial space type; always null unless the property type is Commercial (
|
| isNonRevenue required | string Enum: "0" "1"
|
required | non_revenue_types (string) or null Why the unit is non-revenue; null unless
|
| nonRevenueStartDate required | string or null <date> When the unit became non-revenue; null unless |
| isUtilityBillingEnabled required | string Enum: "0" "1"
|
| filterDeliveryScheduleID required | string or null^-?[0-9]+$ The air-filter delivery schedule, or null. |
required | filter_delivery_address_types (string) or null Where air filters are delivered, or null when not configured.
|
| filterDeliveryAddressID required | string or null^-?[0-9]+$ The custom filter delivery address; null unless |
| dateTimeCreated required | string UTC, formatted |
| dateTimeModified required | string UTC, formatted |
| dateTimeDeactivated required | string or null UTC, formatted |
| isFromImport required | string Enum: "0" "1"
|
| importSourceKey required | string or null <= 100 characters The import's key for the row, or null. |
| leaseNotes required | string or null |
| entryInstructions required | string or null Resident-facing entry instructions. |
| vendorEntryInstructions required | string or null Vendor-facing entry instructions. |
| maintenanceNotes required | string or null |
{- "unitID": "92",
- "propertyID": "112",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:22",
- "dateTimeModified": "2026-11-08 07:44:22",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}Sets the unit active and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes). Takes no body.
Properties › ChangeStatusProperty).Access Denied for a unit of a property outside those groups' portfolios.Unit {unitID} not found.{"property": ["Property is not active"]}.dateTimeDeactivated.unit::unit::updated webhook event (and property::property::updated when the property's status changes with it); a request with the Suppress-Webhooks: 1 header fires none.POST /properties/units/{unitID}/deactivate - deactivate the unitPOST /properties/{propertyID}/activate - activate the property (and optionally all its units)GET /properties/{propertyID}/units/{unitID} - read the unit| unitID required | integer Example: 528 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
{- "unit": {
- "unitID": "96",
- "propertyID": "118",
- "propertyImageID": "1",
- "isActive": "1",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:24",
- "dateTimeModified": "2026-11-08 07:44:24",
- "dateTimeDeactivated": null,
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}
}Sets the unit inactive and returns it in the GET /properties/{propertyID}/units/{unitID} shape (without includes), with isActive 0 and dateTimeDeactivated set. Takes no body.
Properties › ChangeStatusProperty).Access Denied for a unit of a property outside those groups' portfolios.Unit {unitID} not found.{"leaseID": ["Cannot deactivate a unit with an active lease. Must close the lease first."]}.99, Unknown), and so are the property's own active recurring work orders.unit::unit::updated webhook event (and property::property::updated when the property's status changes with it); a request with the Suppress-Webhooks: 1 header fires none.POST /properties/units/{unitID}/activate - reactivate the unitPOST /properties/{propertyID}/deactivate - deactivate the whole propertyDELETE /properties/{propertyID}/units/{unitID} - delete a unit that has no history| unitID required | integer Example: 528 The unit's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (unit) A unit: one rentable space of a property. A single-family property's one unit carries the property's name and address, mirrored both ways on update. Every column of the row is sent, |
{- "unit": {
- "unitID": "101",
- "propertyID": "123",
- "propertyImageID": "1",
- "isActive": "0",
- "name": "Unit 1A",
- "address": "123 Main St",
- "streetNumber": "123",
- "streetName": "Main St",
- "address2": "Apt 4",
- "stateID": "FL",
- "city": "Springfield",
- "postalCode": "12345",
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "addressValidationStatusID": "1",
- "addressValidationData": null,
- "rent": "1500.00",
- "deposit": "800.00",
- "size": "1200",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "leaseID": null,
- "propertyManagerID": null,
- "commercialSpaceTypeID": null,
- "isNonRevenue": "0",
- "nonRevenueTypeID": null,
- "nonRevenueStartDate": null,
- "isUtilityBillingEnabled": "1",
- "filterDeliveryScheduleID": null,
- "filterDeliveryAddressTypeID": null,
- "filterDeliveryAddressID": null,
- "dateTimeCreated": "2026-11-08 07:44:26",
- "dateTimeModified": "2026-11-08 07:44:26",
- "dateTimeDeactivated": "2026-11-08 07:44:26",
- "isFromImport": "0",
- "importSourceKey": null,
- "leaseNotes": "Example note.",
- "entryInstructions": "Use the side gate",
- "vendorEntryInstructions": "Call ahead",
- "maintenanceNotes": "Example note."
}
}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.
Returns the account's whole REP service catalog (resident_services), each service under service, ordered by name.
residentServiceStatusID=1)search matches any part of the service name. Without filters, every service is returned whatever its status.3x filters on 3, while 0 and a value with no digits are ignored.POST /resident/services - create a serviceGET /resident/services/{residentServiceID} - retrieve a single serviceGET /resident/packages - the packages these services can be bundled into| search | string Example: search=Pest 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 ( |
| 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 ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (service) A REP (Resident Experience Package) service definition — a per-account catalog entry in
|
[- {
- "service": {
- "residentServiceID": "31",
- "serviceTypeID": "1",
- "name": "Contract Air Filters",
- "description": "Officiis expedita mollitia quisquam assumenda.",
- "recurringChargeDescription": "rerum praesentium ipsa",
- "recurringChargeAccountID": null,
- "defaultRecurringChargeAmount": "13.21",
- "salePrice": "0.00",
- "residentServiceStatusID": "3",
- "dateTimeCreated": "2026-11-16 19:26:35",
- "dateTimeModified": "2026-11-16 19:26:35"
}
}, - {
- "service": {
- "residentServiceID": "30",
- "serviceTypeID": "1",
- "name": "Contract Window Washing",
- "description": "Quo rerum quia odio optio non.",
- "recurringChargeDescription": "autem tenetur voluptas",
- "recurringChargeAccountID": "127",
- "defaultRecurringChargeAmount": "42.50",
- "salePrice": "4.25",
- "residentServiceStatusID": "1",
- "dateTimeCreated": "2026-11-16 19:26:35",
- "dateTimeModified": "2026-11-16 19:26:35"
}
}
]Creates a REP service in the account catalog.
name is required for a Custom service (serviceTypeID = 1); a system service may omit it.defaultRecurringChargeAmount must be greater than 0.00.recurringChargeAccountID must reference a charge-type GL account.| serviceTypeID required | string or integer^-?[0-9]+$ Service type: |
| name | string Display name (required for Custom; optional for system types). |
| description | string Optional resident-facing description. |
| recurringChargeDescription | string Ledger-line text for the recurring charge. |
| recurringChargeAccountID | string or integer^-?[0-9]+$ GL account the recurring charge posts to. |
| defaultRecurringChargeAmount | string or number <decimal> Default monthly retail amount (greater than 0). |
| isActive | string or integer Enum: "0" "1" 0 1 Whether the service is offered. Defaults to |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string (resident_service_types) Enum: "1" "2" "3" "4" "5" "6" "7"
|
| 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 |
| 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. |
| residentServiceStatusID required | string (resident_service_statuses) Enum: "1" "2" "3"
|
| dateTimeCreated required | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified required | string or null Timestamp when the service was last modified. UTC, formatted |
{- "serviceTypeID": "1",
- "name": "Premium Lawn Care",
- "description": "Weekly lawn service.",
- "recurringChargeDescription": "Lawn Care",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "30.00",
- "isActive": "1"
}{- "residentServiceID": "3",
- "serviceTypeID": "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"
}Returns one REP service from the account catalog: the service row itself, with no wrapper key.
GET /resident/services - list the catalogPOST /resident/services/{residentServiceID} - update the serviceDELETE /resident/services/{residentServiceID} - delete the service| residentServiceID required | integer Example: 3 ID of the resident service. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string (resident_service_types) Enum: "1" "2" "3" "4" "5" "6" "7"
|
| 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 |
| 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. |
| residentServiceStatusID required | string (resident_service_statuses) Enum: "1" "2" "3"
|
| dateTimeCreated required | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified required | string or null Timestamp when the service was last modified. UTC, formatted |
{- "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"
}Updates a REP service.
serviceTypeID is immutable — it cannot be changed once the service exists.name remains required for a Custom service.| residentServiceID required | integer Example: 3 ID of the resident service. |
| name | string |
| description | string |
| recurringChargeDescription | string |
| recurringChargeAccountID | string or integer^-?[0-9]+$ |
| defaultRecurringChargeAmount | string or number <decimal> |
| isActive | string or integer Enum: "0" "1" 0 1 |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string (resident_service_types) Enum: "1" "2" "3" "4" "5" "6" "7"
|
| 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 |
| 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. |
| residentServiceStatusID required | string (resident_service_statuses) Enum: "1" "2" "3"
|
| dateTimeCreated required | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified required | string or null Timestamp when the service was last modified. UTC, formatted |
{- "name": "Premium Lawn Care",
- "description": "Weekly lawn service.",
- "recurringChargeDescription": "Lawn Care",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "30.00",
- "isActive": "1"
}{- "residentServiceID": "3",
- "serviceTypeID": "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"
}Deletes a REP service from the catalog.
isActive = 0).400) when any lease references it or it belongs to a package. Remove it from those first.| residentServiceID required | integer Example: 3 ID of the resident service. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| residentServiceID required | string^-?[0-9]+$ Unique identifier for the service. |
| serviceTypeID required | string (resident_service_types) Enum: "1" "2" "3" "4" "5" "6" "7"
|
| 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 |
| 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. |
| residentServiceStatusID required | string (resident_service_statuses) Enum: "1" "2" "3"
|
| dateTimeCreated required | string Timestamp when the service was created. UTC, formatted |
| dateTimeModified required | string or null Timestamp when the service was last modified. UTC, formatted |
{- "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"
}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.
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.
isActive=1)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 packageGET /resident/packages/{residentPackageID} - retrieve a single package, with each bundled service's full row through includes=packageServicesGET /resident/services - the services a package bundles| search | string Example: search=Essentials Only packages whose name contains this text. |
| isActive | integer Enum: 0 1 Example: isActive=1 Only active packages ( |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (package_list_item) A package as the list returns it, with its services folded into the row. |
[- {
- "package": {
- "residentPackageID": "23",
- "name": "Contract Essentials",
- "recurringChargeDescription": "officia esse nihil",
- "recurringChargeAccountID": "124",
- "defaultRecurringChargeAmount": "80.95",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:26:32",
- "dateTimeModified": "2026-11-16 19:26:32",
- "services": [
- {
- "name": "Contract Air Filters",
- "salePrice": 0,
- "serviceTypeID": 1,
- "residentServiceID": 28,
- "defaultRecurringChargeAmount": 12.44
}
]
}
}
]Creates a REP package and its service membership in one call.
services is the bundle's membership — an array of { residentServiceID }. At least one service is required.residentServiceID must reference an existing, active service in the account catalog.defaultRecurringChargeAmount is the single bundled retail amount billed to the resident (greater than 0.00); it is independent of the member services' à la carte amounts.| name required | string Display name of the package. |
required | Array of objects The services bundled into this package. At least one is required. |
| recurringChargeDescription | string Ledger-line text for the bundled recurring charge. |
| recurringChargeAccountID | string or integer^-?[0-9]+$ GL account the bundled charge posts to. |
| defaultRecurringChargeAmount | string or number <decimal> Monthly retail amount for the bundle (greater than 0). |
| isActive | string or integer Enum: "0" "1" 0 1 Whether the package is offered. Defaults to |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
{- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "services": [
- {
- "residentServiceID": "3"
}
]
}{- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}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.
isDefault is true when the package is the account's default package for leases.package here has no services key: request the packageServices include for them.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 noneGET /resident/packages - list the catalogPOST /resident/packages/{residentPackageID} - update the packageDELETE /resident/packages/{residentPackageID} - delete the packageGET /resident/services/{residentServiceID} - a bundled service's full row, with its sale price| residentPackageID required | integer Example: 1 ID of the resident package. |
| includes | string Example: includes=packageServices Related data to add: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
| 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 |
{- "package": {
- "residentPackageID": "32",
- "name": "Contract Essentials",
- "recurringChargeDescription": "et dicta ut",
- "recurringChargeAccountID": "126",
- "defaultRecurringChargeAmount": "81.78",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:26:34",
- "dateTimeModified": "2026-11-16 19:26:34"
}, - "isDefault": true,
- "packageServices": [
- {
- "packageService": {
- "residentPackageServiceID": "7",
- "residentPackageID": "32",
- "residentServiceID": "29",
- "dateTimeCreated": "2026-11-16 19:26:34",
- "dateTimeModified": "2026-11-16 19:26:34"
}, - "service": {
- "residentServiceID": "29",
- "serviceTypeID": "1",
- "name": "Contract Window Washing",
- "description": "Eos et ex quo eveniet voluptates.",
- "recurringChargeDescription": "perferendis incidunt beatae",
- "recurringChargeAccountID": "126",
- "defaultRecurringChargeAmount": "1.28",
- "residentServiceStatusID": "1",
- "dateTimeCreated": "2026-11-16 19:26:34",
- "dateTimeModified": "2026-11-16 19:26:34"
}
}
]
}Updates a REP package, including its service membership.
services is supplied it replaces the package's membership: services not in the array are removed and new ones are added. At least one service must remain.residentServiceID must reference an existing, active service in the account catalog.| residentPackageID required | integer Example: 1 ID of the resident package. |
| name | string |
| recurringChargeDescription | string |
| recurringChargeAccountID | string or integer^-?[0-9]+$ |
| defaultRecurringChargeAmount | string or number <decimal> |
| isActive | string or integer Enum: "0" "1" 0 1 |
Array of objects Replaces the package membership when supplied. At least one service is required. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
object (package) A REP (Resident Experience Package) package — a PM-built bundle in |
{- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "services": [
- {
- "residentServiceID": "3"
}
]
}{- "package": {
- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}
}Deletes a REP package from the catalog.
400) when any lease is enrolled in it. The membership rows (resident_package_services) are removed with the package.| residentPackageID required | integer Example: 1 ID of the resident package. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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 |
| 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 ( |
| dateTimeCreated required | string Timestamp when the package was created. UTC, formatted |
| dateTimeModified required | string or null Timestamp when the package was last modified. UTC, formatted |
{- "residentPackageID": "1",
- "name": "Resident Essentials",
- "recurringChargeDescription": "Resident Experience Package",
- "recurringChargeAccountID": "9",
- "defaultRecurringChargeAmount": "25.00",
- "isActive": "1",
- "dateTimeCreated": "2026-06-01 12:00:00",
- "dateTimeModified": "2026-06-01 12:00:00"
}A listing advertises one unit for rent: headline, description, pet and utility details, and the syndication flags for each listing site. Search the account's listings, with each unit's property, portfolio and primary image, and fetch property images from the CDN here.
Returns a filtered page of unit listings, each row denormalized: the listing, its unit, the property, the property's groups, its portfolio, the unit's property manager, and the unit's primary image as CDN URLs.
isZillowActive, isZumperActive, …)isActive, active and inactive listings are both returned.1/0/true/false/yes/no, a number or a date it can't parse).latitudeMin, latitudeMax, longitudeMin and longitudeMax are sent.propertyTypeIDs[] and the others ending in []) take one name[]=value per value; a single plain name=value is read as a one-item list.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.pagination-current-page is at or past pagination-last-page.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.isWebsiteActive, isZillowActive, …) can be filtered on but are not part of the row.GET /properties/listings (undocumented) - the plain listing listGET /properties/{propertyID}/units/{unitID}/listing (undocumented) - one listing, with its syndication flagsGET /listings/{propertyListingID}/files (undocumented) - the photos and documents of a listingGET /properties/{propertyID}/units/{unitID} - the unit, with the listing include| page | integer Default: 1 The page number for pagination |
| pageSize | integer Default: 25 Example: pageSize=25 Items per page (default 25). No cap. |
| orderBy | string Example: orderBy=amount|desc Sort column, optionally followed by |
| search | string Example: search=Example Street Substring match on the listing's headline and description and the unit's address, address 2, city and postal code. |
| isActive | string Example: isActive=1
|
| isWebsiteActive | string Example: isWebsiteActive=1
|
| isZillowActive | string Example: isZillowActive=1
|
| isRentalSourceActive | string Example: isRentalSourceActive=1
|
| isRentalscomActive | string Example: isRentalscomActive=1
|
| isZumperActive | string Example: isZumperActive=1
|
| isApartmentsActive | string Example: isApartmentsActive=1
|
| isVacant | string Example: isVacant=1
|
| rentMin | number Example: rentMin=1000 Minimum unit rent, inclusive. |
| rentMax | number Example: rentMax=3500 Maximum unit rent, inclusive. |
| bedsMin | integer Example: bedsMin=2 Minimum bedrooms, inclusive. |
| bedsMax | integer Example: bedsMax=4 Maximum bedrooms, inclusive. |
| bathsMin | integer Example: bathsMin=1 Minimum bathrooms, inclusive, counting full and half baths alike ( |
| bathsMax | integer Example: bathsMax=3 Maximum bathrooms, inclusive, counted the same way. |
| petFilterOptionID | integer Enum: 1 2 3 4 Example: petFilterOptionID=3 Matches the listing's
|
| 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 ( |
| 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
|
| portfolioIDs[] | Array of integers Example: portfolioIDs[]=12 Only listings of properties owned by these portfolios (from |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=3 Only listings of properties whose portfolio belongs to one of these portfolio groups (from |
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=1 Only listings of properties in one of these property groups (from |
| propertyManagerIDs[] | Array of integers Example: propertyManagerIDs[]=1 Only listings of units with one of these property manager records (from |
| assignedToUserIDs[] | Array of integers Example: assignedToUserIDs[]=2 Only listings of properties assigned to one of these users (from |
| 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
|
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-01-01 00:00:00 Only listings modified at or after this time, in UTC. Accepts |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-12-31 23:59:59 Only listings modified at or before this time. Same forms as |
| pagination-page-size | integer Example: "1" On a page that holds items, the requested |
| pagination-total-items | integer Example: "1" Total number of items across all pages |
| pagination-total-pages | integer Example: "1" Total number of pages; 0 when nothing matches |
| pagination-current-page | integer Example: "1" The page requested, even past the last page (a |
| pagination-next-page | integer Example: "1" Next page number; on the last page, the last page number itself. |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The listing columns, plus the unit size and the two application links. |
required | object The listed unit (always active). |
required | object The unit's property (always active). |
required | object |
required | object |
required | object The unit's property manager record; both fields null when it has none. |
required | object The unit's primary image. |
[- {
- "listing": {
- "propertyListingID": "43",
- "isActive": "1",
- "propertyID": "184",
- "unitID": "172",
- "headline": "APITEST-6af02c9a8d712",
- "description": "Deleniti provident voluptates voluptatem. Possimus quo et officiis et. Sunt porro molestiae nihil quis et cupiditate voluptates. Quos tempore aut tempora veritatis.",
- "lotSize": null,
- "depositDescription": null,
- "availabilityDate": "2026-12-08",
- "advertisedDate": "2026-11-08",
- "virtualTour": null,
- "lockboxNumber": null,
- "lockboxDescription": null,
- "parkingSpaces": null,
- "parkingTypeID": null,
- "areaInformation": null,
- "schools": null,
- "leaseDescription": null,
- "name": "Jane Doe",
- "phone": "555-0100",
- "phoneExtension": null,
- "email": "jane.doe@example.com",
- "secondaryName": null,
- "secondaryPhone": null,
- "secondaryPhoneExtension": null,
- "secondaryEmail": null,
- "applicationUrl": null,
- "size": "1200",
- "isFurnished": "0",
- "acceptDogs": "1",
- "acceptCats": "1",
- "petDescription": null,
- "acceptSmoking": "0",
- "acceptAssistance": "1",
- "isGasIncluded": "0",
- "isElectricIncluded": "0",
- "isWaterIncluded": "0",
- "isSewageIncluded": "0",
- "isGarbageIncluded": "0",
- "isLandscapingIncluded": "0",
- "isCableIncluded": "0",
- "isInternetIncluded": "0",
- "isSnowRemovalIncluded": "0",
- "isPoolServiceIncluded": "0",
- "heatType": null,
- "dateTimeCreated": "2026-11-08 08:02:34",
- "dateTimeModified": "2026-11-08 08:02:34",
- "dateTimeDeactivated": null,
- "coolingSystemTypeID": null,
- "heatingSystemTypeID": null,
- "defaultApplicationUrl": null
}, - "unit": {
- "unitID": "172",
- "name": "Unit 1A",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "leaseID": null,
- "latitude": "40.71280000",
- "longitude": "-74.00600000",
- "marketRent": "1500.00",
- "rent": "1500.00",
- "marketDeposit": "800.00",
- "deposit": "800.00",
- "beds": "3",
- "fullBaths": "2",
- "halfBaths": "1",
- "baths": "3",
- "size": "1200",
- "propertyManagerID": null
}, - "property": {
- "propertyID": "184",
- "propertyTypeID": "2",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "name": "APITEST Maple House",
- "yearBuilt": "2001",
- "assignedToUserID": "2",
- "propertyShowingProviderID": null,
- "showingProviderID": null
}, - "propertyGroups": {
- "names": "APITEST Group"
}, - "portfolio": {
- "portfolioID": "209",
- "name": "Hayes PLC Portfolio",
- "contacts": null
}, - "propertyManager": {
- "propertyManagerID": null,
- "name": null
}, - "image": {
- "propertyImageID": "2",
}
}
]Fetches a resized property image directly from the Rentvine CDN. The URL components are provided
by the image.small and image.large fields returned from GET /properties/listings/search and
similar listing endpoints — no separate lookup is required.
This endpoint does not use the /api/manager base URL and requires no authentication.
Images are publicly accessible once you have the CDN URL.
The image object in each listing search result contains pre-built absolute URLs:
{
"image": {
"propertyImageID": "1664",
"small": "https://cdn.rentvine.com/123pm/properties/707/images/e66a65f69d53ff3a19265b69efe9/small.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} |
Dimensions | Use Case |
|---|---|---|
small |
Thumbnail | List views, vacancy boards, map pins |
large |
Full size | Detail pages, syndication feeds, lightboxes |
To retrieve all uploaded photos and media files attached to a specific listing (not just the primary property image), use:
GET /listings/{propertyListingID}/files (undocumented) — lists all files (photos, documents) attached to the listingGET /listings/files/{id}/preview (undocumented) — returns a file inline (for browser display)GET /listings/files/{id}/download (undocumented) — downloads a file as an attachmentGET /properties/listings/search - Returns image.small and image.large for each resultGET /listings/{propertyListingID}/files (undocumented) - All uploaded listing photos and media| propertyID required | integer Example: 707 The |
| imageHash required | string Example: e66a65f69d53ff3a19265b69efe9 The image hash component from the |
| size required | string Enum: "small" "large" Example: small
|
| fileType required | string Example: jpg The image's file extension, as it appears at the end of the |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
{- "code": "429",
- "error": "Too Many Requests",
- "message": "Rate limit exceeded."
}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.
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}.
dateTimeUpdatedobjectTypeID and objectID are required: without either (or with 0) the request answers 400.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.dateTimeUpdated, newest first; conversations whose dateTimeUpdated is 0000-00-00 00:00:00 come
last.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 messagesPOST /contacts/conversations - send an email, starting or continuing a conversation| 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.
|
| objectID required | integer >= 1 Example: objectID=1050 The ID of the record, of the type
|
| 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: |
| pagination-page-size | integer Example: "2" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| emailConversationID required | string^-?[0-9]+$ The conversation's 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"
|
| 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 |
| dateTimeUpdated required | string When the conversation last changed. UTC, formatted |
| emailMessageCount required | string^-?[0-9]+$ The number of messages in the conversation, as a string of digits. |
[- {
- "emailConversationID": "21",
- "objectTypeID": "4",
- "objectID": "224",
- "subject": "Lease renewal",
- "dateTimeCreated": "2026-11-16 19:53:57",
- "dateTimeUpdated": "2026-09-02 14:45:00",
- "emailMessageCount": "2"
}, - {
- "emailConversationID": "20",
- "objectTypeID": "4",
- "objectID": "224",
- "subject": "Move-in inspection follow up",
- "dateTimeCreated": "2026-11-16 19:53:57",
- "dateTimeUpdated": "2026-07-03 11:20:00",
- "emailMessageCount": "0"
}
]Sends an outbound email message, creating a new conversation thread or adding a reply to an existing one. On success, the response is the created or updated conversation record (identical to GET /contacts/conversations/{id} without includes).
Supply objectTypeID + objectID to start a new conversation, or emailConversationID to reply within an existing thread.
Contacts: Send Messages permission.recipients is required. Addresses matching the system mail domain or noreply are silently filtered out.objectTypeID and objectID are required. Omitting either returns a 400.emailTemplateID (in the email object) causes the system to look up the template and populate templateObjectTypeID automatically.copySender: "1" sends a copy of the email to the authenticated user.attachments must already exist in the system.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 objectGET /contacts/conversations/{id} — retrieve a conversation with its message history| recipients required | Array of strings <email> [ items <email > ] Primary To recipients — array of email address strings. |
| message required | string HTML body of the email. |
| subject required | string <= 300 characters Email subject line. Required when creating a new conversation. |
| objectTypeID required | string or integer^-?[0-9]+$ Object type the conversation belongs to. Required when creating a new conversation. Common values:
|
| objectID required | string or integer^-?[0-9]+$ Primary key of the object identified by |
| additionalRecipients | Array of strings <email> [ items <email > ] Additional To recipients to include alongside |
| bcc | Array of strings <email> [ items <email > ] BCC recipients — array of email address strings. |
object Email template options. | |
| attachments | Array of integers Array of |
| copySender | string or integer Enum: "0" "1" 0 1 Pass |
| inputs | object Optional key/value pairs passed to template rendering. |
| templateObjectTypeID | string or integer^-?[0-9]+$ Template object type used when rendering template variables in the email body. |
| emailConversationID | string or integer^-?[0-9]+$ Supply to reply within an existing conversation thread. If omitted, a new conversation is created. |
| sentByUserID | string or integer^-?[0-9]+$ API keys only. The |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "additionalRecipients": [
- "test@gmail.com"
], - "bcc": [
- "test@gmail.com"
], - "message": "<p>Hi Tenants,</p><p>Mackenzie Walker</p><p>We are excited to welcome you as new tenants!</p>",
- "subject": "Your Florida Lease Template",
- "email": {
- "message": "",
- "emailTemplateID": "8"
}, - "attachments": [ ],
- "copySender": "1",
- "inputs": { },
- "recipients": [
- "mackenzie.walker@rentvine.com",
- "adriano@rentvine.com"
], - "templateObjectTypeID": 2,
- "objectTypeID": 4,
- "objectID": "2982"
}{- "emailConversation": {
- "emailConversationID": "301",
- "templateObjectTypeID": "2",
- "objectTypeID": "4",
- "objectID": "2982",
- "subject": "Your Florida Lease Template",
- "dateTimeCreated": "2024-10-22 14:00:00",
- "dateTimeUpdated": "2024-10-22 14:00:00"
}
}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.
POST /contacts/conversations400 (Email Conversation Not Found), for a key restricted to
portfolio groups too; a value that isn't a number answers 404.403 (Access Denied) for a conversation on a record outside its
groups' portfolios.includes=messages, only emailConversation is returned.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.messages - adds messages (each with message, fromRecipient and attachments) and recipientsGET /contacts/conversations - the conversations on a recordPOST /contacts/conversations - send an email, starting or continuing a conversation| id required | integer Example: 301 The conversation's ID ( |
| includes | string Example: includes=messages Comma-separated related data to add. Available: |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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 | |
Array of objects The conversation's messages, newest first; an empty list when it has none. Requires the |
{- "emailConversation": {
- "emailConversationID": "32",
- "templateObjectTypeID": "2",
- "objectTypeID": "4",
- "objectID": "229",
- "subject": "Lease renewal",
- "dateTimeCreated": "2026-11-16 19:54:01",
- "dateTimeUpdated": "2026-11-16 19:54:01"
}
}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.
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).
markRead=false), for a sync or a notification botchatObjectTypeID 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.chatObjectTypeID and objectID to list every thread's messages; a thread with
no messages, or whose record doesn't exist, answers [].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.0 or a negative pageSize is served at 15.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 threadGET /chat/messages/stats (undocumented) - unread counts| chatObjectTypeID | integer Enum: 1 2 3 4 5 Example: chatObjectTypeID=2 The type of record the thread belongs to. With
|
| objectID | integer Example: objectID=1050 The ID of the record the thread belongs to, of the type |
| markRead | boolean Default: true Whether to mark the returned messages read by the office (default |
| search | string Example: search=renew Only messages whose text contains this string. |
| isSharedWithTenant | integer Enum: 0 1 Example: isSharedWithTenant=1
|
| isSharedWithCosigner | integer Enum: 0 1
|
| isSharedWithVendor | integer Enum: 0 1
|
| isSharedWithOwner | integer Enum: 0 1
|
| 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; |
| pagination-page-size | integer Example: "2" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The message itself. |
required | object The account user who sent the message. Every field is |
required | object The contact who sent the message. Every field is |
[- {
- "message": {
- "messageID": "125",
- "chatObjectTypeID": "2",
- "objectID": "517",
- "roleTypeID": "1",
- "userID": "2",
- "contactID": null,
- "message": "Renewal terms: https://example.com/renewal",
- "messageLinkPreviewMeta": [
- {
- "title": "Renewal terms",
- "domain": "example.com",
- "sitename": "Example",
- "description": "Your renewal offer"
}
], - "isSharedWithTenant": "1",
- "isSharedWithCosigner": "0",
- "isSharedWithVendor": "0",
- "isSharedWithOwner": "0",
- "isReadByManager": "1",
- "isReadByTenant": "0",
- "isReadByVendor": "0",
- "isReadByOwner": "0",
- "isRead": "1",
- "dateTimeCreated": "2026-11-16 20:02:54",
- "fileAttachments": [ ]
}, - "user": {
- "userID": "2",
- "firstName": "Jane",
- "lastName": "Doe",
- "email": "jane.doe@example.com"
}, - "contact": {
- "contactID": null,
- "contactTypeID": null,
- "name": null
}
}, - {
- "message": {
- "messageID": "124",
- "chatObjectTypeID": "2",
- "objectID": "517",
- "roleTypeID": "2",
- "userID": "2",
- "contactID": "1082",
- "message": "Hi, I would like to renew.",
- "messageLinkPreviewMeta": null,
- "isSharedWithTenant": "1",
- "isSharedWithCosigner": "0",
- "isSharedWithVendor": "0",
- "isSharedWithOwner": "0",
- "isReadByManager": "0",
- "isReadByTenant": "1",
- "isReadByVendor": "0",
- "isReadByOwner": "0",
- "isRead": "0",
- "dateTimeCreated": "2026-11-16 20:02:54",
- "fileAttachments": [
- {
- "title": "Statement Batch - 11/16/2026",
- "fileID": 13,
- "fileName": "245eb230-5df2-3de0-bc9f-437f5192f115.pdf",
- "fileType": "pdf",
- "previewFileName": null,
- "fileAttachmentID": 13
}
]
}, - "user": {
- "userID": "2",
- "firstName": "Jane",
- "lastName": "Doe",
- "email": "jane.doe@example.com"
}, - "contact": {
- "contactID": "1082",
- "contactTypeID": "2",
- "name": "Jordan Example"
}
}
]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.
roleTypeID is always set to Manager (1) server-side and cannot be overridden by the client.chatObjectTypeID and objectID.attachments is an array of fileID integers referencing files that already exist in the system.isSharedWithTenant, isSharedWithVendor, isSharedWithOwner, isSharedWithCosigner) default to 0 if omitted.GET /chat/messages — list messages for an objectGET /chat/messages/{id} (undocumented) — retrieve a single message| chatObjectTypeID required | string or integer Enum: "1" "2" "3" "4" "5" 1 2 3 4 5 The chat object type identifying what kind of object the message belongs to.
|
| objectID required | string or integer^-?[0-9]+$ Primary key of the object identified by |
| message required | string HTML body of the chat message. |
| isSharedWithTenant | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the tenant (0 or 1). |
| isSharedWithVendor | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the vendor (0 or 1). |
| isSharedWithOwner | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the owner (0 or 1). |
| isSharedWithCosigner | string or integer Default: "0" Enum: "0" "1" 0 1 Whether the message is visible to the cosigner (0 or 1). |
| attachments | Array of integers Array of |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
required | Array of objects File attachments on the created message (empty if none were supplied). |
{- "attachments": [ ],
- "message": "<p>test</p>",
- "chatObjectTypeID": 2,
- "objectID": 2982,
- "isSharedWithTenant": "1",
- "isSharedWithCosigner": "1"
}{- "message": {
- "messageID": "1026",
- "chatObjectTypeID": "2",
- "objectID": "2982",
- "roleTypeID": "1",
- "userID": "501195",
- "contactID": null,
- "shortUrlID": "808166",
- "message": "<p>test</p>",
- "messageLinkPreviewMeta": null,
- "isSharedWithTenant": "1",
- "isSharedWithCosigner": "0",
- "isSharedWithVendor": "0",
- "isSharedWithOwner": "0",
- "isSharedWithApplicant": "0",
- "isReadByManager": "1",
- "isReadByTenant": "0",
- "isReadByCosigner": "0",
- "isReadByVendor": "0",
- "isReadByOwner": "0",
- "isReadByApplicant": "0",
- "dateTimeCreated": "2026-04-27 12:50:14"
}, - "fileAttachments": [ ]
}SMS text messages Rentvine sends and receives for your account. Send a text, and list the texts exchanged with one phone number.
Sends an outbound SMS text message to a phone number. On success, the response returns the created text message record (identical to GET /messages/texts/{id}).
Contacts: Send Messages permission.to must be a valid phone number in E.164 format (e.g. +14436420607).attachments is an optional array of fileID integers referencing files that already exist in the system (MMS attachments).contactID is accepted in the payload but is not stored on the text message record — it is used for UI context only.GET /messages/texts/phone/{phoneNumber} — list the full thread for a phone numberGET /messages/texts/{id} — retrieve a single text message| to required | string Recipient phone number in E.164 format. |
| message required | string Text body of the SMS message. |
| attachments | Array of integers Optional array of |
| contactID | string or integer^-?[0-9]+$ Optional contact ID for UI context. Not stored on the text message record. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "contactID": "3816",
- "to": "+14436420607",
- "message": "test"
}{- "textMessage": {
- "textMessageID": "914",
- "isInbound": "0",
- "from": "+12393606531",
- "to": "+14436420607",
- "message": "\"test\"",
- "fileAttachments": null,
- "sentByUserID": "501195",
- "dateTimeSent": "2026-04-27 12:54:12"
}
}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).
search)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.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.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 messageGET /messages/texts/phone/{phoneNumber}/load (undocumented) - the messages after a given one| phoneNumber required | integer Example: 12025550101 The phone number's digits in E.164 form, without the |
| 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: |
| pagination-page-size | integer Example: "2" On a page with results: the page size in effect (the requested |
| 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 |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number, or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| textMessageID required | string^-?[0-9]+$ The message's ID. |
| isInbound required | string Enum: "0" "1"
|
| 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 |
| sentByUserID required | string or null^-?[0-9]+$ The office user who sent the message; |
| dateTimeSent required | string When the message was sent or received. UTC, formatted |
[- {
- "textMessageID": "64",
- "isInbound": "0",
- "from": "+12025550100",
- "to": "+12025550101",
- "message": "Your inspection is on Tuesday.",
- "fileAttachments": "[{\"fileAttachmentID\":\"550\",\"fileID\":\"320\",\"title\":\"Inspection Notice\",\"fileName\":\"inspection-notice.pdf\",\"fileType\":\"pdf\",\"fileSize\":\"48213\"}]",
- "sentByUserID": "2",
- "dateTimeSent": "2026-10-22 14:00:00"
}, - {
- "textMessageID": "63",
- "isInbound": "1",
- "from": "+12025550101",
- "to": "+12025550100",
- "message": "Got it, thanks!",
- "fileAttachments": null,
- "sentByUserID": null,
- "dateTimeSent": "2026-10-22 13:55:00"
}
]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.
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.
GET /screening/templates - the application templates genericApplicationTemplateID namesGET /screening/applications - list applications| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| screeningSettingID required | string Value: "1" Always |
| applicationProviderID required | string (application_providers) Enum: "1" "2" Who takes the account's rental applications:
|
| isApplicationEnabled required | string Enum: "0" "1" Whether the Rentvine applicant portal takes applications. Always |
| applicationUrl required | string or null <= 500 characters The outside application's address, used when |
| 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 |
| 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 |
| manualPaymentLedgerID required | string or null^-?[0-9]+$ The corporate portfolio's ledger a Manual Payment's Other Receipt posts to, or |
| manualPaymentChargeAccountID required | string or null^-?[0-9]+$ The income account a Manual Payment's Other Receipt records the fee as, or |
| manualPaymentBankAccountID required | string or null^-?[0-9]+$ The bank account a Manual Payment's Other Receipt deposits to, or |
| manualPaymentLedgerName required | string or null The name of the ledger |
{- "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"
}Lists the account's application templates, active and inactive, sorted by ID, one page at a time. Each item wraps
the template under template, beside a token the list adds. A template's templateID is what
POST /screening/applications takes.
search matches any part of the template's name, in any case. Without search every template is listed.isActive tells them apart.templateID, oldest first.POST /screening/applications - create an application from a template| search | string Example: search=Contract check Part of the template's name, matched anywhere in it and in any case. |
| page | integer >= 1 Default: 1 Example: page=1 Page number, from 1 (default 1). |
| pageSize | integer >= 1 Default: 15 Example: pageSize=15 Items per page, from 1 (default 15). Values above 5000 are served at 5000. |
| pagination-page-size | integer Example: "15" Page size used -- the requested |
| pagination-total-items | integer Example: "2" Total number of items across all pages; 0 when nothing matches |
| pagination-total-pages | integer Example: "1" Total number of pages |
| pagination-current-page | integer Example: "1" Current page number |
| pagination-next-page | integer Example: "1" Next page number. On the last page it repeats the last page number, so stop paging once |
| pagination-before-page | integer Example: "1" Previous page number (current page - 1), or 1 on the first page |
| pagination-first-page | integer Example: "1" First page number (always 1) |
| pagination-last-page | integer Example: "1" Last page number |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object (included_template) An application (screening) template. |
| token required | string^[0-9]+$ The time of the request as a Unix timestamp, added by the list to every item. Carries no information about the template. |
[- {
- "template": {
- "templateID": "1",
- "name": "Contract check Standard Template",
- "isActive": "1",
- "applicationFeeAmount": "50.00",
- "processingFeeTypeID": "2",
- "isLockRentAmount": "1",
- "isLockDepositAmount": "1",
- "isShowPendingApplicationMessage": "1",
- "pendingApplicationMessage": "We review applications within two business days.",
- "dateTimeCreated": "2026-11-14 02:45:13",
- "isDefault": "1",
- "addendumTemplateID": "3"
}, - "token": "1794624313"
}
]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.
dateTimeModifiedMindateTimeCreated, newest first; applications created in the same second come in applicationID
order, lowest first.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.[]) 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.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 applicationGET /screening/applications/{applicationID}/summary - the review summary of one applicationPOST /screening/applications/{applicationID}/status - change an application's status| 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 |
| applicationStatusID | integer Example: applicationStatusID=2 Only applications in this status (an account status, from |
| applicationStatusIDs[] | Array of integers Example: applicationStatusIDs[]=2&applicationStatusIDs[]=6 Only applications in any of these statuses (account statuses, from |
| excludeUnassigned | boolean Example: excludeUnassigned=true
|
| assignedToUserIDs[] | Array of strings[ items^([0-9]+|null)$ ] Example: assignedToUserIDs[]=12 Only applications assigned to any of these users (from |
| propertyAssignedToUserIDs[] | Array of strings[ items^([0-9]+|null)$ ] Example: propertyAssignedToUserIDs[]=12 Only applications whose property is assigned to any of these users (from |
| watcherUserIDs[] | Array of integers Example: watcherUserIDs[]=12 Only applications watched by any of these users (from |
| numberMin | integer Example: numberMin=100001 Only applications whose |
| numberMax | integer Example: numberMax=100250 Only applications whose |
| dateTimeCreatedMin | string Example: dateTimeCreatedMin=2026-01-01 00:00:00 Only applications created at or after this time, in UTC. Accepts |
| dateTimeCreatedMax | string Example: dateTimeCreatedMax=2026-12-31 23:59:59 Only applications created at or before this time, in UTC. Accepts the forms |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-11-01 00:00:00 Only applications last changed at or after this time, in UTC. Accepts the forms |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-11-30 23:59:59 Only applications last changed at or before this time, in UTC. Accepts the forms |
| unitID | integer Example: unitID=229 Only applications for this unit (from |
| unitIDs[] | Array of integers Example: unitIDs[]=229&unitIDs[]=230 Only applications for any of these units. One |
| hasLease | boolean
|
| propertyGroupIDs[] | Array of integers Example: propertyGroupIDs[]=3 Only applications whose property is in any of these property groups (from |
| portfolioGroupIDs[] | Array of integers Example: portfolioGroupIDs[]=2 Only applications whose property's portfolio is in any of these portfolio groups (from |
| pagination-page-size | integer Example: "25" Items per page. On a page with results, the requested |
| 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-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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The application. |
required | object The application's status. |
required | object The unit applied for; every field is |
required | object The unit's property; every field is |
required | object The lease made from the application; |
[- {
- "application": {
- "applicationID": "577",
- "assignedToUserID": "494",
- "number": "100001",
- "unitID": "229",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "applicants": "Avery Example",
- "dateTimeCreated": "2026-11-16 19:45:48",
- "dateTimeModified": "2026-11-16 19:45:48"
}, - "status": {
- "applicationStatusID": "2",
- "primaryApplicationStatusID": "2",
- "isSystemStatus": "1",
- "name": "Submitted"
}, - "unit": {
- "propertyID": "256",
- "name": "Unit 4",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "UT",
- "postalCode": "12345"
}, - "property": {
- "propertyID": "256",
- "name": "Contract Gardens",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "NM",
- "postalCode": "12345",
- "portfolioID": "294"
}, - "lease": {
- "leaseID": "123",
- "startDate": "2026-12-07",
- "endDate": "2027-12-07",
- "tenants": [
- "Avery Example"
]
}
}
]Creates a rental application on behalf of an applicant, from one of the account's application templates, as the
manager app's "Add Application" does. It creates the application, the applicant on it and the applicant's
contact, and returns the applicant, not the application: the new application's ID is the applicant's
applicationID.
Screening › ModifyApplications), checked
before anything else: a key without it gets the 403 whatever the body or ID.templateID names the template, from GET /screening/templates. An inactive template is accepted too. Its
sections decide which parts of application are read;
GET /screening/templates/{templateID}/submission (undocumented) lists the sections a template has on, each by
its key in application, with their fields and labels.{} (invalid input.);templateID (TemplateID is required), then a templateID with no template (Application Template not found);application at once, the messages nested by section and field as the body is (a list
section's under items, by position);unitID with no unit (Failed to find unit with unitID {unitID});applicant.<field>, application.<field>, contact.<field> or
animalPhotos.fileID.application are required, in the sections the template has on: a manager
doesn't have to meet the template's own "required" choices or minimum item counts, except on a dropdown field:
a dropdown the template marks required and the body leaves out answers 400 :field not valid for the defined list (the message as sent). A field the template turned off isn't checked, but its value is still saved.unitID, the application is for that unit and the address applied for is the unit's. The
application.applyingFor address fields are still required, and are then not used.unitID, the application is for the address sent under application.applyingFor.unitID from a property in those portfolios.unitID and application keep the JSON type they were sent in (a rent sent
as 1650 comes back as 1650, not "1650.00"). Top-level dates come back as YYYY-MM-DD whichever accepted
form was sent; dates inside a list section (an occupant's birthDate) come back as sent. Read the application
back with GET /screening/applications/{applicationID} for the stored values.application that isn't an object, an array where a required field expects text, or a question or term
whose variableFieldID is missing or isn't any template's fails with a 500.photos ({"fileID": …} entries) to the applicant as an animal photo.GET /screening/templates - the templates, for templateIDGET /screening/applications/{applicationID} - the application createdGET /properties/{propertyID}/units - the units of a property, for unitID| templateID required | string or integer^[0-9]+$ The application template, from |
required | object (application_submission) The application, one key per section of the template, each named as below. A single section is an object of
fields; a section that holds a list (occupants, vehicles, employment history and the like) is A manager-created application requires only the fields marked required here, in the sections the template has
turned on; the template's own "required" choices and minimum item counts apply to applicants only. The four
sections a template can't turn off are required, and each item of a list section needs its own required
fields. A section the template turned off is ignored; a field it turned off within a section that is on isn't
checked, but its value is still saved as sent.
|
| unitID | string or integer or null^[0-9]+$ The unit applied for, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| applicantID required | string^-?[0-9]+$ The primary key of the applicant. |
| applicationID required | string^-?[0-9]+$ The application the applicant belongs to, readable at |
| number required | integer The applicant's number on the account, assigned when it is created. A JSON number, unlike the IDs. |
| templateID required | string^-?[0-9]+$ The template the application was created from. |
| userID required | string or null^-?[0-9]+$ The applicant portal user who submitted it; null for an application a manager created. |
| applicantContactID required | string^-?[0-9]+$ The applicant's contact record, created with the application from its name, email and phones. |
| unitID required | string or integer or null^[0-9]+$ The unit applied for, as sent (a JSON number when sent as one); null when none was sent. |
| countryID required | string or null <= 2 characters Country of the address applied for: the unit's (always |
| address required | string or null <= 100 characters The address applied for: the unit's when |
| address2 required | string or null <= 100 characters Second line of the address applied for; the unit's, or as sent. |
| city required | string or null <= 50 characters City of the address applied for; the unit's, or as sent. |
| stateID required | string or null <= 3 characters State of the address applied for; the unit's, or as sent. |
| postalCode required | string or null <= 20 characters Postal code of the address applied for; the unit's, or as sent. |
| rent required | string or number or null Rent amount, as sent under |
| deposit required | string or number or null Security deposit, as sent (a JSON number when sent as one); null when not sent. |
| moveInDate required | string or null <date> Move In Date, as sent under |
| leaseMonths required | string or integer or null Length of the lease in months, as sent (a JSON number when sent as one); null when not sent. |
| agentName required | string or null <= 100 characters Agent, as sent under |
| agentContactInformation required | string or null <= 100 characters Contact Info, as sent under |
| firstName required | string or null <= 50 characters First Name, as sent under |
| middleName required | string or null <= 50 characters Middle Name, as sent under |
| lastName required | string or null <= 50 characters Last Name, as sent under |
| email required | string or null <= 75 characters Email, as sent under |
| homePhone required | string or null <= 20 characters Home Phone, as sent under |
| cellPhone required | string or null <= 20 characters Cell Phone, as sent under |
| workPhone required | string or null <= 20 characters Work Phone, as sent under |
| birthDate required | string or null <date> Date of Birth, as sent under |
| birthPlace required | string or null <= 50 characters Birth Place, as sent under |
| ssnCiphertextID required | string or null^-?[0-9]+$ The stored, encrypted Social Security or taxpayer number. The number itself isn't returned. |
| ssnTruncated required | string or null <= 20 characters The last four digits of the Social Security or taxpayer number sent. |
| licenseNumber required | string or null <= 50 characters Drivers License #, as sent under |
| licenseState required | string or null <= 50 characters License State, as sent under |
| passportID required | string or null <= 50 characters Passport #, as sent under |
| studentID required | string or null <= 50 characters Student #, as sent under |
| maidenName required | string or null <= 50 characters Maiden Name, as sent under |
| height required | string or null <= 25 characters Height, as sent under |
| weight required | string or null <= 25 characters Weight, as sent under |
| eyeColor required | string or null <= 25 characters Eye Color, as sent under |
| hairColor required | string or null <= 25 characters Hair Color, as sent under |
| maritalStatus required | string or null <= 200 characters Marital Status, as sent under |
| citizenship required | string or null <= 100 characters Citizenship, as sent under |
| referredBy required | string or null <= 1000 characters How were you referred to us?, as sent under |
| assistanceAgency required | string or null <= 45 characters Agency, as sent under |
| assistanceCounty required | string or null <= 100 characters County, as sent under |
| assistanceTechnician required | string or null <= 100 characters Technician, as sent under |
| assistancePhone required | string or null <= 20 characters Phone, as sent under |
| assistanceAmount required | string or number or null Assistance amount, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. |
| assistanceUtility required | string or null <= 200 characters Utilities Included, as sent under |
| assistanceBeds required | string or integer or null Bedrooms the assistance covers, as sent when the template's assistance section is on (a JSON number when sent as one); otherwise null. |
| applicantType required | string or null <= 200 characters I Am The, as sent under |
| primaryAddress required | string or null <= 100 characters Address, as sent under |
| primaryAddress2 required | string or null <= 100 characters Unit/Apt #, as sent under |
| primaryCity required | string or null <= 100 characters City, as sent under |
| primaryStateID required | string or null <= 3 characters State, as sent under |
| primaryPostalCode required | string or null <= 20 characters Postal Code, as sent under |
| primaryCountryID required | string or null <= 2 characters ID of the country this record points to. |
| primaryRentOwn required | string or null <= 200 characters Rent / Own, as sent under |
| primaryMonthlyPayment required | string or number or null Monthly payment at the current address, as sent (a JSON number when sent as one); null when not sent. |
| primaryMoveInDate required | string or null <date> Move In Date, as sent under |
| primaryManagerName required | string or null <= 100 characters Manager Name, as sent under |
| primaryManagerPhone required | string or null <= 20 characters Manager Phone, as sent under |
| primaryManagerEmail required | string or null <= 75 characters Manager Email, as sent under |
| primaryReasonForLeaving required | string or null Reason for Leaving, as sent under |
| signature required | string or null <= 100 characters The applicant's signature; null for an application a manager created. |
required | null or object The address history as sent under |
required | null or object The bank accounts as sent under |
required | null or object The credit cards as sent under |
required | null or object The emergency contacts as sent under |
required | null or object The employment history as sent under |
required | null or object The other sources of income as sent under |
required | null or object The occupants as sent under |
required | null or object The animals as sent under |
required | null or object The references as sent under |
required | null or object The vehicles as sent under |
required | Array of objects or null The answers to the template's questions, as sent under |
required | Array of objects or null The acceptances of the template's terms, as sent under |
| addendumSignature required | string or null <= 100 characters The applicant's signature on the addenda; null for an application a manager created. |
| addendumInitials required | string or null <= 100 characters The applicant's initials on the addenda; null for an application a manager created. |
| incomeVerificationReportToken required | string or null <= 200 characters Income verification's report token; null for an application a manager created. |
required | verification_report_statuses (string) or null Income verification status; null for an application a manager created. |
| incomeVerificationReportData required | null The income verification report. Always null for an application a manager created: verification runs only on applications applicants submit. |
| incomeVerificationReportError required | null The income verification error. Always null for an application a manager created: verification runs only on applications applicants submit. |
required | verification_report_statuses (string) or null Identity verification status; null for an application a manager created. |
| identityVerificationReportData required | null The identity verification report. Always null for an application a manager created: verification runs only on applications applicants submit. |
| identityVerificationReportToken required | string or null <= 200 characters Identity verification's report token; null for an application a manager created. |
| identityVerificationPlaidTemplate required | string or null <= 200 characters The identity verification template used; null for an application a manager created. |
| dateTimeCreated required | string When the applicant was created. UTC, formatted |
| dateTimeModified required | string When the applicant was last changed. UTC, formatted |
| startedApplicationID required | string or null^-?[0-9]+$ ID of the started application this record points to. |
| creditReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
| criminalReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
| evictionReportDocumentID required | string or null^-?[0-9]+$ ID of the report document this record points to. |
{- "templateID": "16",
- "unitID": "47",
- "application": {
- "applyingFor": {
- "address": "123 Test St",
- "city": "Estero",
- "stateID": "FL",
- "postalCode": "33928",
- "countryID": "US"
}, - "leaseInfo": {
- "rent": "1650.00",
- "deposit": "1650.00",
- "moveInDate": "2026-12-01",
- "leaseMonths": "12"
}, - "personalInfo": {
- "firstName": "Jane",
- "lastName": "Doe",
- "email": "jane.doe@example.com",
- "cellPhone": "+12395551234",
- "birthDate": "1990-01-15",
- "ssn": "123456789",
- "middleName": "Marie",
- "homePhone": "+12395550100",
- "workPhone": "+12395550101"
}, - "currentAddress": {
- "primaryAddress": "456 Applicant St",
- "primaryCity": "Estero",
- "primaryStateID": "FL",
- "primaryPostalCode": "33928",
- "primaryCountryID": "US"
}, - "vehicles": {
- "items": [
- {
- "make": "Honda",
- "model": "Civic",
- "yearBuilt": "2019",
- "color": "Silver"
}
]
}, - "occupants": {
- "items": [
- {
- "name": "Sam Doe",
- "birthDate": "2015-04-02",
- "relationship": "Son"
}
]
}, - "pets": {
- "items": [
- {
- "name": "Biscuit",
- "type": "Dog",
- "age": 4,
- "weight": 45,
- "gender": "Male",
- "neutered": "Yes"
}
]
}, - "employmentHistory": {
- "items": [
- {
- "isCurrentEmployer": "Yes",
- "name": "Gulf Coast Clinic",
- "position": "Nurse",
- "monthlySalary": "5200",
- "startDate": "2020-03-01"
}
]
}
}
}{- "applicantID": "4",
- "applicationID": "4",
- "number": 100001,
- "templateID": "16",
- "userID": null,
- "applicantContactID": "49",
- "unitID": "47",
- "countryID": "US",
- "address": "8207 Littel Mountains Suite 105",
- "address2": null,
- "city": "Nevachester",
- "stateID": "HI",
- "postalCode": "98941",
- "rent": "1650.00",
- "deposit": "1650.00",
- "moveInDate": "2026-12-01",
- "leaseMonths": "12",
- "agentName": null,
- "agentContactInformation": null,
- "firstName": "Jane",
- "middleName": "Marie",
- "lastName": "Doe",
- "email": "jane.doe@example.com",
- "homePhone": "+12395550100",
- "cellPhone": "+12395551234",
- "workPhone": "+12395550101",
- "birthDate": "1990-01-15",
- "birthPlace": null,
- "ssnCiphertextID": "4",
- "ssnTruncated": "6789",
- "licenseNumber": null,
- "licenseState": null,
- "passportID": null,
- "studentID": null,
- "maidenName": null,
- "height": null,
- "weight": null,
- "eyeColor": null,
- "hairColor": null,
- "maritalStatus": null,
- "citizenship": null,
- "referredBy": null,
- "assistanceAgency": null,
- "assistanceCounty": null,
- "assistanceTechnician": null,
- "assistancePhone": null,
- "assistanceAmount": null,
- "assistanceUtility": null,
- "assistanceBeds": null,
- "applicantType": null,
- "primaryAddress": "456 Applicant St",
- "primaryAddress2": null,
- "primaryCity": "Estero",
- "primaryStateID": "FL",
- "primaryPostalCode": "33928",
- "primaryCountryID": "US",
- "primaryRentOwn": null,
- "primaryMonthlyPayment": null,
- "primaryMoveInDate": null,
- "primaryManagerName": null,
- "primaryManagerPhone": null,
- "primaryManagerEmail": null,
- "primaryReasonForLeaving": null,
- "signature": null,
- "addressHistory": null,
- "bankAccounts": null,
- "creditCards": null,
- "emergencyContacts": null,
- "employmentHistory": {
- "items": [
- {
- "isCurrentEmployer": "Yes",
- "name": "Gulf Coast Clinic",
- "position": "Nurse",
- "monthlySalary": "5200",
- "startDate": "2020-03-01",
- "_id": 1
}
], - "maxID": 1
}, - "income": null,
- "occupants": {
- "items": [
- {
- "name": "Sam Doe",
- "birthDate": "2015-04-02",
- "relationship": "Son",
- "_id": 1
}
], - "maxID": 1
}, - "pets": {
- "items": [
- {
- "name": "Biscuit",
- "type": "Dog",
- "age": 4,
- "weight": 45,
- "gender": "Male",
- "neutered": "Yes",
- "_id": 1
}
], - "maxID": 1
}, - "references": null,
- "vehicles": {
- "items": [
- {
- "make": "Honda",
- "model": "Civic",
- "yearBuilt": "2019",
- "color": "Silver",
- "_id": 1
}
], - "maxID": 1
}, - "questions": null,
- "terms": null,
- "addendumSignature": null,
- "addendumInitials": null,
- "incomeVerificationReportToken": null,
- "incomeVerificationReportStatusID": null,
- "incomeVerificationReportData": null,
- "incomeVerificationReportError": null,
- "identityVerificationReportStatusID": null,
- "identityVerificationReportData": null,
- "identityVerificationReportToken": null,
- "identityVerificationPlaidTemplate": null,
- "dateTimeCreated": "2026-11-14 02:46:17",
- "dateTimeModified": "2026-11-14 02:46:17",
- "startedApplicationID": null,
- "creditReportDocumentID": null,
- "criminalReportDocumentID": null,
- "evictionReportDocumentID": null
}Returns one rental application: the application record under application, and its status under status.
403.400 with Application not found.GET /screening/applications - list applicationsGET /screening/applications/{applicationID}/summary - the review summary, with each applicant's screening resultsPOST /screening/applications/{applicationID}/status - change the application's status| applicationID required | integer Example: 641 The application's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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
( |
{- "application": {
- "applicationID": "641",
- "number": "100001",
- "primaryApplicationStatusID": "2",
- "applicationStatusID": "2",
- "assignedToUserID": "512",
- "unitID": "244",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "dateTimeCreated": "2026-11-16 19:45:57",
- "dateTimeModified": "2026-11-16 19:45:57"
}, - "status": {
- "applicationStatusID": "2",
- "primaryApplicationStatusID": "2",
- "isSystemStatus": "1",
- "name": "Submitted",
- "orderIndex": "2"
}
}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.
applicantID to read their form with GET /screening/applicants/{applicantID}/tab/applicationRestricted, with no badge, unless
the caller holds the View Reports permission (Screening › ViewReports).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.scoringTemplate is an empty array when the application has no scoring template.400 with Application not found.GET /screening/applications/{applicationID} - the application record aloneGET /screening/applicants/{applicantID}/tab/application - one applicant's application formPOST /screening/reports - order screening reports for applicantsPOST /screening/applications/{applicationID}/status - change the application's status| applicationID required | integer Example: 643 The application's ID. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "application": {
- "applicationID": "860",
- "applicationStatusID": "2",
- "assignedToUserID": "883",
- "primaryApplicationStatusID": "2",
- "scoringTemplate": [ ],
- "summary": {
- "applicantNames": "Jane Doe, John Roe",
- "rent": "1800",
- "incomeRatio": "2.78",
- "availableBy": "2026-12-01",
- "combinedIncome": 5000,
- "applicants": 2,
- "occupants": 1,
- "animals": 0,
- "requestedMoveIn": "Nov 16, 2026",
- "numberOfBedrooms": "2",
- "numberOfBathrooms": "1",
- "numberOfHalfBathrooms": "1",
- "expectedRatio": 2.5,
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "countryID": "US",
- "dateTimeCreated": "2026-11-16 19:53:20",
- "dateTimeModified": "2026-11-16 19:53:20",
- "number": "100001",
- "propertyID": "659",
- "prospectID": null,
- "unitID": "842",
- "leaseID": "211",
- "paymentCount": 0,
- "messageCount": 0,
- "fileCount": 0,
- "noteCount": 0,
- "letterCount": 0
}, - "applicants": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "applicantID": "772",
- "phone": "555-0100",
- "dob": "5-15-1990",
- "ssn": "1234",
- "data": [
- {
- "field": "application",
- "label": "Application",
- "icon": "newspaper",
- "status": "complete",
- "value": "Submitted",
- "BadgeLabel": "Nov 16, 2026",
- "BadgeStatus": 1,
- "showIcon": false
}, - {
- "field": "animals",
- "label": "Animals",
- "icon": "paw-print",
- "value": "No Animals",
- "petsCount": 0,
- "showIcon": false,
- "serviceAnimalCount": 0,
- "valueSuffix": null,
- "BadgeLabel": null,
- "BadgeStatus": null,
- "scoringColor": null
}, - {
- "field": "identity",
- "label": "Identity",
- "icon": "circle-user",
- "value": "Manual",
- "showIcon": false,
- "BadgeLabel": "0 Files",
- "BadgeStatus": 5,
- "scoringColor": null
}
], - "templateID": "381",
- "templateName": "Standard Application",
- "isNonDefaultTemplate": false,
- "applicantType": "Applicant",
- "isApiUser": false,
- "isManagerSubmitted": true,
- "dateTimeCreated": "2026-11-16 19:53:20",
- "score": null,
- "scoringColor": null,
- "scoring": {
- "score": null,
- "scoringColor": null,
- "enabled": false,
- "assignedPoints": 0,
- "scoredPoints": 0,
- "missingPoints": 0,
- "totalPoints": 100,
- "thresholds": {
- "redMax": 49,
- "yellowMax": 79
}, - "sections": [ ]
}
}, - {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "applicantID": "773",
- "phone": "555-0100",
- "dob": "11-3-1973",
- "ssn": "5678",
- "data": [
- {
- "field": "application",
- "label": "Application",
- "icon": "newspaper",
- "status": "complete",
- "value": "Submitted",
- "BadgeLabel": "Nov 16, 2026",
- "BadgeStatus": 1,
- "showIcon": false
}, - {
- "field": "animals",
- "label": "Animals",
- "icon": "paw-print",
- "value": "No Animals",
- "petsCount": 0,
- "showIcon": false,
- "serviceAnimalCount": 0,
- "valueSuffix": null,
- "BadgeLabel": null,
- "BadgeStatus": null,
- "scoringColor": null
}, - {
- "field": "identity",
- "label": "Identity",
- "icon": "circle-user",
- "value": "Manual",
- "showIcon": false,
- "BadgeLabel": "0 Files",
- "BadgeStatus": 5,
- "scoringColor": null
}
], - "templateID": "381",
- "templateName": "Standard Application",
- "isNonDefaultTemplate": false,
- "applicantType": null,
- "isApiUser": false,
- "isManagerSubmitted": true,
- "dateTimeCreated": "2026-11-16 19:53:20",
- "score": null,
- "scoringColor": null,
- "scoring": {
- "score": null,
- "scoringColor": null,
- "enabled": false,
- "assignedPoints": 0,
- "scoredPoints": 0,
- "missingPoints": 0,
- "totalPoints": 100,
- "thresholds": {
- "redMax": 49,
- "yellowMax": 79
}, - "sections": [ ]
}
}
], - "pendingApplicants": [
- {
- "name": "Jane Doe",
- "email": "jane.doe@example.com",
- "applicantID": null,
- "invitationID": "11",
- "phone": null,
- "dob": null,
- "ssn": null,
- "data": [
- {
- "field": "application",
- "label": "Application",
- "value": "Not Started",
- "status": "incomplete",
- "BadgeLabel": "Steps 0/10",
- "BadgeStatus": 1,
- "showIcon": false
}, - {
- "field": "animals",
- "label": "Animals",
- "value": "--",
- "status": "incomplete",
- "BadgeLabel": null,
- "BadgeStatus": 1,
- "showIcon": false
}, - {
- "field": "identity",
- "label": "Identity",
- "value": "--",
- "status": "incomplete",
- "BadgeLabel": null,
- "BadgeStatus": 1,
- "showIcon": false
}
], - "isPending": true
}
], - "legacyReports": [
- {
- "report": {
- "reportID": "51",
- "reportOrderID": "51",
- "reportStatusID": "1",
- "reportProviderID": "2",
- "providerSourceID": "test-provider-source",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:53:20",
- "isPartiallyComplete": "0",
- "applicationID": "860",
- "createdByUserID": "1"
}, - "application": {
- "number": "100001",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345"
}, - "user": {
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - {
- "report": {
- "reportID": "52",
- "reportOrderID": "52",
- "reportStatusID": "2",
- "reportProviderID": "1",
- "providerSourceID": "test-provider-source",
- "isActive": "1",
- "dateTimeCreated": "2026-11-16 19:53:20",
- "isPartiallyComplete": "0",
- "applicationID": "860",
- "createdByUserID": "882"
}, - "application": {
- "number": "100001",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345"
}, - "user": {
- "firstName": null,
- "lastName": null,
- "email": null
}
}
], - "screeningReportModeID": 0
}
}Updates the status of a rental application and optionally sends a notification email to the applicant and/or additional recipients. This is the primary action used to move an application through the review pipeline (e.g. from Submitted → Under Review → Approved or Declined).
applicationStatusID must reference a valid system or custom status ID.sendEmail is true, the email object is required and must include at least one entry in recipients.emailTemplateID references an email template configured in the account. The template may include Liquid variables such as {{ application.applicantNames | list }} and {{ application.address }}.bcc and additionalRecipients accept arrays of email address strings.attachments accepts an array of file attachment references (empty array if none).copySender is treated as a string boolean: "1" = copy the sending user, "0" = do not copy.400 if applicationStatusID is missing or invalid.404 if the application does not exist or is not accessible.GET /screening/applications/{applicationID} — retrieve current application statusGET /screening/applications/{applicationID}/summary — full application review data| applicationID required | integer Example: 1702 The unique identifier of the application. |
| applicationStatusID required | string or integer^-?[0-9]+$ ID of the status to set on the application. Common system status IDs:
|
| sendEmail | boolean Default: false Whether to send a notification email to the applicant on status change. |
object Email configuration. Required when |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The updated application record. |
required | object The application status record set by this action. |
{- "applicationStatusID": "6",
- "sendEmail": true,
- "email": {
- "emailTemplateID": "22",
- "copySender": "0",
- "bcc": [
- "manager@example.com"
], - "additionalRecipients": [
- "owner@example.com"
], - "subject": "Your application is approved!",
- "message": "<p>Hello {{ application.applicantNames | list }},</p><p>Your application has been approved for {{ application.address }}. Please keep an eye out for an email to activate your tenant portal where you will be able to enter a payment to secure the unit.</p><p>Thanks!</p>",
- "attachments": [ ],
- "recipients": [
- "applicant@example.com"
]
}
}{- "application": {
- "applicationID": "1702",
- "number": "101653",
- "primaryApplicationStatusID": "1",
- "applicationStatusID": "1",
- "assignedToUserID": "45",
- "unitID": "709",
- "countryID": "US",
- "address": "9470 Corkscrew Palms Circle",
- "address2": "315",
- "city": "Estero",
- "stateID": "FL",
- "postalCode": "33928",
- "dateTimeCreated": "2026-04-20 13:59:38",
- "dateTimeModified": "2026-04-27 12:57:59"
}, - "status": {
- "applicationStatusID": "1",
- "primaryApplicationStatusID": "1",
- "isSystemStatus": "1",
- "name": "Pending",
- "orderIndex": "1"
}
}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}.
applicationID) or for a unit (unitID, unitIDs[]).dateTimeModifiedMin).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.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.| 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 |
| unitID | integer Example: unitID=709 Only applicants for this unit, from |
| unitIDs[] | Array of integers Example: unitIDs[]=709&unitIDs[]=710 Only applicants for any of these units. Send each as a separate |
| dateTimeCreatedMin | string Example: dateTimeCreatedMin=2026-11-01 Only applicants added on or after this date, |
| dateTimeCreatedMax | string Example: dateTimeCreatedMax=2026-11-30 Only applicants added before the start of this date, |
| dateTimeModifiedMin | string Example: dateTimeModifiedMin=2026-11-01 00:00:00 Only applicants last changed at or after this time, |
| dateTimeModifiedMax | string Example: dateTimeModifiedMax=2026-11-30 23:59:59 Only applicants last changed at or before this time, |
| 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. |
| pagination-page-size | integer Example: "2" Page size used: the requested |
| 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, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object The applicant's address applied for and rent. |
required | object The applicant's application. |
required | object The application's status. |
[- {
- "applicant": {
- "applicantID": "43",
- "applicantContactID": "591",
- "unitID": "551",
- "countryID": "US",
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "LA",
- "postalCode": "12345",
- "rent": "2409.41",
- "dateTimeCreated": "2026-11-16 20:16:29",
- "dateTimeModified": "2026-11-16 20:16:29"
}, - "application": {
- "applicationID": "43",
- "number": "100001"
}, - "status": {
- "applicationStatusID": "2",
- "primaryApplicationStatusID": "2",
- "isSystemStatus": "1",
- "name": "Submitted"
}
}, - {
- "applicant": {
- "applicantID": "44",
- "applicantContactID": "592",
- "unitID": null,
- "countryID": "US",
- "address": "123 Main St",
- "address2": null,
- "city": "Springfield",
- "stateID": "VA",
- "postalCode": "12345",
- "rent": "2296.32",
- "dateTimeCreated": "2026-11-16 20:16:29",
- "dateTimeModified": "2026-11-16 20:16:29"
}, - "application": {
- "applicationID": "44",
- "number": "100002"
}, - "status": {
- "applicationStatusID": "2",
- "primaryApplicationStatusID": "2",
- "isSystemStatus": "1",
- "name": "Submitted"
}
}
]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.
403 {"error": "Application 1702: Access Denied"}
(with the application's ID).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.400 with
the body []. When the income report is still processing and the provider can't be reached, it answers 500.From the code, not covered by a contract test:
POST /screening/applicants/{applicantID} - Change the applicant's answers.GET /screening/applicants - Find an applicant.GET /screening/applications/{applicationID} - Read the application.| applicantID required | integer Example: 1664 ID of the applicant. |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
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
|
required | object (applicant_data) The applicant's answers, one key per section of the template that is shown when the application is read (each
|
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
|
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
|
{- "applicant": {
- "applicantID": "180",
- "applicationID": "177",
- "templateID": "86",
- "userID": null,
- "firstName": "Jane",
- "middleName": null,
- "lastName": "Doe",
- "email": "jane.doe@example.com",
- "startedApplicationID": null
}, - "builder": {
- "id": "86",
- "name": "voluptatibus inventore magni Template",
- "settings": [ ],
- "steps": [
- {
- "id": 11,
- "name": "applicationInstructions",
- "label": "Application Instructions",
- "order": 10,
- "includedForView": 0,
- "includedForManagerCreate": false,
- "sections": [
- {
- "isSystemRequired": false,
- "isActive": true,
- "isMulti": false,
- "isPrintable": true,
- "name": "applicationInstructions",
- "label": "Application Instructions",
- "id": 21,
- "requiredCount": 0,
- "message": null,
- "buttonLabel": null,
- "addButtonLabel": null,
- "emptyMessage": null,
- "includedForView": 0,
- "groups": [ ]
}
]
}
], - "addenda": [
- {
- "systemAddendumTypeID": 1,
- "isSystemAddendum": true,
- "name": "Applicant Consent Form"
}
]
}, - "applicantData": {
- "applyingFor": {
- "address": "123 Main St",
- "city": "Springfield",
- "stateID": "RI",
- "postalCode": "12345",
- "countryID": "US"
}, - "leaseInfo": {
- "rent": "2879.93",
- "deposit": "539.51",
- "moveInDate": "2026-11-16",
- "leaseMonths": "10"
}, - "personalInfo": {
- "firstName": "Jane",
- "lastName": "Doe",
- "homePhone": "+12395550100",
- "workPhone": "+12395550100",
- "cellPhone": "+12395550100",
- "email": "jane.doe@example.com",
- "birthDate": "1990-01-01"
}, - "emergencyContacts": {
- "items": [
- {
- "name": "Jane Doe",
- "phone": "+12395550100",
- "relationship": "Friend"
}
]
}, - "references": [ ],
- "vehicles": {
- "items": [
- {
- "make": "Chevrolet",
- "color": "gray",
- "model": "eveniet",
- "yearBuilt": 2015,
- "licensePlate": "ONO-5826"
}
]
}, - "occupants": {
- "items": [
- {
- "name": "Holden Christiansen",
- "birthDate": "1990-01-01",
- "relationship": "Child"
}
]
}, - "pets": {
- "items": [
- {
- "name": "Paolo",
- "type": "dog",
- "breed": "deleniti",
- "weight": 28
}
]
}, - "currentAddress": {
- "primaryAddress": "123 Main St",
- "primaryCity": "Springfield",
- "primaryStateID": "MD",
- "primaryPostalCode": "12345",
- "primaryCountryID": "US",
- "primaryRentOwn": "own",
- "primaryMonthlyPayment": "1264",
- "primaryMoveInDate": "1980-04-10",
- "primaryManagerName": "Prof. Darrion Murazik DVM",
- "primaryManagerPhone": "+12395550100",
- "primaryManagerEmail": "jane.doe@example.com",
- "primaryReasonForLeaving": "Aut distinctio deleniti atque rerum officia debitis."
}, - "addressHistory": {
- "items": [
- {
- "city": "Springfield",
- "state": "OK",
- "address": "123 Main St",
- "moveInDate": "1987-07-31",
- "postalCode": "12345",
- "moveOutDate": "1996-02-12",
- "monthlyPayment": 2235.49
}
]
}, - "employmentHistory": {
- "items": [
- {
- "employer": "Abbott Ltd",
- "position": "Traffic Technician",
- "startDate": "1980-03-18",
- "monthlySalary": 5000,
- "isCurrentEmployer": "Yes"
}
]
}, - "income": [ ],
- "creditCards": [ ],
- "assistance": [ ],
- "questions": [ ],
- "terms": [ ],
- "reviewSign": [ ],
- "addenda": [ ]
}, - "addenda": [
- {
- "applicantAddendumID": "3",
- "applicantID": "180",
- "title": "Applicant Consent Form",
- "fileName": "consent-180.pdf",
- "fileSize": "48213",
- "systemAddendumTypeID": "1"
}
], - "transactions": {
- "statusID": "2",
- "estimate": {
- "estimatedIncome": 3969,
- "statedIncome": 5000,
- "difference": -20.6,
- "numMonthsForSample": 6
}, - "byMonth": [
- {
- "month": "2024-11",
- "amount": 0
}
], - "movingAverage": [
- {
- "month": "2024-11",
- "amount": 0
}
], - "transactions": [
- {
- "amount": 5265.31,
- "categoryID": "1",
- "plaidCategoryID": "21009000",
- "date": "2026-11-01",
- "accountName": "Plaid Checking"
}
], - "accountInfo": [ ],
- "verificationActive": false
}, - "identityVerification": {
- "statusID": "2",
- "identity": {
- "success": true,
- "verification": {
- "matchName": "match",
- "matchBirthDate": "match",
- "matchCountry": "match",
- "notExpired": "not_expired",
- "biometricCheck": "success"
}, - "data": {
- "documentType": "Driver's License",
- "idNumber": "D1234567",
- "expirationDate": "2030-12-31"
}
}, - "verificationActive": false,
- "files": [ ]
}
}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.
Screening › ModifyApplications); without it the API
answers 403 {"error": "Permission Denied"}.403 {"error": "Application 1702: Access Denied"}.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.applyingFor is replaced by the unit's address.rent, deposit and the like) come back as JSON numbers in the response.400 {"error": "Applicant not found"}, not a 404. A path value
that isn't a number answers the stock 404.dateTimeModified set.From the code, not covered by a contract test:
update event is recorded, and
the application's last-activity date is updated.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.| applicantID required | integer Example: 1664 ID of the applicant to change. |
The applicant's answers. {} is refused as empty.
required | object The address applied for. Required; for an applicant on a unit (the applicant'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 | |
Array of objects (terms) Acceptances of the template's terms, when its terms section is on. Each term's |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| applicantID required | string^-?[0-9]+$ The primary key of the applicant. |
| applicationID required | string^-?[0-9]+$ The application the applicant belongs to, readable at |
| number required | 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| rent required | string or number or null <decimal> Rent amount, as sent under |
| 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 |
| 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 |
| agentContactInformation required | string or null <= 100 characters Contact Info, as sent under |
| firstName required | string or null <= 50 characters First Name, as sent under |
| middleName required | string or null <= 50 characters Middle Name, as sent under |
| lastName required | string or null <= 50 characters Last Name, as sent under |
| email required | string or null <= 75 characters Email, as sent under |
| homePhone required | string or null <= 20 characters Home Phone, as sent under |
| cellPhone required | string or null <= 20 characters Cell Phone, as sent under |
| workPhone required | string or null <= 20 characters Work Phone, as sent under |
| birthDate required | string or null <date> Date of Birth, as sent under |
| birthPlace required | string or null <= 50 characters Birth Place, as sent under |
| ssnCiphertextID required | string or null^-?[0-9]+$ The stored, encrypted Social Security or taxpayer number. The number itself isn't returned. |
| ssnTruncated required | string or null <= 20 characters The last four digits of the Social Security or taxpayer number sent. |
| licenseNumber required | string or null <= 50 characters Drivers License #, as sent under |
| licenseState required | string or null <= 50 characters License State, as sent under |
| passportID required | string or null <= 50 characters Passport #, as sent under |
| studentID required | string or null <= 50 characters Student #, as sent under |
| maidenName required | string or null <= 50 characters Maiden Name, as sent under |
| height required | string or null <= 25 characters Height, as sent under |
| weight required | string or null <= 25 characters Weight, as sent under |
| eyeColor required | string or null <= 25 characters Eye Color, as sent under |
| hairColor required | string or null <= 25 characters Hair Color, as sent under |
| maritalStatus required | string or null <= 200 characters Marital Status, as sent under |
| citizenship required | string or null <= 100 characters Citizenship, as sent under |
| referredBy required | string or null <= 1000 characters How were you referred to us?, as sent under |
| assistanceAgency required | string or null <= 45 characters Agency, as sent under |
| assistanceCounty required | string or null <= 100 characters County, as sent under |
| assistanceTechnician required | string or null <= 100 characters Technician, as sent under |
| assistancePhone required | string or null <= 20 characters Phone, as sent under |
| assistanceAmount required | string or number or null <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 |
| 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 |
| primaryAddress required | string or null <= 100 characters Address, as sent under |
| primaryAddress2 required | string or null <= 100 characters Unit/Apt #, as sent under |
| primaryCity required | string or null <= 100 characters City, as sent under |
| primaryStateID required | string or null <= 3 characters State, as sent under |
| primaryPostalCode required | string or null <= 20 characters Postal Code, as sent under |
| primaryCountryID required | string or null <= 2 characters Country of the applicant's current address, a two-letter code, as sent under |
| primaryRentOwn required | string or null <= 200 characters Rent / Own, as sent under |
| 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 |
| primaryManagerName required | string or null <= 100 characters Manager Name, as sent under |
| primaryManagerPhone required | string or null <= 20 characters Manager Phone, as sent under |
| primaryManagerEmail required | string or null <= 75 characters Manager Email, as sent under |
| primaryReasonForLeaving required | string or null Reason for Leaving, as sent under |
| signature required | string or null <= 100 characters The applicant's signature; null 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 |
| terms required | Array of objects or null The acceptances of the template's terms, as sent under |
| addendumSignature required | string or null <= 100 characters The applicant's signature on the addenda; null 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: |
| 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: |
| 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 |
| dateTimeModified required | string When the applicant was last changed. UTC, formatted |
| 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. |
{- "applyingFor": {
- "address": "123 Main St",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "countryID": "US"
}, - "leaseInfo": {
- "rent": "1650.00",
- "deposit": "1650.00",
- "moveInDate": "2026-12-01",
- "leaseMonths": "12"
}, - "personalInfo": {
- "firstName": "Jane",
- "middleName": "Q",
- "lastName": "Doe",
- "email": "jane.doe@example.com",
- "cellPhone": "+12395550100",
- "birthDate": "1990-01-01"
}, - "currentAddress": {
- "primaryAddress": "123 Main St",
- "primaryCity": "Springfield",
- "primaryStateID": "FL",
- "primaryPostalCode": "12345",
- "primaryCountryID": "US"
}, - "vehicles": {
- "items": [
- {
- "make": "Honda",
- "model": "Civic",
- "yearBuilt": "2019",
- "color": "Silver"
}
]
}
}{- "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": {
- "items": [
- {
- "name": "Dr. Rashawn Kozey",
- "birthDate": "1990-01-01",
- "relationship": "Child"
}
]
}, - "pets": {
- "items": [
- {
- "name": "Khalil",
- "type": "dog",
- "breed": "in",
- "weight": 38
}
]
}, - "references": null,
- "vehicles": {
- "items": [
- {
- "make": "Honda",
- "model": "Civic",
- "yearBuilt": "2019",
- "color": "Silver",
- "_id": 1
}
], - "maxID": 1
}, - "questions": null,
- "terms": null,
- "addendumSignature": null,
- "addendumInitials": null,
- "incomeVerificationReportToken": "f3c9a72a-3908-32db-b990-815088260d08",
- "incomeVerificationReportStatusID": "2",
- "incomeVerificationReportData": {
- "transactions": [
- {
- "date": "2026-11-01",
- "amount": 5451.61,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}, - {
- "date": "2026-10-01",
- "amount": 5065.02,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}, - {
- "date": "2026-09-01",
- "amount": 5630.69,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}, - {
- "date": "2026-08-01",
- "amount": 4903.69,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}, - {
- "date": "2026-07-01",
- "amount": 4734.79,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}, - {
- "date": "2026-06-01",
- "amount": 5112.67,
- "categoryID": 1,
- "accountName": "Plaid Checking",
- "plaidCategoryID": "21009000"
}
]
}, - "incomeVerificationReportError": null,
- "identityVerificationReportStatusID": "2",
- "identityVerificationReportData": {
- "identity_verifications": [
- {
- "steps": {
- "accept_tos": "success",
- "verify_sms": "success",
- "selfie_check": "success"
}, - "status": "success",
- "created_at": "2026-11-16 20:18:04",
- "completed_at": "2026-11-16 20:18:04",
- "selfie_check": {
- "selfies": [
- {
- "status": "success",
- "attempt": 1,
- "capture": [ ],
- "analysis": {
- "liveness_check": "success",
- "document_comparison": "match"
}
}
]
}, - "client_user_id": "scenario-builder",
- "documentary_verification": {
- "documents": [
- {
- "images": [ ],
- "status": "success",
- "attempt": 1,
- "analysis": {
- "extracted_data": {
- "name": "match",
- "date_of_birth": "match",
- "expiration_date": "not_expired",
- "issuing_country": "match"
}
}, - "extracted_data": {
- "category": "drivers_license",
- "id_number": "D1234567",
- "expiration_date": "2030-12-31",
- "issuing_country": "US"
}
}
]
}
}
]
}, - "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
}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.
403.ssn; without, the response carries ssnTruncated as null instead, and no ssn.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 resultsGET /screening/applications/{applicationID} - the application| applicantID required | integer Example: 765 The applicant's ID, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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 |
| 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 |
| 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, |
| 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 ( |
| 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 |
required | object or string or null (applicant_address_history) The prior addresses the applicant listed on the application form, as the form stored them: |
required | object or string or null (applicant_employment_history) The employers the applicant listed on the application form, as the form stored them: |
required | object or string or null (applicant_occupants) The other occupants the applicant listed on the application form, as the form stored them: |
required | object or string or null (applicant_vehicles) The vehicles the applicant listed on the application form, as the form stored them: |
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 ( |
| petScreeningEnabled required | boolean Whether the applicant's pets are screened through PetScreening. |
required | object or null The applicant's PetScreening status, or |
| ssn | string <= 20 characters The last four digits of the applicant's Social Security number. Sent only when they are on file; otherwise |
| ssnTruncated | null Sent, always |
{- "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": {
- "items": [
- {
- "_id": 1,
- "city": "Springfield",
- "address": "123 Main St",
- "rentOwn": "Rent",
- "stateID": "FL",
- "postalCode": "12345",
- "monthlyPayment": "1200"
}
], - "maxID": 1
}, - "employmentHistory": {
- "items": [
- {
- "_id": 1,
- "name": "Example Employer",
- "position": "Analyst",
- "monthlySalary": "5000",
- "isCurrentEmployer": "Yes"
}
], - "maxID": 1
}, - "occupants": {
- "items": [
- {
- "_id": 1,
- "name": "Riley Example",
- "birthDate": "1990-01-01",
- "relationship": "Child"
}
], - "maxID": 1
}, - "vehicles": {
- "items": [
- {
- "_id": 1,
- "make": "Example",
- "color": "Blue",
- "model": "Sedan",
- "state": "FL",
- "yearBuilt": "2020",
- "plateNumber": "ABC1234"
}
], - "maxID": 1
}, - "ssn": "1234",
- "builder": {
- "sections": [
- {
- "isSystemRequired": true,
- "isActive": true,
- "isMulti": false,
- "isPrintable": true,
- "name": "applyingFor",
- "label": "Applying For",
- "id": 1,
- "requiredCount": 0,
- "message": null,
- "buttonLabel": null,
- "addButtonLabel": null,
- "emptyMessage": null,
- "includedForView": 1,
- "groups": [
- {
- "fields": [
- {
- "isSystemRequired": true,
- "isActive": 1,
- "isRequired": true,
- "name": "address",
- "label": "Address",
- "id": 1,
- "type": "text",
- "canDisable": false,
- "fieldTypeID": 1,
- "options": null,
- "isLockedLabel": true,
- "helperText": null,
- "isEditable": false
}
]
}
]
}
]
}, - "applicantData": {
- "applyingFor": {
- "address": "123 Main St",
- "address2": "Apt 4",
- "city": "Springfield",
- "stateID": "FL",
- "postalCode": "12345",
- "countryID": "US"
}, - "leaseInfo": {
- "rent": "1738.59",
- "deposit": "640.73",
- "moveInDate": "2026-12-15",
- "leaseMonths": "12"
}, - "personalInfo": {
- "firstName": "Jane",
- "middleName": "Q",
- "lastName": "Doe",
- "applicantType": "Applicant",
- "homePhone": "555-0100",
- "workPhone": "555-0100",
- "cellPhone": "555-0100",
- "email": "jane.doe@example.com",
- "birthDate": "1990-01-01",
- "ssn": "1234",
- "licenseNumber": "X0000000",
- "licenseState": "FL"
}, - "emergencyContacts": [ ],
- "references": [ ],
- "vehicles": {
- "items": [
- {
- "_id": 1,
- "make": "Example",
- "color": "Blue",
- "model": "Sedan",
- "state": "FL",
- "yearBuilt": "2020",
- "plateNumber": "ABC1234"
}
], - "maxID": 1
}, - "occupants": {
- "items": [
- {
- "_id": 1,
- "name": "Riley Example",
- "birthDate": "1990-01-01",
- "relationship": "Child"
}
], - "maxID": 1
}, - "pets": [ ],
- "currentAddress": [ ],
- "addressHistory": {
- "items": [
- {
- "_id": 1,
- "city": "Springfield",
- "address": "123 Main St",
- "rentOwn": "Rent",
- "stateID": "FL",
- "postalCode": "12345",
- "monthlyPayment": "1200"
}
], - "maxID": 1
}, - "employmentHistory": {
- "items": [
- {
- "_id": 1,
- "name": "Example Employer",
- "position": "Analyst",
- "monthlySalary": "5000",
- "isCurrentEmployer": "Yes"
}
], - "maxID": 1
}, - "income": [ ],
- "bankAccounts": [ ],
- "creditCards": [ ],
- "assistance": [ ],
- "questions": [ ],
- "terms": [ ],
- "reviewSign": [ ],
- "addenda": [
- {
- "applicantAddendumID": "9",
- "applicantID": "765",
- "title": "Pet Policy Addendum",
- "fileName": "contract-addendum-6afb5f2d76166.pdf",
- "fileSize": "20480",
- "systemAddendumTypeID": null
}
]
}, - "petScreeningEnabled": false,
- "petscreeningData": {
- "dataProviderName": "PetScreening",
- "dataProviderID": 5,
- "expectedProfiles": 0,
- "statusID": 1,
- "profiles": [ ]
}
}Orders one or more screening reports (credit, criminal, eviction) for specified applicants on a rental application. Reports are requested from the integrated screening provider and results are associated with the applicant records.
applicationID must reference an existing, accessible application.applicantIDs must contain at least one applicant ID. All provided applicants must belong to the specified application.reportTypeIDs must contain at least one valid report type. Supported report type IDs:1 — Credit2 — Criminal3 — EvictionapplicationProviderID in screening settings).400 if any applicant ID does not belong to the specified application or if reportTypeIDs is empty.GET /screening/applications/{applicationID}/summary to check report status.GET /screening/settings — verify screening provider is configuredGET /screening/applications/{applicationID}/summary — check report status after orderingGET /screening/applicants/{applicantID}/tab/application — view applicant details before ordering| applicationID required | string or integer^-?[0-9]+$ ID of the application to order reports for. |
| applicantIDs required | Array of integers non-empty List of applicant IDs to run reports for. All must belong to the specified application. |
| reportTypeIDs required | Array of integers non-empty Items Enum: 1 2 3 List of report type IDs to order.
|
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
Confirmation that screening report requests were submitted.
{- "applicationID": "1702",
- "applicantIDs": [
- 1664
], - "reportTypeIDs": [
- 1,
- 2,
- 3
]
}{- "success": true,
- "message": "Screening reports have been ordered"
}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.
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.
customFieldCategoryObjectTypeID values to use with POST /custom-field-categories, GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} and the values endpoints"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.GET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} - list one record type's categories and fieldsPOST /custom-field-categories - create a category for one of these record typesGET /custom-fields/values/{objectTypeID}/{objectID} - read one record's custom field values| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| customFieldCategoryObjectTypeID required | integer Enum: 1 2 3 4 5 6 8 9 10 11 12 13 The record type, as a JSON number.
|
| 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. |
[- {
- "customFieldCategoryObjectTypeID": 1,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 2,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 3,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 4,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 5,
- "categoryCount": "2",
- "fieldCount": "3"
}, - {
- "customFieldCategoryObjectTypeID": 6,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 8,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 9,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 10,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 11,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 12,
- "categoryCount": "0",
- "fieldCount": "0"
}, - {
- "customFieldCategoryObjectTypeID": 13,
- "categoryCount": "0",
- "fieldCount": "0"
}
]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.
customFieldID, its type and its settings (a dropdown's options)orderIndex, and each category's fields by theirs.customFields array.GET /custom-field-category-object-types - list the record typesGET /custom-fields/values/{objectTypeID}/{objectID} - read one record's custom field valuesPOST /custom-fields/values/{objectTypeID}/{objectID} - save one record's custom field valuesPOST /custom-field-categories - create a category for this record type| customFieldCategoryObjectTypeID required | integer Example: 5 The record type, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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"
|
| 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 |
[- {
- "customFieldCategoryID": "43",
- "customFieldCategoryObjectTypeID": "3",
- "name": "aliquid illum quos",
- "orderIndex": "1",
- "customFields": [
- {
- "customFieldID": "50",
- "customFieldCategoryID": "43",
- "name": "Preferred contact",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "3",
- "settings": "{\"description\":\"How the vendor likes to be reached\"}",
- "orderIndex": "1",
- "valueColumn": "text_2"
}, - {
- "customFieldID": "49",
- "customFieldCategoryID": "43",
- "name": "Trade license",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "3",
- "settings": "{\"description\":null}",
- "orderIndex": "2",
- "valueColumn": "text_1"
}
]
}, - {
- "customFieldCategoryID": "42",
- "customFieldCategoryObjectTypeID": "3",
- "name": "dignissimos itaque provident",
- "orderIndex": "2",
- "customFields": [ ]
}
]Creates a new custom field category under the specified object type. A category acts as a named grouping for related custom fields. After creating a category, custom fields can be added to it via the Rentvine UI or subsequent API calls.
name and customFieldCategoryObjectTypeID together must be unique — a category with the same name cannot be created more than once for the same object typecustomFieldCategoryObjectTypeID must reference a valid object type from GET /custom-field-category-object-typesGET /custom-field-category-object-types — list available object types to find a valid customFieldCategoryObjectTypeIDGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — verify the new category appears in the list after creationGET /custom-fields/values/{objectTypeID}/{objectID} — retrieve field values for objects in this category's object type| name required | string Display name for the new custom field. Must be unique within the given category. |
| customFieldCategoryObjectTypeID required | string or integer^-?[0-9]+$ ID of the object type this category belongs to. Obtain valid values from |
| customFieldCategoryID required | string or integer^-?[0-9]+$ ID of the category this field will be added to. |
| fieldTypeID required | string or integer Enum: "1" "2" "3" "4" "5" "6" "7" "8" 1 2 3 4 5 6 7 8 Controls the input type rendered for this field.
|
| options | string JSON-encoded array of options for Dropdown fields. Use |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
required | object |
{- "name": "test-docs",
- "fieldTypeID": 1,
- "options": "[]",
- "customFieldCategoryID": "43",
- "customFieldCategoryObjectTypeID": "1"
}{- "customField": {
- "customFieldID": "610",
- "customFieldCategoryID": "43",
- "name": "test-docs",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "1",
- "settings": "{\"description\":null}",
- "orderIndex": "7",
- "valueColumn": "text_12"
}
}Deletes a custom field category with every custom field in it, and clears those fields' values on every record of the category's record type. Returns the deleted category.
Administration › ManageCustomFields), checked
before anything else: a key without it gets the 403 whatever the body or ID.customFieldCategoryID with no category answers 400 Custom Field Category {customFieldCategoryID} not found; one that isn't all digits (abc, -1) answers the stock 404.GET /custom-field-categories (undocumented) - the account's categoriesDELETE /custom-fields/{customFieldID} - delete one field| customFieldCategoryID required | integer Example: 7 The category, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| customFieldCategoryID required | string^-?[0-9]+$ The primary key of the category. |
| customFieldCategoryObjectTypeID required | string (custom_field_category_object_types) Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13" The record type the category's fields belong to.
|
| name required | string <= 200 characters The category's name. |
| orderIndex required | string^-?[0-9]+$ The category's position among the record type's categories, from |
{- "customFieldCategoryID": "7",
- "customFieldCategoryObjectTypeID": "5",
- "name": "Access details",
- "orderIndex": "0"
}Deletes a custom field and clears its value on every record of its record type. Returns the deleted field.
Administration › ManageCustomFields), checked
before anything else: a key without it gets the 403 whatever the body or ID.customFieldID with no field answers 400 Custom Field {customFieldID} not found; one that isn't
all digits (abc, -1) answers the stock 404.GET /custom-fields/values/{objectTypeID}/{objectID} - a record's custom field valuesDELETE /custom-field-categories/{customFieldCategoryID} - delete a whole category and its fields| customFieldID required | integer Example: 21 The custom field, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| customFieldID required | string^-?[0-9]+$ The primary key of the custom field. |
| customFieldCategoryID required | string^-?[0-9]+$ The category the field is grouped under. |
| name required | string <= 200 characters The field's name, shown as its label. |
| fieldTypeID required | string (custom_field_types) Enum: "1" "2" "3" "4" "5" "6" "7" "8" The kind of value the field holds.
|
| customFieldCategoryObjectTypeID required | string (custom_field_category_object_types) Enum: "1" "2" "3" "4" "5" "6" "8" "9" "10" "11" "12" "13" The record type the field belongs to, from its category.
|
| settings required | string or null The field's settings (its description, and a dropdown's options) as a JSON-encoded string, such as |
| orderIndex required | string^-?[0-9]+$ The field's position within its category, from |
| valueColumn required | string or null <= 20 characters The internal column the field's values are stored in ( |
{- "customFieldID": "21",
- "customFieldCategoryID": "27",
- "name": "Gate code",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":\"Side gate code\"}",
- "orderIndex": "0",
- "valueColumn": "text_1"
}Returns a record type's custom field categories, each with its fields under fields, and each field's value for one record under value.
customFieldCategoryIDGET /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"}.objectID with no record (or one with no saved values) answers its categories and fields with every value null.orderIndex, and each category's fields by theirs.POST /custom-fields/values/{objectTypeID}/{objectID} - save the record's custom field valuesGET /custom-field-category-object-types - list the record typesGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} - list a record type's categories and fields, without values| objectTypeID required | integer Example: 5 The record type, as
|
| objectID required | integer Example: 577 The record's ID (a property ID for record type |
| customFieldCategoryID | integer Example: customFieldCategoryID=12 Only this category, from |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| 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"
|
| 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 |
[- {
- "customFieldCategoryID": "50",
- "customFieldCategoryObjectTypeID": "5",
- "name": "perferendis quo ut",
- "orderIndex": "0",
- "fields": [
- {
- "customFieldID": "59",
- "customFieldCategoryID": "50",
- "name": "Gate code",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":\"Side gate code\"}",
- "orderIndex": "0",
- "valueColumn": "text_1",
- "value": "4417"
}, - {
- "customFieldID": "60",
- "customFieldCategoryID": "50",
- "name": "Door color",
- "fieldTypeID": "1",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":null}",
- "orderIndex": "1",
- "valueColumn": "text_2",
- "value": null
}
]
}, - {
- "customFieldCategoryID": "51",
- "customFieldCategoryObjectTypeID": "5",
- "name": "qui rerum illum",
- "orderIndex": "1",
- "fields": [
- {
- "customFieldID": "61",
- "customFieldCategoryID": "51",
- "name": "ut tempore omnis",
- "fieldTypeID": "5",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":null}",
- "orderIndex": "0",
- "valueColumn": "date_1",
- "value": "2026-03-15"
}, - {
- "customFieldID": "62",
- "customFieldCategoryID": "51",
- "name": "aliquam magnam dolor",
- "fieldTypeID": "4",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":null}",
- "orderIndex": "1",
- "valueColumn": "toggle_1",
- "value": "1"
}
]
}
]Saves or updates the custom field values for a specific object. The request body is a flat map where each key is a customFieldID (as a string) and the value is the new value to save. A customFieldCategoryID key must be included to scope the update to the correct category.
Only the fields provided in the payload are updated. Fields not included in the payload retain their existing values.
nullobjectTypeID and objectID in the path must match a valid objectcustomFieldID values cast to stringscustomFieldCategoryID is required in the payload to scope the write to the correct categorynull clears any previously stored valueGET /custom-fields/values/{objectTypeID}/{objectID})GET /custom-fields/values/{objectTypeID}/{objectID} — retrieve current field values for the objectGET /custom-field-category-object-types/{customFieldCategoryObjectTypeID} — list categories and fields to know which customFieldID keys are valid| objectTypeID required | integer Example: 5 The ID of the object type (e.g., |
| objectID required | integer Example: 577 The unique ID of the specific object whose custom field values are being saved. |
| customFieldCategoryID required | string or integer^-?[0-9]+$ The ID of the category being updated. All field IDs in the payload must belong to this category. |
| property name* additional property | string or null A custom field value keyed by its |
| RateLimit-Policy | string^"(?:[^"\\]|\\.)*";q=[0-9]+(?:;w=[0-9]+)?(?:,... Example: "\"account\";q=10000;w=60, \"user\";q=1200;w=60, \"api-key\";q=120;w=60" The limits counted for this request, as a list of named limits (Rate Limits): for each, A signed-in request lists |
| RateLimit | string^"(?:[^"\\]|\\.)*";r=[0-9]+;t=[0-9]+(?:, "(?:... Example: "\"account\";r=9999;t=60, \"user\";r=1199;t=60, \"api-key\";r=119;t=1" Where you stand against each limit in The limit with the lowest |
| 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 |
| customFieldCategoryID required | string^-?[0-9]+$ Unique identifier for the custom field category. |
| customFieldCategoryObjectTypeID required | string^-?[0-9]+$ The object type this category belongs to. |
| name required | string Display name of the custom field category. |
| orderIndex required | string^-?[0-9]+$ Sort order of the category. |
required | Array of objects Updated list of custom fields with their latest values. |
{- "364": null,
- "469": "test",
- "customFieldCategoryID": "96"
}[- {
- "customFieldCategoryID": "12",
- "customFieldCategoryObjectTypeID": "5",
- "name": "Alarm System",
- "orderIndex": "1",
- "fields": [
- {
- "customFieldID": "25",
- "customFieldCategoryID": "12",
- "name": "Numeric Alarm Pad",
- "fieldTypeID": "8",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":null}",
- "orderIndex": "0",
- "valueColumn": "integer_2",
- "value": "123"
}, - {
- "customFieldID": "50",
- "customFieldCategoryID": "12",
- "name": "Alarm Provider",
- "fieldTypeID": "3",
- "customFieldCategoryObjectTypeID": "5",
- "settings": "{\"description\":null,\"options\":\"[\\\"Simply Safe\\\",\\\"Tyco\\\",\\\"ADT\\\"]\"}",
- "orderIndex": "1",
- "valueColumn": "text_7",
- "value": null
}
]
}
]