Skip to main content

Version Docs Updated

Purpose

This page is the standard reference documentation for all keywords, database fields, and technical definitions used in the MHM Rentiva financial module.

πŸ“– Financial Data Dictionary

Financial data in the Rentiva ecosystem is stored across three main layers: Global Settings (Options), User Information (User Meta), and Transaction Details (Payout/Booking Meta).

βš™οΈ Global Settings (Options)​

System-wide financial configurations stored in the wp_options table:

KeyTypeDescription
mhm_min_payout_amountfloatMinimum balance a vendor must have to request a Payout.
mhm_rentiva_global_payout_freezeboolEmergency switch that halts all Payouts system-wide.
mhm_rentiva_payout_webhook_secretstringHMAC-signed secret key used for Payout notifications.
mhm_rentiva_commission_tiersjsonThreshold values that determine discount rates based on sales volume.

πŸ‘€ Vendor Financial Data (User Meta)​

Data stored per vendor in the wp_usermeta table:

KeyTypeDescription
_mhm_vendor_commission_ratefloatFixed commission rate defined specifically for this vendor (Override).
_mhm_vendor_payout_freezeboolBlock status that prevents only this vendor from receiving Payouts.
_mhm_vendor_tier_idstringThe performance tier the vendor currently belongs to.

πŸ’° Payout Data (Post Meta)​

Metadata stored under the mhm_rentiva_payout post type:

KeyTypeDescription
_mhm_payout_amountfloatNet amount requested or paid.
_mhm_payout_statusstringStatus: pending, processing, completed, rejected.
_mhm_payout_external_refstringReference number from the bank or payment gateway (Stripe, etc.).
_mhm_payout_rejection_reasonstringExplanation text entered for rejected requests.

πŸ”‘ Capabilities​

WordPress capabilities required to manage financial operations:

  • mhm_rentiva_approve_payout: Permission to approve Payout requests.
  • mhm_rentiva_freeze_payout: Permission to freeze/block Payouts.
  • mhm_rentiva_view_financial_audit: Permission to view audit logs and Ledger details.

πŸ”„ Data Relationship Map​

Section Summary​

  • All financial keys are stored with the _mhm_ prefix (private meta).
  • Critical operations (e.g., payout_status) can only be changed by authorized (Capabilities) users.
  • For fields in the Ledger table, see the Ledger Model page.

Changelog​

DateVersionNote
23.04.20264.27.2English translation added.
19.03.20264.21.2Page updated to reflect the plugin's current Meta and Option keys.