Prerequisites

• Module base installed (every HMX project has this).
• Module core_product installed — taxes and invoice lines reference products.
• Module hmx_universal_features installed — provides currency, company, and partner.
• At least one Company record defined with a base currency.
• At least one Fiscal Year with open Fiscal Periods — postings fail without an open period.

Installation Steps

First-Time Setup

1. Define your Chart of Accounts — either import a localized template (ID-GAAP, SAK-EMKM, IFRS) or create account codes manually. Every other step depends on this.
2. Create Account Types — group accounts into Asset / Liability / Equity / Income / Expense with correct statement placement and closing rules.
3. Open a Fiscal Year and generate its Periods (usually 12 monthly periods). Postings are rejected if no period is open for the entry date.
4. Create at least one Journal per type — Sales, Purchase, Bank, Cash, Miscellaneous. Each journal carries a default account and a sequence for entry numbering.
5. Configure Taxes — VAT / PPN / GST rates used by your country, with the accounts to post tax-collected and tax-paid into.
6. Seed Opening Balances — post a single Opening Journal Entry dated Day-1 of the fiscal year, debiting / crediting every balance-carrying account with its opening value. Must balance to zero.

Technical Setup Notes

Module Dependencies

Auto-Sequences

Each AccountJournal owns a seq_entry (FK to a sequence template) used to generate Journal Entry numbers like SAL/2026/00001. A separate refund_seq_entry is used when dedicated_refund_sequence is enabled.

Post-install Checks

• Verify modules appear in hmx list-modules.
• Confirm /chartofaccount/ view loads (if empty, import template).
• Confirm /accountjournal/ view loads and shows seeded journals.

What is a Chart of Accounts?

A Chart of Accounts (CoA) is the structured list of every account available to be debited or credited in your business. Each account is identified by a short code (e.g. 1-1100 for Cash, 4-1000 for Sales Revenue) and tagged with an Account Type that determines where it lands on the financial statements.

The CoA is hierarchical — parent accounts aggregate their children for reporting, while only leaf accounts are postable. This lets you design statements with any depth (Assets → Current Assets → Cash & Equivalents → Petty Cash) without creating a flat list of hundreds of entries.

How to Create an Account

Account Types Explained

Every account must belong to one Account Type. The type drives three behaviors:

• Statement placement — Asset / Liability / Equity → Balance Sheet; Income / Expense → Profit & Loss.
• Reconcilable flag — only reconcilable types (e.g. Receivable, Payable) can be matched between documents and payments.
• Year-end closing — P&L accounts close to Retained Earnings; Balance Sheet accounts carry their ending balance forward as the new year's opening balance.

Chart of Accounts Technical Reference

Model: chartofaccount

Related Models

• accounttype — groups accounts into Asset/Liability/Equity/Income/Expense with closing rules.
• accountjournal.default_account_id — each journal has a default account used when lines don't specify one.
• accountdocumentline.account, journalentryline.account_code — every transaction line points here.

What is a Journal Entry?

A Journal Entry is a single balanced posting to the general ledger. It belongs to one Journal (Sales, Purchase, Bank, Cash, Misc), references one Fiscal Period, and contains two or more Entry Lines whose debits must equal their credits.

Most entries are created automatically: confirming an invoice, registering a payment, or validating a stock move each trigger an entry. Manual entries cover adjustments, reclassifications, accruals, depreciation, and opening balances.

Each entry moves through three statuses: Draft (editable, no ledger impact), Posted (locked, visible in reports), and optionally Reversed (a mirror entry cancels the original).

How to Create a Manual Journal Entry

Posting Rules Explained

• Balance rule — sum of debits = sum of credits for every entry. Non-balanced drafts cannot be posted.
• Period rule — entry date must fall inside an open fiscal period. Closed-period postings require re-opening or a new adjustment period.
• Currency rule — if the entry currency differs from the company currency, an inverse_rate and rate are stamped; both currency and company-currency amounts are stored per line.
• Immutability — posted entries cannot be edited. To correct a mistake, create a reversed entry (system auto-generates a mirror with debits and credits swapped) and post the correct one.
• Source tracking — auto-generated entries store source_type and origin_account_document so reports can drill back to the invoice / payment / stock move that produced them.

Journal Entry Technical Reference

Model: journalentry

Model: journalentryline

What is an Account Document?

An Account Document is the printable record a customer, vendor, or tax authority sees: a sales invoice, a supplier bill, a credit note, or a debit note. Internally, it's also the master that generates the corresponding Journal Entry when confirmed.

A document has a header (partner, date, journal, fiscal period, payment terms, totals) and one or more lines. Each Account Document Line ties a product or description to an account, a quantity, a unit price, and optional taxes. At confirmation, the system computes tax, allocates lines to the right accounts (revenue / expense / AR / AP / tax), and posts the resulting journal entry.

How to Create an Invoice

Document Rules & Prepayments

• Draft vs. Posted — only drafts are editable. Posting locks the document and creates the ledger impact. Cancelling a posted document requires a reversing entry.
• Fiscal Position — maps default accounts and taxes per partner (e.g. export customer → 0% tax, domestic → 11% VAT). Applied at line level when the document is saved.
• Prepayment flag — has_prepayment marks documents that consume a customer prepayment; linked via prepaymentdetail rows that reconcile the prepaid amount before touching AR.
• Reconciliation — posted documents sit against the partner's AR/AP balance until a Payment reconciles them. Partial payments leave the remainder open.

Account Document Technical Reference

Model: accountdocument

Model: accountdocumentline

Each line carries an account FK, quantity, unit price, and M2M taxes. core_invoicing extends this model to 16 fields including discount, unit-of-measure, tax-base amount, and line-level fiscal position override.

What is a Payment?

A Payment represents money moving in or out of a bank / cash account that belongs to your company. Customer payments reduce the partner's receivable balance; vendor payments reduce the payable balance. Each payment posts a journal entry through the chosen bank or cash journal.

Three payment flavors live in HMX:

• Account Payment — the default cash / bank movement, reconciled against one or more Account Documents.
• Cheque Payment — dated cheques with their own lifecycle (issued → cleared / bounced), tracked via accountchequepayment.
• Deposit — batch multiple incoming cheques / transfers into a single bank deposit slip, reconciled as a group.

How to Register a Payment

Cheque Handling

Cheques have a multi-stage lifecycle because the cash doesn't clear on the day it's received. HMX handles this with AccountChequePayment + AccountChequePaymentLine:

1. Received — cheque is logged but not yet cleared; posts to an intermediate "cheques on hand" account.
2. Deposited — bundled into an AccountDeposit batch and submitted to the bank.
3. Cleared — bank confirms funds; the cheque line is marked paid and the intermediate balance moves to the actual bank account.
4. Bounced — cleared state is reversed; a bounce history row is written to accountdeposithistory for audit.

Payment Technical Reference

Models

Journal Configuration

Payment posting uses three account fields from accountjournal:

• default_account_id — the bank / cash account itself.
• payment_debit_account_id — where incoming payments park temporarily before reconciliation.
• payment_credit_account_id — where outgoing payments park pre-clearance.
• suspense_account_id — catches unmatched payments awaiting allocation.

What is a Tax?

A Tax in HMX is a reusable percentage (or fixed amount) applied to invoice lines to produce a separate tax amount and posting. A tax belongs to a Tax Group for reporting and consolidation, and it declares two things the ledger needs: which percentage rule to apply, and which accounts to post tax-collected (output VAT) and tax-paid (input VAT) amounts into.

When an invoice is confirmed, each line runs through its assigned tax(es); a Tax Distribution row tells the system how to split the computed tax amount across accounts — useful for taxes that partially hit P&L and partially a balance-sheet account.

How to Configure a Tax