Yardi · Schema

Yardi Resident Transaction

Schema for a Yardi Voyager resident transaction record including charges, payments, and credits.

AccountingCommercial Real EstateCoworkingInvestment ManagementMultifamilyProperty ManagementReal EstateResidentialSelf StorageSenior Living

Properties

Name Type Description
transactionId string Unique transaction identifier
tenantId string Tenant identifier associated with the transaction
propertyId string Property identifier
unitId string Unit identifier
transactionDate string Date the transaction was posted
chargeDate string Date the charge was applied
transactionType string Type of financial transaction
chargeCode string Yardi charge code identifying the transaction category
description string Description of the transaction
amount number Transaction amount in USD
balance number Tenant account balance after transaction
reference string External reference or check number
View JSON Schema on GitHub

JSON Schema

yardi-transaction-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/yardi/main/json-schema/yardi-transaction-schema.json",
  "title": "Yardi Resident Transaction",
  "description": "Schema for a Yardi Voyager resident transaction record including charges, payments, and credits.",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "Unique transaction identifier"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant identifier associated with the transaction"
    },
    "propertyId": {
      "type": "string",
      "description": "Property identifier"
    },
    "unitId": {
      "type": "string",
      "description": "Unit identifier"
    },
    "transactionDate": {
      "type": "string",
      "format": "date",
      "description": "Date the transaction was posted"
    },
    "chargeDate": {
      "type": "string",
      "format": "date",
      "description": "Date the charge was applied"
    },
    "transactionType": {
      "type": "string",
      "enum": ["Charge", "Payment", "Credit", "Adjustment", "NSF"],
      "description": "Type of financial transaction"
    },
    "chargeCode": {
      "type": "string",
      "description": "Yardi charge code identifying the transaction category"
    },
    "description": {
      "type": "string",
      "description": "Description of the transaction"
    },
    "amount": {
      "type": "number",
      "description": "Transaction amount in USD"
    },
    "balance": {
      "type": "number",
      "description": "Tenant account balance after transaction"
    },
    "reference": {
      "type": "string",
      "description": "External reference or check number"
    }
  },
  "required": ["transactionId", "tenantId", "propertyId", "transactionDate", "transactionType", "amount"]
}