Skip to content

Consignee Stock Transfer

Overview

The Consignee Stock Transfer applet moves stock that you still own between your own locations and consignee locations — a partner showroom, a customer site or a dealer’s shelf where your goods sit until they are sold or returned. Consignee locations are ordinary locations flagged with location class CCSG; a Consignment Goods Issued Note sends stock to one and a Consignment Goods Received Note brings it back.

Unlike the two-step Stock Transfer, each note is a single document: finalising it takes the quantity out of Location From and puts it into Location To in the same posting, so there is no in-transit queue. Both notes carry quantity only and post nothing to the General Ledger — the stock stays on your balance sheet at cost wherever it physically is.

Consignee Stock Transfer overview

Where it fits

DirectionApplet / documentWhy
UpstreamOrganisationCompanies and branches that a consignee location belongs to; the location itself is created in this applet’s Consignee Listing
UpstreamInventory Item Maintenance / Doc Item MaintenanceItems and their tracking type (serial, batch, bin)
DownstreamStock Balance, Stock Availability, Stock ReportBalance per location; the consignee location shows what is out on consignment
SiblingStock TransferTwo-step transfer with a queue, for movements between your own locations
SiblingCustomer ConsignmentConsignment sales and billing to the consignee, once goods are sold

Modules: Inventory.

Screens and menus

MenuPurpose
Consignee ListingCreate and maintain locations (including consignee locations of class CCSG)
Consignment Goods Issued NoteListing and create / edit of notes that send stock to a consignee location
Consignment Goods Received NoteListing and create / edit of notes that bring stock back from a consignee location

Gear (Settings) menu: Field Settings (Application Settings), Default Selection, Printable Format Settings, plus Webhook and the permission listings. Personalisation: per-user Field Settings and Default Selection.

Consignee Listing

Consignee listing and applet menu

A grid of locations with Location Class and Status columns. + opens Create Location with Details (Company Name, Branch Name, Location Code, Location Name, Description, Location Class — CCSG for a consignee, blank / BASIC otherwise — commencement and closed dates, phone, mobile, fax, email, outlet type and size, currency, status) and Address (address lines 1–5, city, postal code, state, country). Editing adds Branch, Extension and Labels tabs. These are the same bl_inv_mst_location records the rest of the system uses; only the CCSG class makes a location selectable as the consignee side of a note.

Consignment Goods Issued Note

Issued note listing actions

Listing columns: Doc No (Tenant / Company / Branch), Doc Short Code, Doc Description, Transaction Date, Location From, Location To, Ref #, Tracking ID, Status, Posting Status, created / updated by and date. Listing buttons act on the selected rows: FINAL (drafts), DISCARD (drafts), VOID (finals), PRINT (printable format).

Create document details tab

Details tab: Location From (any of your locations, defaulted from Default Selection), Location To (consignee locations only — class CCSG), Stock Transfer Good Issue Date, Doc No fields, Doc Description, Remarks, Reference #, Tracking ID. Line tab: + opens Create Line Item with Search Item, Item Details (Item Code, Item Name, Quantity) and, depending on the item’s sub-type, Serial Number, Batch Number or Bin Number. CREATE saves a new note as a draft; SAVE updates it.

Search item in create line item

Item details with tracking tabs

Consignment Goods Received Note

The mirror image: Location From is restricted to consignee locations (class CCSG), Location To is one of your locations. Same tabs, line editor and listing buttons (FINAL, DISCARD, VOID, PRINT).

Configuration

Before you can use it

PrerequisiteWhereWhy
Company and branchOrganisationA location must belong to a company and branch
At least one location with class CCSGConsignee Listing (this applet)Without one, the consignee dropdown is empty and no note can be created
Items with the right tracking typeInventory Item MaintenanceSerial / batch / bin tabs
Stock at Location FromSerial-tracked items must exist at the sending location
Printable format (optional)Settings > Printable Format SettingsFor PRINT and ENABLE_AUTO_POPUP
API permissions TNT_API_DOC_INTERNAL_CUSTOMER_CONSIGNMENT_OUT_*Applet permission assignmentBoth notes are posted through the customer-consignment-out endpoint

No GL codes, tax codes or cashbooks are needed.

Applet settings

Settings > Field Settings opens the shared field-configuration screen, which exposes only three keys for this applet:

SettingWhat it controlsDefaultEffect when changed
ENABLE_AUTO_POPUPOpen the print dialog automatically after FINALoffNeeds PRINTABLE (set under Printable Format Settings)
DISABLE_EXPORT_PRINT_ON_DRAFTDisable the PRINT button while any selected row is still DRAFToffOnly finalised notes can be printed
VERTICAL_ORIENTATIONAccordion (vertical) layout of the document tabsoffPresentation only

Settings > Default SelectionDEFAULT_BRANCH, DEFAULT_LOCATION pre-fill Location From; personal Default Selection overrides. Settings > Printable Format Settings — the printable format stored as PRINTABLE (also readable from the branch default printable format).

The listing buttons read HIDE_GENDOC_FINAL_BUTTON, HIDE_GENDOC_DISCARD_BUTTON and HIDE_GENDOC_VOID_BUTTON from the same settings record, but these keys are not on this applet’s settings screen; they can only be set through the platform settings editor. INCLUDE_* / ENABLE_* dimension, tax and custom-status keys are declared in the settings model and unused.

Document behaviour settings

SettingEffect
HIDE_GENDOC_FINAL_BUTTON / HIDE_GENDOC_DISCARD_BUTTON / HIDE_GENDOC_VOID_BUTTONRemove the listing action for everyone (no SHOW_* permissions are registered for this applet)
DISABLE_EXPORT_PRINT_ON_DRAFT, ENABLE_AUTO_POPUP, PRINTABLEPrinting

No approval workflow, no custom statuses in use, no e-Invoice.

Feature visibility / permissions

No client-side permissions are registered for consignee-stock-transfer in the applet registry; the listing code checks SHOW_GENDOC_FINAL_BUTTON, SHOW_GENDOC_DISCARD_BUTTON and SHOW_GENDOC_VOID_BUTTON but they are not seeded, so a HIDE_* setting hides the button for every role. Access is governed by the server-side document permissions (TNT_API_DOC_INTERNAL_CUSTOMER_CONSIGNMENT_OUT_CREATE / READ / UPDATE / DELETE) and location permissions.

Fields

Details

FieldMeaningRequiredNotes
Location From (locationSending, guid_store)Where stock leavesYesIssued note: your location; Received note: consignee (CCSG) location
Location To (locationReceiving, guid_store_2)Where stock arrivesYesIssued note: consignee (CCSG) location; Received note: your location
Stock Transfer Good Issue Date (stockTransferServiceDate)Transaction dateYes
Doc No (Tenant / Company / Branch), Doc Short CodeRunning numbersgenerated
Doc Description, Remarks, Reference #, Tracking IDFree textNo
Created / modified by and dateAudit

Line item

FieldMeaningRequiredNotes
Item Code / Item NameThe itemYesFrom Search Item
QuantityUnits movedYesAt least 1
Serial Number tabSerials movedFor serial itemsMust exist at Location From
Batch Number tabbatch_no, issue_date, expiry_date, quantityFor batch items
Bin Number tabbin_code, container_measure, container_qtyFor bin items

Location (Consignee Listing)

Required: Company, Branch, Location Code, Location Name, Location Commencement Date, Address Line 1, City, Postal Code, State, Country. Set Location Class to CCSG for a consignee location.

Lifecycle and posting

Status (posting_status)MeaningAllowed next
DRAFT (record status TEMP until first CREATE, then ACTIVE)EditableFINAL, DISCARDED
FINALPosted to stock; header and lines read-onlyVOID
VOIDReversed
DISCARDEDAbandoned draft

Both notes are posted as document type INTERNAL_CUSTOMER_CONSIGNMENT_OUT (quantity_signum −1, amount_signum 0). On FINAL the backend writes, for every line, one stock ledger line of −quantity at Location From and a cloned line (txn_code_02 = CSG) of +quantity at Location To, 0.1 s later, so the two locations always move together in one document. No journal is posted (the type is not in the journal-posting handler) and no cost changes: the receiving location takes the company’s moving-average / FIFO / LIFO cost.

NoteLocation FromLocation To
Goods Issued (your location → consignee)− quantity+ quantity at the CCSG location
Goods Received (consignee → your location)− quantity at the CCSG location+ quantity

VOID reverses both ledger lines. There is no knock-off between an issued and a received note; a partial return is simply a received note for the returned quantity, and the balance at the consignee location is the running difference.

Related applets

Troubleshooting

SymptomCauseFix
Location To (issued) or Location From (received) dropdown is emptyNo location has class CCSG, or the user lacks read permission on itSet Location Class = CCSG in Consignee Listing; grant the location permission
Location dropdown was empty after an updateFixed in 2025 — the dropdown now filters on ACTIVE statusUpdate the applet
CREATE is disabledLocation From, Location To or the date is missing, or there is no lineComplete Details and add a line
FINAL is disabled on the listingA selected row is not DRAFT + ACTIVESelect drafts only
VOID is disabledA selected row is not FINAL + ACTIVESelect finalised notes only
PRINT is disabledDISABLE_EXPORT_PRINT_ON_DRAFT on and a selected row is a draftFinalise first, or clear the setting
Serial rejected on an issued noteThe serial is not at Location FromTrace it in Stock Availability; transfer it there first
Consignee balance looks wrongA received note was created without a matching issue, or a note was voidedCompare FINAL issued and received quantities per item and consignee location in Stock Report > Stock Movement
Buttons missing for all usersHIDE_GENDOC_*_BUTTON set — no SHOW_* permission exists to reopen themClear the setting

Related documentation

Last updated on