Consignment Return Applet (Internal)

Overview

The Consignment Return Applet (Internal) records consigned goods going back to the consignor and reverses the value that the Consignment GRN put on the books. Warehouse or procurement staff create it — by hand, by pulling lines from a purchase invoice on the Search tab, or by knocking off a purchase document on KO For — and finance closes its balance by contra against the consignor’s documents or by a settlement.

Its engine document type is INTERNAL_PURCHASE_CONSIGNMENT_RETURN with amount signum +1 and quantity signum 0. FINAL posts Dr Consignment Liability / Cr Consignment Stock (the mirror of the GRN’s entry) and leaves an ARAP balance on the consignor; it does not move stock. The backend overwrites the applet’s own quantity signum (the applet constant says −1) with 0 on every line, and the type is not in the moving-average cost list, so warehouse quantities and MA cost are untouched by a consignment return.

The window title is Internal Consignment Return Applet; the listing is Internal Consignment Return Listing; the document short code is CSGRTN.

Where it fits

Screens and menus

No HIDE_…_MENU settings, no File Import, no Email Template and no Workflow Settings exist in this applet (menu-items.ts, app.routing.ts at 16378cc).

Listing

Toolbar: FINAL (hidden by HIDE_FINAL_BUTTON unless the user holds SHOW_FINAL_BUTTON) and VOID (hidden by HIDE_GENDOC_VOID_BUTTON). There is no PRINT, DISCARD or SEND EMAIL button on the listing. Bulk FINAL and VOID act on the ticked rows. Columns include Doc Short Code, Doc No (Tenant / Company / Branch), Posting Status and Branch; the default date window is the last month, or today only when ENABLE_FILTER_BY_TODAYS_TXN is stored.

Create screen

Buttons RESET and CREATE (disableCreate(): Main Details valid, supplier valid, at least one line). Tabs: Search (Search By Invoice / By Supplier / By Serial Number — purchase-invoice lines), Main Details, Account (Entity Details / Bill To / Ship To), Lines, Delivery Details, Settlement, KO For, Department Hdr, Contra.

Edit screen

Header buttons: RESET, FINAL (always rendered; the backend refuses an already-FINAL document with Generic Document has already been posted to FINAL), SAVE (disableSave() mirrors disableCreate(); also needs the server-side UPDATE permission or tenant admin / owner). The VOID button on the edit pane is commented out — VOID is a listing action. A red DELETE button (draft only) appears when SHOW_DOCUMENT_DELETE_BUTTON is stored in the applet settings.

Tabs in fixed order (this applet has no Details Tab Ordering): Main Details, Account, Lines, ARAP, Delivery Details, Settlement, Department Hdr, Trace Document (Journal Txn / Cashbook Txn / Points Txn / Tax Txn / Inv Txn), Contra, Doc Link (Copy From / Copy To), Export, Attachments.

Configuration

Before you can use it

Applet settings

Where settings live (app.routing.ts at 16378cc): Application Settings loads the shared FieldConfigurationComponent from blg-shared-utilities; the applet-local field-configuration component in settings-container/ is not routed. Default Selection and Personalization → Default Selection are applet-local. No per-screen gear, no branch settings.

Anyone with the applet’s Settings menu can change them. Every toggle defaults to off (nothing stored until the first Save; no per-applet pre-selection on the shared screen for this code).

Settings → Default Selection: DEFAULT_BRANCH, DEFAULT_LOCATION (derives DEFAULT_COMPANY) — pre-selected on a new return; a personal default overrides. Nothing else (no validity days, no tab ordering, no pricing scheme).

Personalization → Default Selection: DEFAULT_BRANCH, DEFAULT_LOCATION per user.

Settings → Application Settings (shared screen). Keys rendered there and read by this applet (45):

PRINTABLE (default printable format) is written by Printable Format Settings → set as default and read by the Export tab.

Rendered on the shared screen but read nowhere in this applet: HIDE_TRACKING_ID, HIDE_PERMIT_NO, HIDE_LAST_PURCHASE_PRICE. The VERTICAL_ORIENTATION / EXPAND_*, HIDE_GENDOC_FINAL_BUTTON, HIDE_GENDOC_DISCARD_BUTTON, ENABLE_AUTO_POPUP and REQUIRE_VALIDITY_DATE toggles shown on the shared screen are not in this applet’s model and have no effect here; the shared screen’s tab-hide section does not render at all for internalConsignmentReturnApplet (not in its getTabValue() map), and DISABLE_LINE_ITEM_QUEUE_LISTING — declared in the model — has a control only for the requisition applet and is read nowhere here.

Read at runtime without a control: ENABLE_FILTER_BY_TODAYS_TXN (listing window = today).

Declared in applet-settings.model.ts only — no control, not read: INCLUDE_* / ENABLE_* for SST, WHT, Segment, Dimension, Profit Center, Project; ENABLE_CUSTOM_STATUS_* (15 keys).

Document behaviour settings

Settings in other applets that control this applet

Feature visibility / permissions

Server-side (TntErpPermissions): TNT_API_DOC_INTERNAL_PURCHASE_CONSIGNMENT_RETURN_CREATE_TGT_GUID, …_UPDATE_TGT_GUID, …_READ_TGT_GUID, …_DELETE_TGT_GUID. SAVE on the edit pane needs UPDATE or TNT_TENANT_ADMIN / TNT_TENANT_OWNER; Line Items needs READ.

Client-side: the registry has no bl_applet_client_side_perm_dfn rows for internalConsignmentReturnApplet (checked 2026-09-05). Codes the code checks, none grantable until seeded:

Price columns are hidden for every user who is not tenant OWNER or ADMIN and lacks the display-pricing code (ClientSidePermissionChecker.checkPermission).

Fields

Main Details

Account

Lines

Settlement, Contra, Department Hdr

Lifecycle and posting

There is no DISCARD in this applet.

On FINAL the backend (GenericDocumentService.updatePostingStatus → validateGenericDocumentOnFinal) checks the forex rate, bin quantities and the fiscal-period lock (serial / batch checks are skipped because the applet does not send validate_serial_signum_zero; the stock-balance check does not apply to signum-0 lines), saves, assigns running numbers, creates a base-currency shadow for a foreign-currency return, and queues the primary processor, which writes the journal and the ARAP record.

Posting proof (backend at 871dbf5): server document type INTERNAL_PURCHASE_CONSIGNMENT_RETURN · amount signum +1 · quantity signum 0 (InternalPurchaseConsignmentReturnDataConsistencyObject L16–17; fillQuantitySignumAndAmountSignumForLine overwrites whatever the applet sent) · journal handler: no entry of its own — JournalPostingService L65–74 maps INTERNAL_PURCHASE_CONSIGNMENT_GRN and …_RETURN to the PURCHASE_CONSIGNMENT handler (JournalPostingTypeHandler L95–103) and marks the document isConsignmentStockIn · Dr/Cr per line:

· GL precedence: company default only for consignment types (the usual line → header → item-company → company chain is bypassed) · stock processor: none — quantity signum 0 and the type is not in StockBalanceHelper.MA_WA_SERVER_DOC_TYPES · what VOID reverses: the journal and the ARAP balance; nothing in stock.

Related applets

• Consignment GRN Applet (Internal) — the document whose value this one reverses; contra target.
• Consignment GIN Applet (Internal) — consumption of consigned stock (the stock-moving counterpart, quantity signum −1).
• Consignment Purchase Order Applet (Internal) — start of the consignment flow.
• Consignor Purchase Billing Applet (Internal), Consignment Billing Applet (Internal) — settlement with the consignor.
• Purchase Return (Internal) — the ordinary return this applet is forked from; it does move stock.
• Purchase Invoice (Internal), Purchase GRN (Internal), Purchase Order (Internal), Purchase Requisition (Internal), Supplier Delivery Order — Search and KO For sources.
• Payment Voucher (Internal) — settlement of the balance.
• Chart of Account, Supplier, Organisation, Doc Item Maintenance, Tax Configuration — master data.

Troubleshooting

Related documentation

• Purchasing module and Inventory module
• Consignment purchasing guide
• Sibling reference: Purchase Return (Internal)