Customer Consignment Applet

Record stock you send to a customer’s premises but still own, and stock that comes back: a Transfer Out when stock leaves, a Transfer Receive when unsold stock returns, and a Transfer Queue of every line still out there, so the two documents stay linked. Both move quantity only and post no journal. Billing the customer for what they sold is an ordinary sales invoice, nothing links that invoice back to the Transfer Out, and the invoice line has to carry the consignment location or FINAL is refused for lack of stock at your own branch.

Overview

The Customer Consignment Applet records stock that you send to a customer’s premises but still own, and stock that comes back. Warehouse or store staff raise a Transfer Out when goods leave your location for the customer’s consignment location, and a Transfer Receive when unsold goods return. The Transfer Queue lists every Transfer Out line that has not yet been received back, and lets you create the Receive straight from it so the two documents stay linked. Both documents move quantity only: they carry no value and post no journal. Billing the customer for what they sold is an ordinary sales invoice — there is no consignment-specific customer bill on this platform, and nothing links the invoice back to the Transfer Out, so the quantity reconciliation is yours to do from the Transfer Queue. In particular it is not the Consignment Billing applet, whose name and folder suggest otherwise; see Related applets.

Where it fits

Screens and menus

Sidebar: Transfer Out, Transfer Queue, Transfer Receive. The applet opens on Transfer Out.

Transfer Out listing (Internal Outbound Customer Consignment Transfer Listing): columns Doc Short Code, Doc No (Tenant / Company / Branch), Posting Status, Tracking ID, Location From, Location To, Transaction Date; buttons + (create — needs the create permission, see below), SINGLE/MULTIPLE PRINT and FINAL for the ticked rows. The filter panel offers Location From, Location To, Created Date From/To and Txn Date From/To.

Transfer Out create: tabs Details, Line, KO For (sub-tabs GRN, CC-GRN, Stock Requisition). Transfer Out view: Details, Line, Doc Link, Attachments, Export (order configurable), with RESET, FINAL, SAVE in the header and EXPORT AS PDF / DELETE on the Export tab.

Transfer Queue (Internal Customer Consignment Queue Listing): every FINAL Transfer Out line with open (not yet received) quantity — columns Doc Short Code, Doc No, Posting Status, Tracking ID, Location From, Location To, Transaction Date. There is no create button: clicking a row opens a Transfer Receive pre-filled with the open lines and knock-off links, and a FINAL action posts the ticked Receives in bulk.

Transfer Receive listing (Internal Customer Consignment Transfer Receive Listing): same columns; + and FINAL (no bulk print). Custom status columns appear here when enabled. Transfer Receive create: Details, Line, KO For (sub-tab CC-GIN = open Transfer Out lines); the template also carries Account, Contra, Delivery Details, Department Hdr and Settlement tabs inherited from the stock-transfer template. Transfer Receive view: Main, Line Items, Status, Doc Link, Attachments, Export (order configurable).

Line item dialog (both documents): Item Details, Serial Number, Batch Number, Bin Number.

Settings (gear): System Configuration — Application Settings (shared screen), Default Selection, Outbound Printable Format, Receive Printable Format, Custom Status; Server Side Permissions — Permission Wizard, Permission Set, User Permission, Role Permission (Team Permission is routed but not listed); Developer Tools — Release Notes, Audit Trail. The settings area lands on Feature Visibility, which is routed but not in the menu. Personalization: Default Selection, Sidebar.

Configuration

Before you can use it

• A CCSG location per customer site. Create it in Consignee Stock Transfer › Consignee Listing (Location Class = CCSG) or in the location master. When Location From on a Transfer Out is not itself a CCSG location, the Location To dropdown shows CCSG locations only.
• Location access. The dropdowns list only the locations in the user’s …_LOCATION_TO_READ_TGT_GUID permission target; tenant admins and owners see every location.
• Permissions. Use Settings › Permission Wizard with the two seeded templates: CUSTOMER_CONSIGNMENT_COMMON (23 read permissions for companies, branches, locations, entities, items, serial numbers, tax codes, attachments, document links) and CUSTOMER_CONSIGNMENT_LOCATION (20 per-location permissions). The location template deliberately carries both the TNT_API_DOC_INTERNAL_CUSTOMER_CONSIGNMENT_{IN,OUT}_* permissions that the backend enforces and the TNT_API_DOC_INTERNAL_{INBOUND,OUTBOUND}_STOCK_TRANSFER_* permissions that the applet’s menus and + buttons check — a user needs both sets.
• Items must be basic items linked to an inventory item; serial-, batch- and bin-tracked items need their sub-items maintained in Item Maintenance.
• Printable formats. Upload a Jasper template under Outbound Printable Format and Receive Printable Format and tick Default Selection; bulk printing refuses to run without a default.
• Document numbers — the Tenant, Company and Branch Doc No fields — are generated by the backend per document type, company and location; nothing to configure in the applet.
• Fiscal periods. A locked fiscal period rejects FINAL for both documents (see Lifecycle).

Applet settings

Settings live in four places: the shared Application Settings screen, this applet’s own Default Selection and Custom Status screens, the printable-format screens (saved separately from the other settings), and Personalization › Default Selection (per user). Tenant admins and owners change them; users change only their personal default.

Only the keys below pass all four proofs (declared, rendered, saved, read). The shared screen also shows many HIDE_* toggles (for example HIDE_DOC_NO_TENANT) that this applet never reads — switching them has no effect here.

Settings used with no control in this applet: ENABLE_FILTER_BY_TODAYS_TXN (listings default to today from 06:00 instead of the last month), ENABLE_DRAFT_LOCK_SERIAL_NUMBER_CHECKING (serial-number draft-lock check when serials are added) and PRINTABLE (Export tab pre-selection). They can only be set through another applet that shares the same settings screen. DEFAULT_BRANCH is saved by the Default Selection and Personalization screens and used by nothing in this applet — no create form reads it. It works in other document applets, which is why it is offered here.

Document behaviour settings

• Posting status: DRAFT → FINAL, from the view header or in bulk from the listing (rows that are not DRAFT/ACTIVE are skipped with a “n/m selected documents cannot be finalized” snackbar). The applet exposes no VOID action; DELETE on the Export tab (click twice to confirm) calls the document delete endpoint.
• Stock validation on FINAL is a backend default, not a setting (see Lifecycle).
• Printables: Jasper templates per direction; Export tab exports one PDF, the Transfer Out listing prints several.
• No approval workflow, no e-Invoice submission, no custom line statuses.

Feature visibility / permissions

No client-side permissions are defined for this applet, yet the screens check four client-side permission codes. Because none is defined, they are all off for every user:

Server-side permissions are the two templates above (Settings › Permission Wizard); Permission Set, User, Team and Role screens are the shared assignment screens.

Fields

Transfer Out — Details

Transfer Receive — Details

Line (both documents)

Lifecycle and effects

Statuses: DRAFT on create; FINAL from the view or the listing; DELETE from the Export tab. VOID exists in the backend for these document types (it reverses the ledger lines) but has no button in this applet.

Posting proof

Server checks on FINAL (all hard rejections):

• Serial, bin and batch quantities must match the line quantity.
• Stock balance: checked from one of the two FINAL buttons, not both. The listing’s bulk FINAL goes through update-posting-status without the flag, and the server defaults it to check — every Transfer Out goods line of a basic item is checked against the stock at Location From; failure returns “Not Enough Stock for item …”. The Transfer Out view’s FINAL goes through update-auto-final and sends validateStockBalance = SHOW_ITEM_STOCK_BALANCE, and on that route the server defaults the flag to skip — so with the toggle off, or never saved, the view’s FINAL writes a Transfer Out that the stock at Location From cannot cover (a known issue, reported to engineering; the same code sits in the stock-transfer and consignee-stock-transfer applets, since UI ed81ca02 of 2025-11-02). The toggle therefore does two things: it adds the on-screen cap, and it is the only thing that switches the server check on for the view’s FINAL.
• Transaction date and company must be present, and Location From must be set.
• A locked fiscal period rejects FINAL. Unlike ordinary stock transfers, consignment transfers are not exempt.
• There is no check that Location From and Location To belong to the same company (open issue, see Troubleshooting).

Open lines and knock-off: when a Transfer Out is FINAL its lines are opened for a Transfer Receive; the Transfer Queue and the Receive’s CC-GIN tab list exactly those. Creating a Receive from the queue copies each open line with its open quantity and links the two, which takes that quantity off the Transfer Out; the Transfer Out’s own KO For tabs work the same way against Purchase GRN, Stock Requisition and a prior Receive (the CC-GRN tab).

Related applets

• Consignee Stock Transfer — creates the CCSG locations this applet transfers to, and offers a single-document issue/receive note without a queue.
• Stock Transfer — the template this applet was derived from; use it for movements between your own locations.
• Stock Requisition and Purchase GRN — documents a Transfer Out can knock off.
• Sales Invoice (Internal) — this is what bills the consignee. The platform has no consignment-specific customer invoice, so when the customer reports what they have used you raise an ordinary sales invoice for those units. Two consequences worth knowing before you key one. A sales invoice relieves stock at the line’s own branch and location, so the line has to carry the consignment location — invoice from your own branch while the goods are still out there and FINAL is refused with “Not Enough Stock for item …”, unless the tenant has turned that check off. And the invoice does not close the Transfer Out: the open queue pairs INTERNAL_CUSTOMER_CONSIGNMENT_OUT with INTERNAL_CUSTOMER_CONSIGNMENT_IN and nothing else, so the line stays in the Transfer Queue until a Transfer Receive knocks it off. Reconciling what was sold against what is still out there is yours to do.
• Consignment Billing Applet (Internal) — not this one, despite the name and the sales folder. It is a purchase document: server type INTERNAL_PURCHASE_CONSIGNMENT_INVOICE, amount signum −1, an entity picker titled Select Supplier, posting to the internal purchase-invoice route. It is the bill a consignor sends you when the roles are the other way round. Raise it here and you book a payable to a supplier where you meant a receivable from a customer.
• Consignor Purchase Billing Applet (Internal) and Consignment GRN Applet (Internal) — the supplier-side (you are the consignee) mirror of this process.
• Stock Balance and Stock Report — where the ledger lines at your location and at the CCSG location show up.
• Organisation — companies, branches and locations.
• Item Maintenance — items, serial numbers, batches and bins.

Troubleshooting

Related documentation

• Stock Management guide
• Inventory module
• POS module › related applets