Consignment Purchase Order Applet (Internal)

Overview

The Consignment Purchase Order Applet (Internal) records your request to a consignor (a supplier who keeps ownership of the goods) to place stock with you: which items, how many, at what reference price, delivered where and when. Buyers create it by hand, by knocking off a blanket purchase order, purchase quotation or purchase requisition, or from a CSV; the warehouse later receives against it with a Consignment GRN, and the consignor is settled through Consignor Purchase Billing.

Its engine document type is INTERNAL_PURCHASE_CONSIGNMENT_ORDER with amount signum 0 and quantity signum 0: finalising it posts nothing to the General Ledger, to stock or to the supplier’s account. What FINAL does is lock the document and — if the company’s knock-off configuration says so — put its lines into the open queue where the Consignment GRN finds them.

The window title is Internal Consignment Purchase Order Applet; the listing is Consignment Purchase Order Listing.

Where it fits

Screens and menus

There are no HIDE_…_MENU settings in this applet: menu-items.ts has three fixed entries and app.component.ts does not call updateMenuItem. Feature Visibility (shared) is the only way to hide a menu per team.

Listing

Toolbar: Printable Format picker + PRINT (disabled until a format is chosen), FINAL, DISCARD, VOID, Email Template + Recipient Email + SEND EMAIL. Bulk FINAL keeps only rows whose posting_status is not FINAL and whose status is ACTIVE; bulk VOID keeps only FINAL + ACTIVE rows; other selected rows are silently skipped. The default date window is the last month, or today only when ENABLE_FILTER_BY_TODAYS_TXN is stored. Column state is saved per user.

Create screen

Buttons RESET and CREATE (enabled only when Main Details is valid, the supplier is valid and at least one line exists — disableCreate()). Tabs, in fixed order: Main Details, Account (Entity Details / Bill To / Ship To), Lines, Delivery Details (HIDE_DELIVERY_DETAILS_TAB), Payment (HIDE_MAIN_PAYMENT_TAB), KO For (HIDE_KO_FOR_TAB), Department Hdr (HIDE_DEPARTMENT_HDR_TAB). Leaving with unsaved changes opens Do You Wish To Save Your Changes?.

Edit screen

Header buttons: RESET, FINAL (draft + ACTIVE only; hidden by HIDE_GENDOC_FINAL_BUTTON unless the user holds SHOW_GENDOC_FINAL_BUTTON; disabled while any line has an invalid serial number), DISCARD (same conditions with the DISCARD pair), UPDATE (needs the server-side UPDATE permission, or tenant admin / owner). The VOID button on the edit pane is commented out in the template — VOID is a listing action only. A red DELETE button (two clicks to confirm, draft only) appears when SHOW_DOCUMENT_DELETE_BUTTON is stored in the applet settings; it hard-deletes the document through the API.

Tabs, in the order saved under Default Selection → Details Tab Ordering (CONSIGNMENT_PURCHASE_ORDER_DETAILS_TAB_ORDER, added under intranet #1093): Main Details, Account, Lines, KO For, ARAP, Delivery Details, Payment, Department Hdr, TraceDocument, Contra, Doc Link, Attachments, Export. With VERTICAL_ORIENTATION the tabs become expansion panels and the EXPAND_* keys choose which open by default.

File Import

File Import → + uploads a .csv (File type not supported otherwise). Sample Format for Consignment Purchase Order downloads MasterData_Upload_ConsignmentPurchaseOrder.csv; the only column the applet names in code is REQUESTED_DELIVERY_DATE, the rest come from the sample. Import rows show File Name, File Size, Import Format, File Type, Status, Process Status and Error Message.

Configuration

Before you can use it

Applet settings

Where settings live (read from app.routing.ts at commit 1447f23): the Application Settings route loads the shared FieldConfigurationComponent from blg-shared-utilities, so the toggles you see are the shared screen’s, not this applet’s. The applet-local field-configuration component (one toggle, Last Purchase Price, plus eight unbound sliders) is not routed and never renders. Default Selection and Personalization → Default Selection are applet-local. There is no per-screen settings gear and no Branch Settings menu.

Anyone with the applet’s Settings menu can change them; there is no per-row authority difference. Every toggle defaults to off (nothing is stored until the first Save; the shared screen has no per-applet pre-selection for this applet code, so a fresh tenant sees every field and tab). One more consequence of sharing the screen: its tab-hide and KO For sections render only for applet codes listed in its getTabValue() map (internalPurchaseOrderApplet, internalconsignmentGRNApplet, …). internalConsignmentPurchaseOrderApplet is not in the map, so the tab-hide toggles this applet reads have no control on a live tenant (listed below).

Settings → Default Selection (applet-local; Save writes all keys, Reset nulls them)

Personalization → Default Selection (per user): DEFAULT_BRANCH, DEFAULT_LOCATION (auto-filled from the branch’s MAIN_LOCATION), DEFAULT_TOGGLE_COLUMN (single / double column) and DEFAULT_ORIENTATION (tabs vs panels).

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

PRINTABLE (the default printable format) is not a toggle: it is written by Printable Format Settings → set as default and read by the listing, the Export tab and the auto pop-up.

Rendered on the shared screen but read nowhere in this applet (switching them does nothing): HIDE_ACCOUNT_BILLING_CONTACT, HIDE_ACCOUNT_SHIPPING_CONTACT, HIDE_LINE_ITEMS_GL_CODE, EXPAND_SETTLEMENT, EXPAND_POSTING, EXPAND_DELIVERY_TRIPS.

Read at runtime without a control on any settings screen for this applet code (they take effect only if the key is already stored in the applet’s settings JSON, e.g. by support): the tab-hide keys HIDE_KO_FOR_TAB, HIDE_DELIVERY_DETAILS_TAB, HIDE_MAIN_PAYMENT_TAB, HIDE_PAYMENT_TAB, HIDE_DEPARTMENT_HDR_TAB, HIDE_MAIN_ARAP_TAB, HIDE_ARAP_TAB, HIDE_TRACE_DOCUMENT_TAB, HIDE_MAIN_CONTRA_TAB, HIDE_CONTRA_TAB, HIDE_DOC_LINK_TAB, HIDE_EXPORT_TAB (each hides the named tab on create / edit; the HIDE_MAIN_* / plain pairs are equivalent on the edit pane) and ENABLE_MULTIPLE_KO (one line may knock off several source lines) — their controls sit in shared-screen sections gated by getTabValue() / appletCode === 'internalPurchaseOrderApplet'; ENABLE_SERIAL_NUMBER_VALIDATION_FINAL (sends validate_serial_signum_zero = true with FINAL so the backend checks serial and batch quantities despite the 0 quantity signum) — rendered only for the delivery-order codes; ENABLE_FILTER_BY_TODAYS_TXN (listing date window = today); DEFAULT_CUST_TYPE, DEFAULT_COUNTRY, DEFAULT_CURRENCY (inline supplier creation).

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); VALIDITY_DATE_REQUIRED; DEFAULT_PRICING_SCHEME. Custom statuses and department-tag enforcement are therefore not configurable here.

Document behaviour settings

Settings in other applets that control this applet

Feature visibility / permissions

Server-side (TntErpPermissions): TNT_API_DOC_INTERNAL_PURCHASE_CONSIGNMENT_ORDER_CREATE_TGT_GUID, …_UPDATE_TGT_GUID, …_READ_TGT_GUID, …_DELETE_TGT_GUID. The edit pane enables UPDATE for the UPDATE permission or for TNT_TENANT_ADMIN / TNT_TENANT_OWNER; the Line Items menu checks READ.

Client-side: the registry has no bl_applet_client_side_perm_dfn rows for internalConsignmentPurchaseOrderApplet (checked 2026-09-05), so none of the codes below can be granted through Client Side Permission until they are seeded. Codes the code checks:

PURCHASE_ORDER_DISPLAY_PRICING matters most: the line grid hides price and amount columns for every user who is not tenant OWNER or ADMIN and does not hold it (ClientSidePermissionChecker.checkPermission). With no seeded definition, ordinary buyers cannot see prices.

Fields

Main Details

Account

Lines

Delivery Details, Payment, Department Hdr, Contra

Lifecycle and posting

On FINAL the applet sends posting_status = FINAL (plus validate_serial_signum_zero when enabled). The backend (GenericDocumentService.updatePostingStatus) runs validateGenericDocumentOnFinal: non-zero forex rate; serial, bin and batch quantity checks (serial / batch only for signum-0 types when the flag is sent); the stock-balance check is skipped for a signum-0 line (validateStockBalanceForSignumZero = false); and the fiscal-period lock (FISCAL_PERIOD_LOCKED). It then saves, assigns running numbers, queues the generic-document primary processor and the message-template processor, and for a foreign-currency document creates a base-currency shadow first. The GenericDocLineOpenQueueProcessor reads the company’s flow configuration for server_doc_type_1 = INTERNAL_PURCHASE_CONSIGNMENT_ORDER (config_type = KO, is_enabled) and, for each enabled target type, inserts one bl_fi_generic_doc_line_open_queue row per ACTIVE PNS line with qty_open = line quantity, then sets posting_ko = POSTED. KnockOffWatchdogService re-queues FINAL documents whose posting_ko is still null, and line-open-queues/data-fix-missing-queue is the manual repair endpoint.

Posting proof (backend at 871dbf5): server document type INTERNAL_PURCHASE_CONSIGNMENT_ORDER · amount signum 0 · quantity signum 0 (InternalPurchaseConsignmentOrderDataConsistencyObject, registered in GenericDocumentTypeHandler L776) · Dr/Cr equation: none — the type has no JournalPostingTypeHandler entry, so no journal, ARAP or tax transactions are produced · GL precedence: not applicable · stock processor: none · VOID reverses nothing in the ledgers; VoidKnockOffProcessor marks the document’s open-queue rows DELETED so the Consignment GRN can no longer knock it off (a VOID after a GRN has already knocked the line off does not touch the GRN).

Knock-off by the Consignment GRN: its KO tab queries open-queue rows with line_open_queue_server_doc_type_1 = INTERNAL_PURCHASE_CONSIGNMENT_ORDER and …_2 = INTERNAL_PURCHASE_CONSIGNMENT_GRN, copies qty_open into the GRN line’s quantity_base, and writes a bl_fi_generic_doc_link with quantity_contra = qty_open; GenericDocLinkService then reduces qty_open. Deleting the GRN link restores the open quantity.

Related applets

• Consignment GRN Applet (Internal) — receives consigned stock against this order (the only knock-off consumer).
• Consignment GIN Applet (Internal), Consignment Return Applet (Internal) — consumption and return of the consigned stock, from the GRN onward.
• Consignor Purchase Billing Applet (Internal), Consignment Billing Applet (Internal) — settlement with the consignor; where payments belong.
• Consignee Stock Transfer — moving consigned stock between locations.
• Purchase Order (Internal) — the ordinary purchase order; same screens, different downstream.
• Blanket Purchase Order, Purchase Quotation (Internal), Purchase Requisition (Internal) — KO For sources.
• Supplier, Organisation, Doc Item Maintenance, Tax Configuration, Forex — master data.

Troubleshooting

Related documentation

• Purchasing module and its use cases
• Consignment purchasing guide
• Sibling reference: Purchase Order (Internal)