Skip to content

Peppermint Backend Documentation

This site collects the operational and technical documentation for Peppermint backend middleware, Zoho automations, Xero invoice workflows, Power BI support, and process rules.

The order below follows the site navigation defined in mkdocs.yml.

Processes

  • Process overview explains implemented business workflows and the operator-facing rules behind CRM, Projects, Xero, and reporting changes.
  • Deal Process covers Deal creation, project setup checks, reserved/pending stage handling, and Delivery Model review.
  • MSP Invoicing Process covers recurring MSP invoice setup, seat billing patterns, invoice lines, generation, review, and deliberate limits.
  • Business Rules Register indexes implemented mutating workflows, their business events, changed records, rule documents, and technical references.

Business Rules

  • Deals, Projects, and Delivery Models documents the implemented rules for Deal-triggered project setup, reserved / approval / payment pending setup, and Delivery Model progress calculations.
  • MSP Invoicing documents the implemented business rules for MSP invoice generation and MSP Invoice Line reconciliation.
  • Reporting Assumptions captures process-relevant assumptions used by Power BI and exported report data.

Dev

  • Flask App Architecture explains the app boundary, route groups, settings, auth, clients, reporting, webhooks, and tests.
  • Xero CRM Invoice Integration documents the CRM/Xero invoice integration, data mapping, operational commands, and CRM button routes.

Reference Material