Creditor Report Applet

Overview

The Creditor Report Applet gives your finance team one place to review money the company owes to suppliers. You can list unpaid supplier documents, review aging, pull supplier statements, trace historical balances, and see how payment vouchers settled purchase invoices, without moving between the purchase and payment applets. It reads the same documents those applets create; the only thing it writes is a contra between two open supplier documents.

In the product the applet is titled Creditor Report and its route root is applet/tnt/wavelet/erp/creditor-report-applet. It is the accounts-payable counterpart of the Debtor Report Applet; the Debtor and Creditor Report applet carries both sides in one menu.

Where it fits

Screens and menus

The left menu has eight reports. Each one opens a listing with an advanced-search bar (keyword plus filters), an AG Grid with export, and a drill-down that opens in the right-hand column.

View Outstanding Document (from Outstanding Document Report) has eight tabs in the order set under Settings → Default Selection → Details Tab Ordering: Details, Account (entity, bill-to, ship-to), Line Items (drill to View Item), Settlement (drill to View Settlement), Contra, Delivery Details, Department, Doc Link (Copied From / Copied To). The header PRINT button prints the document with the printable format registered for that document type (the one flagged default, otherwise the most recently updated; if none exists nothing is printed). The Contra tab lists existing contras, shows Total Contra, Doc Open Amount and Doc ARAP Balance, and offers a + button (only while the balance is not zero) that opens Contra Select Document — see Lifecycle and effects.

The Settings menu (group System Configuration) has Field Settings, Default Selection, Printable Format Settings and Aging Period Settings; the settings route also reaches the shared Webhook, Client Side Permission, Permission Wizard, Permission Set, User/Team/Role Permission and Release Notes screens. Personalization has one item, Default Selection.

All column and row-grouping choices are the standard AG Grid ones (columns panel, Drag here to set row groups, export from the status bar). The keyword box requires at least three characters; the two payment/settlement reports do not support keyword search at all (advanced search only).

Configuration

Before you can use it

• Supplier documents must be FINAL. Every query in this applet filters posting_status = 'FINAL' and an active status (EntityReportUow.generateWhereClauseForEntityReport, TransactionHistoryReportUow where-clauses). Finalise purchase invoices, GRN stock-ins, debit/credit notes and returns in their own applets first.
• Suppliers need an AP type. Rows are restricted to entities whose default AR/AP type, or whose company link, is AP_TRADE, AP_OTHER, AP_MERCHANT or AP_EMPLOYEE (every listing sends arap_types with those four values). Set it in the Entity Applet or on the company link.
• Companies and branches come from the Organisation Applet. Two reports require a choice before searching: AP Transaction Report and Payment Details with Purchase Invoice require Company; Purchase Invoice with Settlement Details requires Branch.
• Server-side read permissions for each report (see Feature visibility / permissions). For users who are not tenant admin or owner, the company dropdowns and the default company scope are limited to the companies targeted by the report’s READ permission, so assign the permission with company targets in Settings → Permission Set / User Permission.
• A .jrxml printable format of type STATEMENT_OF_ACCOUNT_TRANSACTION and/or STATEMENT_OF_ACCOUNT_AGING, flagged Default, before anyone uses Export to PDF / Preview on a statement (below).
• An aging period (optional) if you want day-range buckets instead of calendar months (below).

Applet settings

Where settings live: this applet does not use the shared FieldConfigurationComponent from blg-shared-utilities. It has its own small Field Settings screen, its own Default Selection screen, the shared Aging Period module, and a Printable Format Settings screen that also writes two settings keys. All of them are stored in one JSON object (bl_applet_ext row APPLET_SETTINGS of this applet) through the shared session effect, which merges the keys you save with the keys already stored (session.effects.ts L353–L375), so saving one screen never wipes another. The Personalization → Default Selection screen renders but does not persist anything (below).

Who can change them: anyone who can open the applet’s Settings menu. The registry holds no client-side permission definitions for this applet (0 rows in bl_applet_client_side_perm_dfn on 2026-09-05), so the menu is not gated in the UI; the save itself is a PUT on the tenant applet, and a 403 there is only logged to the browser console.

Settings → Field Settings (field-configuration.component.html; SAVE sends the whole form)

Declared but not rendered: TXN_HISTORY_SERVER_DOC_TYPE (“Include Documents Without Journal”) is still in the form model but its control is commented out; it is saved as null and read by nothing. The model file also declares INCLUDE_*, ENABLE_* and HIDE_COMPANY keys copied from the document applets; none has a control or a reader here.

Settings → Default Selection (default-settings.component.html)

Settings → Aging Period Settings (shared aging-period module; data in bl_fi_aging_period_hdr / _line)

Settings → Printable Format Settings (applet-local; .jrxml only — ADD / SAVE stay disabled until a .jrxml file is attached)

The listing shows Format Code, Format Name, File Name, File Size, Uploaded Date, Uploaded By; edit offers download and delete (delete asks for a second click within three seconds).

Personalization → Default Selection — renders User Default Settings (Default Branch, Default Location, “This will override Applet Default Settings”) but the component never loads the stored values, its SAVE emits to no listener, and choosing a value fails on an undefined container. Nothing is persisted; per-user branch defaults are not available in this applet.

Keys read at runtime that have no control in this applet (they can only be set by editing the APPLET_SETTINGS JSON directly, since settings are stored per applet):

• ENABLE_BRANCH_FILTER_PERMISSION — on Historical Transaction Aging Analysis Report switches the Branch filter from the company-permission-filtered list (select-multi-branch-comp-perm, the default) to the plain branch list. The Aging Report reads it too but has no Branch filter, so nothing changes there.
• SHOW_DOCUMENTS_WITH_ZERO_ARAP_BAL — in Contra Select Document, include documents whose balance is already zero.
• DEFAULT_TOGGLE_COLUMN (personal settings, written automatically) — remembers the single/double column layout per user.

Document behaviour settings

Not applicable — this is a report applet; the only write action (contra) has no settings.

Feature visibility / permissions

No client-side permission definitions exist for creditor_report_applet in the registry (checked 2026-09-05), so nothing in the menu or on the screens is hidden per role. Access is enforced by the backend per endpoint, and the applet asks the permission-inquiry service for these definitions at start-up (app.component.ts): API_TNT_DM_ERP_ENTITY_AR_AP_REPORT_CREDITOR_OUTSTANDING_DOCUMENT_READ, …_CREDITOR_OUTSTANDING_ENTITY_READ, …_CREDITOR_OUTSTANDING_AGING_READ, …_DEBTOR_OUTSTANDING_ENTITY_READ, API_TNT_DM_ERP_CREDITOR_TRANSATION_HISTORY_REPORT_READ, API_TNT_DM_ERP_PURCHASE_INVOICE_SETTLEMENT_DETAIL_REPORT_READ, API_TNT_DM_ERP_PAYMENT_DETAIL_PURCHASE_INVOICE_REPORT_READ, API_TNT_DM_ERP_ARAP_TRANSACTION_READ, TNT_TENANT_ADMIN, TNT_TENANT_OWNER.

“Company scope”: a user with TNT_TENANT_ADMIN or TNT_TENANT_OWNER sees all companies; anyone else gets the company dropdown, and the implicit company_guids sent when no company is chosen, limited to the bl_fi_mst_comp targets of the permission named in the last column.

Fields

There is no create/edit form; the fields are the advanced-search filters of each report, the two statement tabs and the contra picker.

Report filters (models/advanced-search-models/*.ts; ✓ = present, R = required before search)

Statement Of Account tabs (inside Entity Report Transactions)

Contra Select Document (opened from the Contra tab of View Outstanding Document)

Lifecycle and effects

What the reports read. Only bl_fi_generic_doc_hdr rows with posting_status = 'FINAL' and an active status, restricted to AP entity types (the outstanding-documents query additionally requires entity.is_supplier = TRUE), and filtered by the excluded document types (EntityOutstandingDocumentUow L101–L117, EntityStatementOfAccountUowHelper L348–L355, EntityReportUow L182–L187). Balances are the document header’s arap_doc_open, arap_contra and arap_bal (arap_bal = arap_doc_open + arap_contra); when no currency filter is set, foreign-currency documents are converted to base currency by dividing by the document exchange rate (arap_bal / base_doc_xrate, EntityReportUow.generateSqlForEntityReport; client side getBaseAmt). “As of today” reports (Outstanding Document, Aging, Statement of Account, AP Transaction) query live headers. The two historical reports read the historical-ageing snapshot (bl_fi_generic_doc_historical_ageing, joined to FINAL headers, date_txn < month end + 1), which the backend maintains as documents are finalised and recalculates when a contra is back-dated (GenericDocumentArapContraService L387–L390). Nothing in this applet posts a journal or changes a document status.

Contra — the one write path. View Outstanding Document → Contra → + → Contra Select Document → ADD creates a contra between the open document and each selected document.

Related applets

• Debtor Report Applet — the receivable twin (same screens, AR_* types, plus a salesman collection report).
• Debtor and Creditor Report — a separate applet that carries both sides in one menu; same backend endpoints.
• Payment Voucher (Internal) — creates the settlements shown in the Settlement tab and the two payment reports.
• Purchase Invoice No Stock In, Purchase GRN Stock In, Purchase Debit Note, Purchase Credit Note, Purchase Return — the documents that carry supplier balances.
• Purchase Order, Purchase GRN — linked through the PO No / GRN No columns.
• Entity Applet — supplier master and AR/AP type; Organisation Applet — companies and branches.
• Financial Report, Ledger And Journal — the GL side to reconcile against.
• Purchase Report — purchase analysis by document and item.

Troubleshooting

Related documentation

• Reports & Analytics — where this applet sits among the finance reports.
• Financial Accounting module and Purchasing module.
• Debtor Report Applet and Debtor and Creditor Report — the sibling reference pages.