Goods Delivery Note (Internal)

Overview

The Goods Delivery Note (Internal) is the document you raise when goods are handed to a customer against a sales order, a jobsheet or an outbound delivery order. It carries the customer, the delivery address, the sales agent and the itemised lines, and it knocks off the open lines of the upstream document so that the order shows what has been delivered. It is a non-posting document: FINAL neither moves stock nor writes to the general ledger (both signums are fixed at 0 in the backend — see Lifecycle and effects). Stock leaves the location through the stock-out document you use alongside it (delivery order stock-out or sales GIN).

The applet was cloned from the Sales Credit Note applet. That is why the create/edit screens still carry a Settlement tab and a Contra tab, why the header model is named ISCNMain and why the success toast after Create reads Sales CreditNote created successfully. These are cosmetic leftovers; the document type sent to the server is always INTERNAL_GOODS_DELIVERY_NOTE.

Where it fits

Module: Inventory.

Screens and menus

Left menu

• Internal Goods Delivery Note — the document listing. Columns: Goods DeliveryNote No, Posting Status, Status, Branch, Customer Name, Sales Agent, Created Date, Created by. The listing has a + button (create), a column toggle, and a FINAL button that finalises every selected row that is not yet FINAL (bulk FINAL).
• Line Items — a cross-document listing of delivery-note lines (Goods DeliveryNote No, Item Code, Item Name, Qty, Unit Price, SST/VAT/GST, Txn Amount) with a line editor.

Create screen — buttons RESET and CREATE (CREATE is disabled while the Main Details form or the Account > Entity Details form is invalid). Tabs: Main Details, Account (sub-tabs Entity Details, Bill To, Ship To), Lines, Settlement, Department Hdr, Contra.

Edit screen — buttons RESET, FINAL, SAVE. Tabs as on the create screen plus Attachments and Export. A DELETE button (two-click confirm) appears below the tabs only when the setting SHOW_DOCUMENT_DELETE_BUTTON is on and the document is not FINAL.

Adding a line — the line picker opens with tabs Search Item, KO By Sales Order Item, KO For Sales Order Item, KO By Jobsheet Item, KO For Jobsheet Item, KO By Delivery Order Item, KO For Delivery Order Item, Copy Quotation Item. The item form then shows Main Details, Delivery Instruction, Department, Costing Details (hideable), Pricing Details and Issue Link, plus a Serial Number, Batch Number or Bin Number tab depending on the item’s sub-type.

Settings menu (System Configuration): Application Settings, Default Selection, Printable Format Settings. The routes also expose Webhook, Feature Visibility, Client-Side Permission, Permission Set, User / Team / Role Permission screens from the shared library; the settings landing page redirects to Feature Visibility.

Personalization menu: Default Selection, Sidebar.

No screenshots are available for this applet yet (the previous page had none either).

Configuration

Before you can use it

• Company, branch and location in the Organisation applet. Branch, Location and Company are required on the Main tab; selecting a branch fills the company.
• Knock-off configuration on the company (Organisation → Company → Knock Off Configuration, table bl_fi_comp_gendoc_flow_config). The KO For tabs only list lines that the upstream document’s FINAL placed in the open-line queue; without an enabled source → INTERNAL_GOODS_DELIVERY_NOTE row there is nothing to knock off.
• Customers in Customer Maintenance — Entity Id is required on the Account tab; the customer’s credit terms feed the Credit Terms drop-down.
• Employees in the Employee applet — the Sales Agent field is required by the form.
• Member cards in Membership Admin — the Member Card field is declared required by the form (see Troubleshooting).
• Items in Doc Item Maintenance; serial / batch / bin sub-types drive the extra line tabs. Tax codes for the line SST/GST/VAT and WHT selectors come from Tax Configuration.
• Permissions — the backend checks the targeted permissions TNT_API_DOC_INTERNAL_GOODS_DELIVERY_NOTE_CREATE_TGT_GUID, …_UPDATE_TGT_GUID, …_READ_TGT_GUID and …_DELETE_TGT_GUID (TntErpPermissions L5683-5689), assigned through the Permission Set / User / Team / Role screens under Settings.
• A printable format uploaded under Settings → Printable Format Settings for transaction type INTERNAL_GOODS_DELIVERY_NOTE, if you want to print or export the note.

Applet settings

Settings live in three places. Anyone with access to the applet’s Settings menu can change them; there is no per-setting authority.

1. Application Settings is the shared FieldConfigurationComponent from blg-shared-utilities (route settings/field-settings). The screen is keyed by sessionStorage.appletCode, which the platform shell sets to the registry code InternalGoodsDeliveryNote. That code has no entry in the screen’s tab map (getTabValue(), field-configuration.component.ts L2386-2426), so the ten tab-hide toggles that depend on it (HIDE_KO_FOR_TAB, ENABLE_MULTIPLE_KO, HIDE_MAIN_PAYMENT_TAB, ENABLE_EDIT_PAYMENT_DATE, HIDE_DELIVERY_DETAILS_TAB, HIDE_DEPARTMENT_HDR_TAB, HIDE_MAIN_ARAP_TAB, HIDE_TRACE_DOCUMENT_TAB, HIDE_DOC_LINK_TAB, HIDE_EXPORT_TAB) never render for this applet. What remains is 138 toggles and inputs, saved as one JSON under the applet’s APPLET_SETTINGS extension when you press Save.
2. Default Selection (applet-local, and the same screen again under Personalization) shows Default Branch and Default Location. It is not functional: the component never loads the current settings (no subscription to appletSettings$), its save output has no listener on the route, and no form in the applet reads DEFAULT_BRANCH / DEFAULT_LOCATION. Changing a value throws in the browser console because the applet container is undefined. Leave it alone.
3. Printable Format Settings (applet-local) lists the formats uploaded for INTERNAL_GOODS_DELIVERY_NOTE and lets you mark one as default; that writes PRINTABLE into APPLET_SETTINGS.

Of the 138 controls rendered on Application Settings, 22 are read by this applet’s code (declared in applet-settings.model.ts, rendered, persisted, consumed). They are all line-level:

Every HIDE_* row is evaluated in the template as !appletSettings.HIDE_X || SHOW_X, where SHOW_X is the client-side permission of the same name — a tenant-wide hide can be reopened per role (all 22 SHOW_* codes are seeded for this applet, see Feature visibility).

Read at runtime without a model declaration

• SHOW_DOCUMENT_DELETE_BUTTON — rendered on Application Settings (section Doc Settings), saved with the rest, and read by the edit screen straight from the applet extension (goods-delivery-note-edit.component.ts L97-109). On: the DELETE button appears on non-FINAL documents. Off / unset: no delete from the UI.

Rendered and saved, but read by nothing in this applet — the remaining ~116 controls on Application Settings: the listing group (HIDE_GENDOC_FINAL_BUTTON, HIDE_GENDOC_VOID_BUTTON, DEFAULT_TRANSACTION_DATE, SORT_ORDER, DEFAULT_POSTING_STATUS, SHOW_DRAFT_BUTTON …), the header field hides (HIDE_TRACKING_ID, HIDE_PERMIT_NO, HIDE_REFERENCE, HIDE_REMARKS, HIDE_CREDIT_TERMS, HIDE_LOCATION, HIDE_CURRENCY …), the Vertical UI, External Documents, Entity Details, Billing / Shipping, Department, Contra and Email groups, ENABLE_AUTO_POPUP, ENABLE_PRINT_FINAL_GEN_DOC_ONLY, the line-item sub-tab hides (HIDE_DELIVERY_INSTRUCTION, HIDE_DEPARTMENT, HIDE_DOC_LINK, HIDE_DELIVERY_DETAILS, HIDE_ATTACHMENT_TAB, HIDE_BIN_NUMBER, HIDE_BATCH_NUMBER, HIDE_ISSUE_LINK), DISALLOW_LINE_ITEM_EDIT, SHOW_FOREX_DATA_SOURCE / CANNOT_EDIT_CURRENCY_RATE, and the HIDE_ARAP_* / HIDE_KO_* toggles. Switching any of them changes nothing on this applet’s screens. The applet’s app.component.ts does not implement HIDE_*_MENU either.

Document behaviour settings

• Status flow — not configurable. The only transition offered is to FINAL (edit screen button, or the listing’s bulk FINAL). No workflow / FINAL_STATUS_GUID is read.
• Posting — not configurable and, for this document type, absent: see Lifecycle and effects.
• Printables — Settings → Printable Format Settings uploads Jasper formats with txn_type = INTERNAL_GOODS_DELIVERY_NOTE and stores the default in PRINTABLE. The Export tab prints through the shared Jasper endpoint with service code CP_COMMERCE_INTERNAL_SALES_ORDERS_JASPER_PRINT_SERVICE (effects L294-297) and downloads <document no>.pdf.
• Approval / e-Invoice — no controls found (routes and settings components checked at commit 0f242a9 of the applet repository, af523eb of blg-shared-utilities).

Settings in other applets that control this applet

Feature visibility / permissions

bl_applet_client_side_perm_dfn holds 22 ACTIVE client-side permission codes for this applet (all CLIENT_SIDE_PERM): SHOW_AMOUNT_NET_EXCL_TAX, SHOW_AMOUNT_STD_EXCL_TAX, SHOW_AMOUNT_TXN, SHOW_COSTING_DETAILS, SHOW_DISCOUNT_AMOUNT_EXCL_TAX, SHOW_LAST_PURCHASE_PRICE, SHOW_QTY_BASE, SHOW_QTY_UOM, SHOW_TAX_CONFIG_SELECTION, SHOW_UNIT_DISCOUNT, SHOW_UNIT_DISCOUNT_UOM_EXCL_TAX, SHOW_UNIT_PRICE_NET_EXCL_TAX, SHOW_UNIT_PRICE_NET_UOM_EXCL_TAX, SHOW_UNIT_PRICE_STD_EXCL_TAX, SHOW_UNIT_PRICE_STD_INCL_TAX, SHOW_UNIT_PRICE_STD_PRICING_SCHEME, SHOW_UNIT_PRICE_STD_UOM_EXCL_TAX, SHOW_UNIT_PRICE_STD_UOM_INCL_TAX, SHOW_UNIT_PRICE_TXN, SHOW_UNIT_PRICE_TXN_UOM_INCL_TAX, SHOW_UOM_TO_BASE_RATIO, SHOW_WHT_CONFIG_SELECTION.

• 21 of them re-enable the line field hidden by the HIDE_* setting of the same suffix for the roles that hold them; SHOW_COSTING_DETAILS re-enables the Costing Details tab.
• SHOW_LAST_PURCHASE_PRICE is seeded but nothing in this applet checks it (the field it would reopen is not on the line form).
• The delete button is governed by the setting SHOW_DOCUMENT_DELETE_BUTTON, not by a permission; no SHOW_VOID_BUTTON / SHOW_TRANSACTION_DATE codes exist for this applet.
• The Feature Visibility screen under Settings is the shared menu-hiding component; the applet has only two menu items (listing, Line Items).
• Backend (targeted) permissions: TNT_API_DOC_INTERNAL_GOODS_DELIVERY_NOTE_{CREATE,UPDATE,READ,DELETE}_TGT_GUID, granted through Permission Set / User / Team / Role Permission. Without READ the listing is empty; without CREATE the POST is refused.

Fields

Main Details

Account

Lines (line Main Details)

Settlement, Department Hdr, Contra

• Settlement — inherited from the credit-note clone. Add Settlement asks, per settlement method type, for Date and Amount (all types), Cash Back, Card No / Name on Card / Card Issuer / Type / Card Expiry / CVV, Voucher #, Transaction No, points; the starred ones are required by the form. Nothing on the backend side turns these into receipts for this document type.
• Department Hdr — Segment, G/L Dimension, Profit Centre, Project (all optional; stored on the header).
• Contra — select another document to contra against. Inherited; no ARAP balance exists for a signum-0 document, so there is nothing to contra.

Lifecycle and effects

Statuses. A new note is created without a posting status (the header’s posting_status is null until you press FINAL; the advanced search offers DRAFT / FINAL / VOID as filter values). Transitions available in the applet:

• Create / Save — POST / PUT …/internal-goods-delivery-notes through the generic document API; the backend’s InternalGoodsDeliveryNoteDataConsistencyObject checks the server document type and forces amount signum 0 and quantity signum 0 on every line.
• FINAL — the edit screen’s FINAL button (refused client-side with This document has been posted if already FINAL) or the listing’s bulk FINAL. Both send {posting_status: 'FINAL'} to the posting-status endpoint. Backend rejections: HTTP 403 Generic Document has already been posted to FINAL (GenericDocumentService L361-364); FISCAL_PERIOD_LOCKED — The selected date falls within a locked fiscal period — when the transaction date sits in a period locked LOCK_ALL or LOCK_TXN (L1681-1695). Serial and batch quantity checks are skipped for signum-0 lines unless the caller sends validate_serial_signum_zero (this applet does not; L1839-1845), the bin check runs only for lines that carry bin numbers, and the stock-balance check ignores signum-0 lines (L2088-2092). The blacklisted-customer check applies to cashbill / invoice / order / outbound DO only, not to this type (L1650-1655).
• After FINAL — the Main tab controls are disabled in the UI (main-details.component.ts L97-117); RESET is refused; the SAVE button stays enabled (disableSave() is empty).
• VOID — no VOID control exists in this applet (edit and listing screens checked). The backend’s generic updatePostingStatusToVoid would have nothing to reverse for this type.
• DELETE — with SHOW_DOCUMENT_DELETE_BUTTON on and the document not FINAL, DELETE (click twice within 3 seconds) calls DELETE …/internal-goods-delivery-notes/{guid}. The controller checks the delete permission, removes attached files and deletes header, lines, extensions and events (GenericDocumentController.executeDocumentDeletionTransaction), then fires the INTERNAL_GOODS_DELIVERY_NOTE_DELETED webhook. The FINAL guard is client-side only; the deletion transaction has none.

Posting proof block

Why the journal queue shows an error for every FINAL note. In akaun_master.bl_applet_trigger_template_processor_link the subscriber JOURNAL_POSTING_JOB_PROCESSOR of BLG_ERP_GENERIC_DOCUMENT_PRIMARY_PROCESSOR carries no serverDocTypes constraint, so it is queued for every FINAL document regardless of type (only five customer-specific sales-order subscribers are constrained). For a Goods Delivery Note the job then fails with NO_JOURNAL_CREATED (or earlier with COMPANY_DEFAULT_GL_CODE_NOT_EXIST when the company has no default GL mapping). The failure is confined to the job queue: the document is already FINAL, and the missing journal is correct. A company can silence it by listing JOURNAL_POSTING_JOB_PROCESSOR in posting_final_json.excludeJobProcessorCode — at the cost of every other document type, so in practice the failed job is left alone.

Related applets

• Sales Order (Internal) — the usual source; its open lines are consumed by KO For Sales Order Item.
• Jobsheet (Internal) — alternative source through KO For Jobsheet Item.
• Outbound Delivery Order (Internal) — alternative source through KO For Delivery Order Item.
• Delivery Order (Internal) and Sales GIN (Stock Out) — the documents that actually move the stock a delivery note describes.
• Customer Maintenance — customer, credit terms, billing and shipping addresses.
• Employee — sales agent.
• Membership Admin — member card.
• Doc Item Maintenance — items, sub-types (serial / batch / bin), pricing schemes.
• Organisation — company, branch, location, Knock Off Configuration.
• Warehouse Management — locations and bins referenced on the lines.
• Tax Configuration — SST/GST/VAT and WHT codes on the lines.

Troubleshooting

The applet repository’s own issues (#1 deployment-script clean-up, #3 import errors after the monorepo split, #5 Angular 14 migration) are engineering chores; none reports a functional defect. The wiki tracker holds the documentation requests #69 (this page) and #70 (the former dispatch-note page).

Related documentation

• Inventory module
• Standard sales workflow and Partial delivery workflow — where delivery documents sit in the sales flow (these guides do not yet cover the Goods Delivery Note itself).
• Sales Order (Internal), Outbound Delivery Order (Internal), Sales GIN (Stock Out)