Consignment Return Applet (Internal)

Records consigned goods going back to the consignor and reverses the value the Consignment GRN put on the books: FINAL posts the mirror of the GRN’s entry — consignment liability against consignment stock — and leaves a balance on the consignor that finance closes by contra or settlement. It does not move stock: warehouse quantities and moving-average cost are untouched, so the physical movement needs its own document. The accounts come only from the company’s default GL codes; an unmapped one either fails the journal after FINAL or, worse, posts it short with no error.

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.

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 (enabled when Main Details is valid, the supplier is valid and there is 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 (same conditions as CREATE; 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: Application Settings is the shared Field Configuration screen; Default Selection and Personalization → Default Selection are this applet’s own. 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.

Shown on the shared screen but with no effect in this applet: HIDE_TRACKING_ID, HIDE_PERMIT_NO, HIDE_LAST_PURCHASE_PRICE, the VERTICAL_ORIENTATION / EXPAND_* toggles, HIDE_GENDOC_FINAL_BUTTON, HIDE_GENDOC_DISCARD_BUTTON, ENABLE_AUTO_POPUP and REQUIRE_VALIDITY_DATE; the shared screen’s tab-hide section does not appear at all for this applet, and the disable line item queue listing toggle has no effect here.

Read without a control on any screen: ENABLE_FILTER_BY_TODAYS_TXN (listing window = today).

Listed in the applet’s settings but with neither a control nor an effect: INCLUDE_* / ENABLE_* for SST, WHT, Segment, Dimension, Profit Center, Project; ENABLE_CUSTOM_STATUS_*.

Document behaviour settings

Settings in other applets that control this applet

Feature visibility / permissions

Server-side: 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: none of the codes this applet checks are in its permission list yet, so none can be granted until they are created under Settings → Client Side Permission:

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

Fields

Main Details

The create screen asks for Branch, Location, Purchaser, Transaction Date, Credit Terms, Reference, Remarks, Permit No, Currency and Tracking ID, and, unless they are hidden, Delivery Branch and Delivery Location. There is no Company box: the company is the one the chosen branch belongs to, or the default company from Default Selection if you keep the default branch. Credit Terms offers only the terms held on the chosen consignor’s record, so its list is empty until you choose a consignor that has some; choosing the consignor, or choosing it again, empties it. Permit No and Tracking ID are free text saved with the return. There is no Description box either: the listing’s Description column is the consignor’s own description, copied in when you choose the consignor.

The edit screen adds Doc Short Code (always CSGRTN), the three Doc No boxes, filled when the return is finalised, and Client Document type and Client Doc 1–5 No. All of these are read-only. The Client Doc boxes stay blank on this screen even when the document carries values, because the form never loads them; the listing’s Client Doc columns show what is stored. Nothing in this applet writes them, so they cannot be used for the consignor’s own return reference: put that in Reference.

Every import replaces the header. Each line you pull from the Search tab, and each document you knock off on KO For, overwrites the header with the source document’s: branch, location, company, consignor, Bill To and Ship To, Credit Terms, Permit No, Tracking ID, Reference, Remarks, currency, delivery branch and location, and the four Department Hdr dimensions. Only the transaction date and the purchaser you picked survive. A return built from two source documents takes its header from whichever was imported last. So pull the lines first, then type Reference and Remarks, and check the branch and consignor before CREATE.

Keep a consignment return in your company currency. As read from the code, not yet tried: the exchange-rate check at FINAL, and the conversion into your ledger currency, both need a base currency and a rate on the document, and this applet sends neither. A return in another currency therefore finalises without the check other purchase documents get, and its journal carries the document’s figures unconverted: returning goods worth USD 1,000 would book 1,000 in your ledger currency. A knock-off or invoice search from a foreign-currency purchase document copies that currency in. Before CREATE, whoever keys the return checks that Currency reads your company currency. If the goods came in on a foreign-currency receipt, they key each line at its value in your currency at the rate that receipt was posted at, so that the return clears exactly what the receipt booked. To confirm the behaviour on your own tenant, finalise one small return in a foreign currency and compare Trace Document → Journal Txn with the document total; VOID reverses it.

Account

Bill To and Ship To start with the consignor’s name, e-mail and phone and no address. The address boxes stay locked until you pick one of the consignor’s addresses with the picker, and choosing the consignor again wipes the address you picked, so choose the consignor first and the addresses last.

Lines

The Delivery switch on each row of the Lines grid is not connected to anything: it starts off on every line, and flipping it changes nothing and saves nothing. A line’s delivery need is recorded in the line’s own Delivery Details (Require Delivery and the delivery dates), which are saved with the line. Arranging the pick-up or dispatch back to the consignor is still a person’s job, done outside this document; this return only reverses the value.

Settlement, Contra, Department Hdr

Lifecycle and effects

There is no DISCARD in this applet.

On FINAL the server checks the forex rate (a check that never fires for this applet’s returns, see Main Details), bin quantities and the fiscal-period lock (serial / batch checks are skipped for this type; the stock-balance check does not apply to signum-0 lines), saves, assigns running numbers, and queues the primary processor, which writes the journal and the ARAP record.

Posting proof: server document type INTERNAL_PURCHASE_CONSIGNMENT_RETURN · amount signum +1 · quantity signum 0 (fixed by the server, whatever the applet sent) · journal posting: shared with the Consignment GRN — both consignment types post the same way · 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 takes no part in MA/WA costing · 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)